Get-DrsVMHostRule Command | Vmware PowerCLI Reference

Get-DrsVMHostRule

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

Syntax

Get-DrsVMHostRule
[ [-Cluster ] < Cluster[] > ]
[-Name < String[] > ]
[-ProgressAction < ActionPreference > ]
[-Server < VIServer[] > ]
[-Type < DrsVMHostRuleType[] > ]
[-VMGroup < DrsClusterVMGroup[] > ]
[-VMHostGroup < DrsClusterVMHostGroup[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional Cluster Cluster[] 1
  • pipeline
  • wildcards
 Specifies the DRS clusters from which you want to retrieve rules.
optional Name String[] named
  • wildcards
 Specifies the names of the DRS rules you want to retrieve.
optional ProgressAction ActionPreference named
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 types of DRS rules you want to retrieve. This parameter accepts MustRunOn, ShouldRunOn, MustNotRunOn, and ShouldNotRunOn values.
optional VMGroup DrsClusterVMGroup[] named
  • pipeline
  • wildcards
 Filters rules by VM group.
optional VMHostGroup DrsClusterVMHostGroup[] named
  • pipeline
  • wildcards
 Filters rules by VMHost group.

Output

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

Examples

Example 1 

Get-DrsVMHostRule -Type "MustRunOn"

Retrieves all VM to VMHost DRS rules, which are of type "MustRunOn".

Example 2 

$cluster = Get-Cluster "MyCluster"
Get-DrsVMHostRule -VMHostGroup "MyDrsVMHostGroup" -Cluster $cluster

Retrieves all available VM to VMHost DRS which include the "MyDrsVMHostGroup" DRS VMHost group in the "MyCluster" cluster.

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.