vSphere PowerCLI Reference

Set-DrsRule

Synopsis

Modifies an existing DRS rule.

Syntax

Set-DrsRule [[-Enabled] [<Boolean>]] [-Rule] <DrsVMAffinityRule[]> [-Name <String>] [-VM <VirtualMachine[]>] [-RunAsync] [-Server <VIServer[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version
Get-DrsRule
New-DrsRule
Remove-DrsRule

Detailed Description

Modifies an existing 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

Name	Type	Description	Required?	Pipeline Input	Default Value
Enabled	Boolean	Indicate that the DRS rule is enabled.	false	false
Rule	DrsVMAffinityRule[]	Specifies the DRS rule 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	$true
Name	String	Specify a new name for the DRS rule.	false	false
RunAsync	SwitchParameter	Indicate 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 vSphere PowerCLI console.	false	false
Server	VIServer[]	Specify the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.	false	false
VM	VirtualMachine[]	Specify the virtual machines that can be referenced by the new DRS rule.	false	false
WhatIf	SwitchParameter	Indicate that the cmdlet is run only to display the changes that would be made and actually no objects are modified.	false	false

Return Type

DrsVMAffinityRule

Notes

Examples

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

$vm = Get-VM DrsRuleVM1*

Set-DrsRule -Rule $affinityRule -VM $vm -Enabled $true;

Updates the list of virtual machines that might be referenced by the DRS rule stored in the $affinityRule variable and enables the rule.