Get-DrsClusterGroup Command | Vmware PowerCLI Reference

Get-DrsClusterGroup

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

Syntax

Get-DrsClusterGroup
[ [-Cluster ] < Cluster[] > ]
[-Name < String[] > ]
[-Server < VIServer[] > ]
[-Type < DrsClusterGroupType > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional Cluster Cluster[] 1
  • pipeline
  • wildcards
 Specifies the clusters for which you want to retrieve the DRS cluster groups.
optional Name String[] named
  • wildcards
 Specifies the names of the DRS cluster groups you want to retrieve.
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 DrsClusterGroupType named
Specifies the type of DRS cluster groups you want to retrieve. This parameter accepts VMGroup, VMHostGroup, and All values.
Get-DrsClusterGroup
[ [-VM ] < VirtualMachine[] > ]
[-Name < String[] > ]
[-Server < VIServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional VM VirtualMachine[] 1
  • pipeline
  • wildcards
 Specifies the virtual machines for which you want to retrieve DRS cluster groups.
optional Name String[] named
  • wildcards
 Specifies the names of the DRS cluster groups you want to retrieve.
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.
Get-DrsClusterGroup
[ [-VMHost ] < VMHost[] > ]
[-Name < String[] > ]
[-Server < VIServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional VMHost VMHost[] 1
  • pipeline
  • wildcards
 Specifies the VM hosts for which you want to retrieve DRS cluster groups.
optional Name String[] named
  • wildcards
 Specifies the names of the DRS cluster groups you want to retrieve.
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.

Output

VMware.VimAutomation.ViCore.Types.V1.Cluster.DrsRule

Examples

Example 1 

Get-DrsClusterGroup -VM $vm1, $vm2

Retrieves the corresponding DRS cluster groups associated with any of the virtual machines from the specified list.

Example 2 

Get-DrsClusterGroup -Cluster $cluster -Type VMHostGroup

Retrieves all VM host groups within the specified 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.