Test-HCXMobilityGroup

This cmdlet validates an HCX mobility group object.

Syntax

-Name  <String>
[-GroupConfiguration  <HCXMobilityGroupConfiguration>]
[-Migration  <HCXMobilityGroupMigration[]>]
[-Server  <HcxServer[]>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
Name
String named Specifies the name of the mobility group.
optional
GroupConfiguration
HCXMobilityGroupConfiguration named
  • pipeline
  • Specifies a common set of configurations that you can apply to all virtual machines in a group while doing the migration.
    optional
    Migration
    HCXMobilityGroupMigration[] named
  • pipeline
  • Specifies the array of a virtual machine and its configurations that are part of the mobility group.
    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.

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

    Parameters

    Required Parameter Name Type Position Features Description
    required
    Id
    String named Specifies the ID of the mobility group which you can use to identify any group uniquely.
    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.

    -MobilityGroup  <HCXMobilityGroup>
    [-Server  <HcxServer[]>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    MobilityGroup
    HCXMobilityGroup named Specifies a full mobility group definition.
    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

    PS C:\> Test-HCXMobilityGroup -Name "mobilityGroupName"

    Validates the mobility group configurations for a given mobility group name. You must create the mobility group before validating with the Name parameter.

    Example 2

    PS C:\> Test-HCXMobilityGroup -MobilityGroup $mobilityGroup

    Validates the specified mobility group configurations.

    Example 3

    PS C:\> Test-HCXMobilityGroup -Id "mobilityGroupId"

    Validates the mobility group configurations for the given mobility group ID. You must create the mobility group before validating with the Id parameter.

    Related Commands

    Feedback

    Was this page helpful?