Syntax
Set-HCXMobilityGroup -AddMigration [-Confirm] -Migration <HCXMobilityGroupMigration[]> -MobilityGroup <HCXMobilityGroup> [-Server <HcxServer[]>] [-WhatIf] [<CommonParameters>]Related Commands
Detailed Description
This cmdlet modifies the HCX mobility group.Parameters
| Name | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| AddMigration | SwitchParameter | Indicates that you can add the migrations to the HCX mobility group. | true | False | |
| 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 | |
| Migration | HCXMobilityGroupMigration[] | Specifies the array of a virtual machine and its configurations that are part of the HCX mobility group. | true | True (ByValue) | |
| MobilityGroup | HCXMobilityGroup | Specifies the HCX mobility group that you want to update. | true | True (ByValue) | |
| Name | String | Specifies the name of an HCX mobility group. | true | False | |
| RemoveMigration | SwitchParameter | Indicates that you want to remove the migrations from 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. The cmdlet is not run. | false | False |
Return Type
VMware.VimAutomation.Hcx.Types.V1.HCXMobilityGroupNotes
Examples
-------------------------- Example 1 --------------------------
PS C:\> Set-HCXMobilityGroup -MobilityGroup $mobilityGroup -Migration $newHCXMobilityGroupMigration -AddMigration
Adds $newHCXMobilityMigration objects to the existing HCX mobility group.
-------------------------- Example 2 --------------------------
PS C:\> Set-HCXMobilityGroup -MobilityGroup $mobilityGroup -Migration $existingHCXMobilityGroupMigration -RemoveMigration
Removes $existingHCXMobilityGroupMigration objects from the existing HCX mobility group.
-------------------------- Example 3 --------------------------
PS C:\> Set-HCXMobilityGroup -MobilityGroup $mobilityGroup -Name $newHCXMobilityGroupName
Updates the name of the existing HCX mobility group to $newHCXMobilityGroupName.