< Back

Get-DrsClusterGroup

Sun Jan 19, 2020 6:49 pm

NAME Get-DrsClusterGroup



SYNOPSIS

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





SYNTAX

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

<DrsClusterGroupType>] [<CommonParameters>]



Get-DrsClusterGroup [[-Name] <String[]>] [[-VM] <VirtualMachine[]>] [-Server <VIServer[]>] [<CommonParameters>]



Get-DrsClusterGroup [[-Name] <String[]>] [[-VMHost] <VMHost[]>] [-Server <VIServer[]>] [<CommonParameters>]





DESCRIPTION

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





PARAMETERS

-Cluster <Cluster[]>

Specifies the clusters for which you want to retrieve the DRS cluster groups.



Required? false

Position? 2

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? true



-Name <String[]>

Specifies the names of the DRS cluster groups you want to retrieve.



Required? false

Position? 1

Default value None

Accept pipeline input? False

Accept wildcard characters? true



-Server <VIServer[]>

Specifies the vCenter Server systems on which you want to run the cmdlet. If no 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.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? true



-Type <DrsClusterGroupType>

Specifies the type of DRS cluster groups you want to retrieve. This parameter accepts VMGroup, VMHostGroup,

and All values.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-VM <VirtualMachine[]>

Specifies the virtual machines for which you want to retrieve DRS cluster groups.



Required? false

Position? 2

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? true



-VMHost <VMHost[]>

Specifies the VM hosts for which you want to retrieve DRS cluster groups.



Required? false

Position? 2

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? true



<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 DrsClusterGroup objects







NOTES









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

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

New-DrsClusterGroup

Remove-DrsClusterGroup

Set-DrsClusterGroup