powershellscripts.com

Tutorials  PowerShell Cmdlet Help for New-DrsRule



NAME
New-DrsRule

SYNOPSIS
Creates a new DRS rule.

SYNTAX
New-DrsRule [-Name] [-Cluster] [-Enabled []] -KeepTogether [] -VM chine[]> [-RunAsync] [-Server ] [-WhatIf] [-Confirm] []


DESCRIPTION
Creates a new DRS rule. Each rule defines the virtual machines that can run on the same host (affinity rule) or mus
t run on different hosts (anti-affinity rule).


PARAMETERS
-Name
Specify a name for the new DRS rule.

Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Cluster
Specify the clusters for which the new DRS rule applies.

Required? true
Position? 2
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? true

-Enabled []
If the value of this parameter is $true, the new DRS rule is enabled for the specified clusters. If the value i
s $false, it is disabled.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-KeepTogether []
If the value of this parameter is $true, the new DRS rule is an affinity rule. If the value is $false, the DRS
rule is an anti-affinity rule.

Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-VM
Specify the virtual machines that are referenced by the new DRS rule.

Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? true

-RunAsync
Indicate that the command returns immediately without waiting for the task to complete. In this mode, the outpu
t of the cmdlet is a Task object. For more information about the -RunAsync parameter run " help About_RunAsync"
in the vSphere PowerCLI console.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Server
Specify the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the co
mmand runs on the default servers. For more information about default servers, see the description of Connect-V
IServer.

Required? false
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? true

-WhatIf
Indicate that the cmdlet is run only to display the changes that would be made and actually no objects are modi
fied.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Confirm
If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false,
the cmdlet runs without asking for user confirmation.

Required? false
Position? named
Default value $true
Accept pipeline input? false
Accept wildcard characters? false


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS



OUTPUTS
DrsVMAffinityRule


NOTES




-------------- Example 1 --------------

C:\PS>New-DrsRule -Cluster $cluster -Name antiAffinityRule1 -KeepTogether $false -VM $antiAffinityVMs


Creates a new DRS rule for the cluster saved in the $cluster variable with the specified parameters.






RELATED LINKS
Online version: http://www.vmware.com/support/developer/PowerCLI/PowerCLI501/html/New-DrsRule.html
Get-DrsRule
Remove-DrsRule
Set-DrsRule