Set-DrsVMHostRule Command | Vmware PowerCLI Reference

Set-DrsVMHostRule

This cmdlet modifies the specified VM to VMHost DRS rule.

Syntax

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

Parameters

Required Parameter Name Type Position Features Description
required
 Rule DrsVMHostRule[] named
  • pipeline
  • wildcards
 Specifies the rules you want to modify.
optional Enabled Boolean named
Specifies whether to activate or deactivate the modified rule.
optional Name String named
Specifies the new name for the modified rule.
optional ProgressAction ActionPreference named
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 Type DrsVMHostRuleType named
Specifies the new type for the modified rule.
optional VMGroup DrsClusterVMGroup named
  • wildcards
 Specifies the VMGroup you want to use for the modified rule.
optional VMHostGroup DrsClusterVMHostGroup named
  • wildcards
 Specifies the VMHostGroup you want to use for the modified rule.

Output

VMware.VimAutomation.ViCore.Types.V1.Cluster.DrsVMHostRule

Examples

Example 1 

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

Renames and deactivates the "MyVMHostRule" VM to VMHost DRS 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.