PowerCLI Reference



This cmdlet creates a new DRS rule.


New-DrsRule [-Name] <String> [-Cluster] <Cluster> [-Enabled <Boolean>] -KeepTogether <Boolean> [-RunAsync] [-Server <VIServer[]>] -VM <VirtualMachine[]> [-Confirm] [-WhatIf] [<CommonParameters>]

Related Commands

Online Version

Detailed 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).


NameTypeDescriptionRequired?Pipeline InputDefault Value
NameStringSpecifies a name for the new DRS rule.trueFalse
ClusterClusterSpecifies the cluster for which the new DRS rule applies. Passing multiple values to this parameter is obsolete.trueTrue (ByValue)
ConfirmSwitchParameterIf 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.falseFalse
EnabledBooleanIf 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.falseFalse
KeepTogetherBooleanIf 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.trueFalse
RunAsyncSwitchParameterIndicates 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.falseFalse
ServerVIServer[]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.falseTrue (ByValue)
VMVirtualMachine[]Specifies the virtual machines that are referenced by the new DRS rule.trueFalse
WhatIfSwitchParameterIndicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falseFalse

Return Type

The newly created DrsVMAffinityRule object



-------------------------- 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.

Copyright © VMware, Inc. All rights reserved.