< Back
New-DrsRule
Post
NAME New-DrsRule
SYNOPSIS
This cmdlet creates a new DRS rule.
SYNTAX
New-DrsRule [-Name] <String> [-Cluster] <Cluster> [-Enabled <Boolean>] -KeepTogether <Boolean> [-RunAsync]
[-Server <VIServer[]>] -VM <VirtualMachine[]> [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
This cmdlet creates a new DRS rule. Each rule defines the virtual machines that can run on the same host (affinity
rule) or must run on different hosts (anti-affinity rule).
PARAMETERS
-Cluster <Cluster>
Specifies the cluster for which the new DRS rule applies. Passing multiple values to this parameter is
obsolete.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-Enabled <Boolean>
If the value of this parameter is $true, the new DRS rule is enabled for the specified clusters. If the value
is $false, it is disabled.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-KeepTogether <Boolean>
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 None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies a name for the new DRS rule.
Required? true
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-RunAsync [<SwitchParameter>]
Indicates that the command returns immediately without waiting for the task to complete. In this mode, the
output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help
About_RunAsync" in the VMware PowerCLI console.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Server <VIServer[]>
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is passed to this
parameter, the command runs on the default servers. For more information about default servers, see the
description of Connect-VIServer.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-VM <VirtualMachine[]>
Specifies the virtual machines that are referenced by the new DRS rule.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-Confirm [<SwitchParameter>]
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
-WhatIf [<SwitchParameter>]
Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are
modified.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
The newly created DrsVMAffinityRule object
NOTES
-------------------------- Example 1 --------------------------
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: https://code.vmware.com/doc/preview?id= ... sRule.html
Get-DrsRule
Remove-DrsRule
Set-DrsRule
SYNOPSIS
This cmdlet creates a new DRS rule.
SYNTAX
New-DrsRule [-Name] <String> [-Cluster] <Cluster> [-Enabled <Boolean>] -KeepTogether <Boolean> [-RunAsync]
[-Server <VIServer[]>] -VM <VirtualMachine[]> [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
This cmdlet creates a new DRS rule. Each rule defines the virtual machines that can run on the same host (affinity
rule) or must run on different hosts (anti-affinity rule).
PARAMETERS
-Cluster <Cluster>
Specifies the cluster for which the new DRS rule applies. Passing multiple values to this parameter is
obsolete.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-Enabled <Boolean>
If the value of this parameter is $true, the new DRS rule is enabled for the specified clusters. If the value
is $false, it is disabled.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-KeepTogether <Boolean>
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 None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies a name for the new DRS rule.
Required? true
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-RunAsync [<SwitchParameter>]
Indicates that the command returns immediately without waiting for the task to complete. In this mode, the
output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help
About_RunAsync" in the VMware PowerCLI console.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Server <VIServer[]>
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is passed to this
parameter, the command runs on the default servers. For more information about default servers, see the
description of Connect-VIServer.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-VM <VirtualMachine[]>
Specifies the virtual machines that are referenced by the new DRS rule.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-Confirm [<SwitchParameter>]
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
-WhatIf [<SwitchParameter>]
Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are
modified.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
The newly created DrsVMAffinityRule object
NOTES
-------------------------- Example 1 --------------------------
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: https://code.vmware.com/doc/preview?id= ... sRule.html
Get-DrsRule
Remove-DrsRule
Set-DrsRule