Get-HCXMobilityGroup

Syntax

• ByName
• Default

Get-HCXMobilityGroup

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

---

Parameters

Required	Parameter Name	Type	Position	Features	Description
optional	Detailed	SwitchParameter	named		Indicates whether you can retrieve the full definition of a mobility group when using the Detailed parameter.
optional	Name	String[]	named		Retrieves group details for the given mobility group name.
optional	Server	HcxServer[]	named		Specifies the HCX 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 the Connect-HCXServer cmdlet.

Get-HCXMobilityGroup

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

---

Parameters

Required	Parameter Name	Type	Position	Features	Description
required	Id	String[]	named		Retrieves group details for the given mobility group ID.
optional	Detailed	SwitchParameter	named		Indicates whether you can retrieve the full definition of a mobility group when using the Detailed parameter.
optional	Server	HcxServer[]	named		Specifies the HCX 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 the Connect-HCXServer cmdlet.

Output

VMware.VimAutomation.Hcx.Types.V1.HCXMobilityGroup

Examples

---

Example 1

Get-HCXMobilityGroup

Retrieves list of all HCX Mobility Group.

Example 2

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

Get-HCXMobilityGroup -Id "myMobilityGroupId"

Retrieves a mobility group with the specified ID.

Related Commands