Set-DrsRule

NAME Set-DrsRule



SYNOPSIS

This cmdlet modifies an existing DRS rule.





SYNTAX

Set-DrsRule [[-Enabled] <Boolean>] [-Rule] <DrsRule[]> [-Name <String>] [-RunAsync] [-Server <VIServer[]>] [-VM

<VirtualMachine[]>] [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

This cmdlet 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

-Enabled <Boolean>

Indicates that the DRS rule is enabled.



Required? false

Position? 1

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Name <String>

Specifies a new name for the DRS rule.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Rule <DrsRule[]>

Specifies the DRS rule you want to modify.



Required? true

Position? 2

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? 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.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-Server <VIServer[]>

Specifies the vCenter Server systems 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.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? true



-VM <VirtualMachine[]>

Specifies the virtual machines that can be referenced by the new DRS rule.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? true



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



Required? false

Position? named

Default value $true

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are

modified.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

Zero or more modified DrsVMAffinityRule objects







NOTES









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



RELATED LINKS

Online Version: https://code.vmware.com/doc/preview?id= ... sRule.html

Get-DrsRule

New-DrsRule

Remove-DrsRule