Syntax
Test-HCXMobilityGroup [-GroupConfiguration <HCXMobilityGroupConfiguration>] [-Migration <HCXMobilityGroupMigration[]>] -Name <String> [-Server <HcxServer[]>] [<CommonParameters>]Related Commands
Detailed Description
This cmdlet validates an HCX mobility group object.Parameters
| Name | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| GroupConfiguration | HCXMobilityGroupConfiguration | Specifies a common set of configurations that you can apply to all virtual machines in a group while doing the migration. | false | True (ByValue) | |
| Id | String | Specifies the ID of the mobility group which you can use to identify any group uniquely. | true | False | |
| Migration | HCXMobilityGroupMigration[] | Specifies the array of a virtual machine and its configurations that are part of the mobility group. | false | True (ByValue) | |
| MobilityGroup | HCXMobilityGroup | Specifies a full mobility group definition. | true | False | |
| Name | String | Specifies the name of the mobility group. | true | 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.HCXMobilityGroupNotes
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.