## PowerCLI Reference

# Set-DrsVMHostRule

## Synopsis

This cmdlet modifies the specified VM to VMHost DRS rule.

Syntax

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

Related Commands

Online version
Get-DrsVMHostRule
New-DrsVMHostRule
Remove-DrsVMHostRule

Detailed Description

This cmdlet modifies the specified VM to VMHost DRS rule.

Parameters

Name | Type | Description | Required? | Pipeline Input | Default Value
--- | --- | --- | --- | --- | ---
Rule | DrsVMHostRule[] | Specifies the rules you want to modify. | true | true (ByValue)
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. | false | false
Enabled | Boolean | Specifies whether to enable or disable the modified rule. | false | false
Name | String | Specifies the new name for the modified rule. | false | 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. | false | 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. | false | false
Type | DrsVMHostRuleType | Specifies the new type for the modified rule. | false | false
VMGroup | DrsClusterVMGroup | Specifies the VMGroup you want to use for the modified rule. | false | false
VMHostGroup | DrsClusterVMHostGroup | Specifies the VMHostGroup you want to use for the modified rule. | false | false
WhatIf | SwitchParameter | Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified. | false | false

Return Type

Zero or more modified DrsVMHostRule objects

Notes

Examples

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