PowerCLI Reference



This cmdlet modifies the specified VM to VMHost DRS rule.


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

Related Commands

Online Version

Detailed Description

This cmdlet modifies the specified VM to VMHost DRS rule.


NameTypeDescriptionRequired?Pipeline InputDefault Value
RuleDrsVMHostRule[]Specifies the rules you want to modify.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
EnabledBooleanSpecifies whether to enable or disable the modified rule.falseFalse
NameStringSpecifies the new name for the modified 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 new type for the modified rule.falseFalse
VMGroupDrsClusterVMGroupSpecifies the VMGroup you want to use for the modified rule.falseFalse
VMHostGroupDrsClusterVMHostGroupSpecifies the VMHostGroup you want to use for the modified rule.falseFalse
WhatIfSwitchParameterIndicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falseFalse

Return Type

Zero or more modified DrsVMHostRule objects



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

Get-DRSVMHostRule "MyVMHostRule" | Set-DRSVMHostRule -Name "NewRuleName" -Enabled:$false

Renames and disables the "MyVMHostRule" VM to VMHost DRS rule.

Copyright © VMware, Inc. All rights reserved.