Set-DrsRule Command | Vmware PowerCLI Reference

Set-DrsRule

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

Syntax

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

Parameters

Required Parameter Name Type Position Features Description
required
 Rule DrsRule[] 1
  • pipeline
 Specifies the DRS rule you want to modify.
optional Enabled Boolean named
Indicates that the DRS rule is enabled.
optional Name String named
Specifies a new name for the DRS rule.
optional RunAsync SwitchParameter named
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.
optional Server VIServer[] named
  • wildcards
 Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null 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.
optional VM VirtualMachine[] named
  • wildcards
 Specifies the virtual machines that can be referenced by the new DRS rule.

Output

VMware.VimAutomation.ViCore.Types.V1.Cluster.DrsVMAffinityRule

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.

Related Commands

DrsClusterGroup

This cmdlet retrieves DRS cluster groups for the specified cluster, VM, or VM host.

This cmdlet creates either a VM or VM host DRS cluster group, depending on the used parameter set.

This cmdlet removes the specified DRS cluster groups from the cluster on which it resides.

This cmdlet adds or removes either virtual machines or VM hosts to or from the specified DRS cluster group, depending on the used parameter set.

DrsRecommendation

This cmdlet retrieves the available DRS recommendations from the provided clusters.

This cmdlet applies the specified DRS recommendations.

DrsRule

This cmdlet retrieves the list of DRS rules for the specified clusters.

This cmdlet creates a new DRS rule.

This cmdlet removes the specified DRS rules.

This cmdlet modifies an existing DRS rule.

DrsVMHostRule

This cmdlet retrieves VM to VMHost DRS rules that match the specified filters.

This cmdlet creates a new VM to VMHost DRS rule.

This cmdlet removes the specified VM to VMHost DRS rule.

This cmdlet modifies the specified VM to VMHost DRS rule.