Set-HCXMobilityGroup

This cmdlet modifies the HCX mobility group.

Syntax

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

Parameters

Required Parameter Name Type Position Features Description
required
AddMigration
SwitchParameter named Indicates that you can add the migrations to the HCX mobility group.
required
Migration
HCXMobilityGroupMigration[] named
  • pipeline
  • Specifies the array of a virtual machine and its configurations that are part of the HCX mobility group.
    required
    MobilityGroup
    HCXMobilityGroup named
  • pipeline
  • Specifies the HCX mobility group that you want to update.
    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.

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

    Parameters

    Required Parameter Name Type Position Features Description
    required
    Migration
    HCXMobilityGroupMigration[] named
  • pipeline
  • Specifies the array of a virtual machine and its configurations that are part of the HCX mobility group.
    required
    MobilityGroup
    HCXMobilityGroup named
  • pipeline
  • Specifies the HCX mobility group that you want to update.
    required
    RemoveMigration
    SwitchParameter named Indicates that you want to remove the migrations from an HCX 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.

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

    Parameters

    Required Parameter Name Type Position Features Description
    required
    MobilityGroup
    HCXMobilityGroup named
  • pipeline
  • Specifies the HCX mobility group that you want to update.
    required
    Name
    String named Specifies the name of an HCX 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.

    Output

    VMware.VimAutomation.Hcx.Types.V1.HCXMobilityGroup

    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.

    Related Commands

    Feedback

    Was this page helpful?