PowerCLI Reference

Get-HCXMobilityGroup

Synopsis

This cmdlet retrieves a list of HCX mobility groups.

Syntax

Get-HCXMobilityGroup [-Detailed] -Id <String[]> [-Server <HcxServer[]>] [<CommonParameters>]

Get-HCXMobilityGroup [-Detailed] [-Name <String[]>] [-Server <HcxServer[]>] [<CommonParameters>]

Related Commands

Detailed Description

This cmdlet retrieves a list of HCX mobility groups.

Parameters

Name	Type	Description	Required?	Pipeline Input
Detailed	SwitchParameter	Indicates whether you can retrieve the full definition of a mobility group when using the Detailed parameter.	false	False
Id	String[]	Retrieves group details for the given mobility group ID.	true	False
Name	String[]	Retrieves group details for the given mobility group name.	false	False
Server	HcxServer[]	Specifies the HCX Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-HCXServer cmdlet.	false	False

Return Type

VMware.VimAutomation.Hcx.Types.V1.HCXMobilityGroup

Notes

Examples

-------------------------- Example 1 --------------------------

PS C:\> Get-HCXMobilityGroup

Retrieves list of all HCX Mobility Group.

-------------------------- Example 2 --------------------------

PS C:\> Get-HCXMobilityGroup -Name "myMobilityGroup" -Detailed

Retrieves a mobility group with the "myMobilityGroup" name. By adding the Detailed parameter, you can retrieve all migrations and configurations.

-------------------------- Example 3 --------------------------

PS C:\> Get-HCXMobilityGroup -Id "myMobilityGroupId"

Retrieves a mobility group with the specified ID.