Syntax
New-HCXMobilityGroup [-Confirm] [-GroupConfiguration <HCXMobilityGroupConfiguration>] [-Migration <HCXMobilityGroupMigration[]>] -Name <String> [-Server <HcxServer[]>] [-WhatIf] [<CommonParameters>]Related Commands
Detailed Description
This cmdlet creates an HCX mobility group request.Parameters
| Name | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Confirm | SwitchParameter | If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation. | false | False | |
| GroupConfiguration | HCXMobilityGroupConfiguration | Specifies the common set of configurations that you want to apply to all virtual machines in a group while doing the migration. If not specified explicitly at Virtual Machine Configuration. | false | False | |
| Migration | HCXMobilityGroupMigration[] | Specifies the array of a virtual machine and its configurations that are part of the HCX mobility group. | false | False | |
| Name | String | Specifies the name of an HCX 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 | |
| WhatIf | SwitchParameter | Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified. | false | False |
Return Type
VMware.VimAutomation.Hcx.Types.V1.HCXMobilityGroupNotes
Examples
-------------------------- Example 1 --------------------------
PS C:\> New-HCXMobilityGroup -Name "MyFirstMobilityGroup" -GroupConfiguration $mobilityGroupConfigiuration -Migration $migrations
Creates a new mobility group request object with default mobility group configurations and a list of HCX migration objects.
-------------------------- Example 2 --------------------------
PS C:\> New-HCXMobilityGroup -Name "MyFirstMobilityGroup" -Migration $migrations
Creates a new mobility group request object with an out-default group configuration.