PowerCLI Reference



This cmdlet creates a new VM to VMHost DRS rule.


New-DrsVMHostRule [-Name] <String> [-Cluster <Cluster>] [-Enabled <Boolean>] [-RunAsync] [-Server <VIServer[]>] -Type <DrsVMHostRuleType> -VMGroup <DrsClusterVMGroup> -VMHostGroup <DrsClusterVMHostGroup> [-Confirm] [-WhatIf] [<CommonParameters>]

Related Commands

Online Version

Detailed Description

This cmdlet creates a new VM to VMHost DRS rule.


NameTypeDescriptionRequired?Pipeline InputDefault Value
NameStringSpecifies the name for the new rule.trueFalse
ClusterClusterSpecifies the clusters on which you want to create the new rule.falseFalse
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
EnabledBooleanSpecifies whether to enable the new rule.falseFalse
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.falseFalse
TypeDrsVMHostRuleTypeSpecifies the type of the rule you want to create. This parameter accepts MustRunOn, ShouldRunOn, MustNotRunOn, and ShouldNotRunOn values.trueFalse
VMGroupDrsClusterVMGroupSpecifies the VMGroup you want to use for the new rule.trueFalse
VMHostGroupDrsClusterVMHostGroupSpecifies the VMHostGroup you want to use for the new 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 DrsVMHostRule object



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

New-DrsVMHostRule -Name "MyDrsRule" -Cluster "MyCluster" -VMGroup "MyVMGroup" -VMHostGroup "MyVMHostGroup" -Type "MustRunOn"

Creates a new VM to VMHost DRS rule within the "MyCluster" cluster.

Copyright © VMware, Inc. All rights reserved.