PowerCLI Reference



This cmdlet modifies the HCX mobility group.


Set-HCXMobilityGroup -AddMigration [-Confirm] -Migration <HCXMobilityGroupMigration[]> -MobilityGroup <HCXMobilityGroup> [-Server <HcxServer[]>] [-WhatIf] [<CommonParameters>]

Set-HCXMobilityGroup [-Confirm] -Migration <HCXMobilityGroupMigration[]> -MobilityGroup <HCXMobilityGroup> -RemoveMigration [-Server <HcxServer[]>] [-WhatIf] [<CommonParameters>]

Set-HCXMobilityGroup [-Confirm] -MobilityGroup <HCXMobilityGroup> -Name <String> [-Server <HcxServer[]>] [-WhatIf] [<CommonParameters>]

Related Commands

Detailed Description

This cmdlet modifies the HCX mobility group.


NameTypeDescriptionRequired?Pipeline InputDefault Value
AddMigrationSwitchParameterIndicates that you can add the migrations to the HCX mobility group.trueFalse
ConfirmSwitchParameterIf 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.falseFalse
MigrationHCXMobilityGroupMigration[]Specifies the array of a virtual machine and its configurations that are part of the HCX mobility group.trueTrue (ByValue)
MobilityGroupHCXMobilityGroupSpecifies the HCX mobility group that you want to update.trueTrue (ByValue)
NameStringSpecifies the name of an HCX mobility group.trueFalse
RemoveMigrationSwitchParameterIndicates that you want to remove the migrations from an HCX mobility group.trueFalse
ServerHcxServer[]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.falseFalse
WhatIfSwitchParameterIndicates 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.falseFalse

Return Type




-------------------------- 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.

Copyright © VMware, Inc. All rights reserved.