HCXMobility Category | Vmware PowerCLI Reference

HCX Mobility Category

Cmdlets are usually implemented around resource operations. The four basic operations are CREATE, READ, UPDATE and DELETE. This set of operations is known as CRUD. Most of the cmdlets support CRUD which are respectively cmdlets that start with the New/Get/Set/Remove cmdlet verbs but they also may have additional operations

Step 1: Retrieve a object by running a Get command

You can READ objects by using Get-HCXMobilityGroup cmdlet. See example below:

# Retrieves list of all HCX Mobility Group.

Get-HCXMobilityGroup

Step 2 : Run commands from the CRUD group

You can CREATE objects by using New-HCXMobilityGroup cmdlet. See example below:

# Creates a new mobility group request object with default mobility group configurations and a list of HCX migration objects.

New-HCXMobilityGroup -Name "MyFirstMobilityGroup" -GroupConfiguration $mobilityGroupConfigiuration -Migration $migrations
You can UPDATE objects by using Set-HCXMobilityGroup cmdlet. See example below:

# Adds $newHCXMobilityMigration objects to the existing HCX mobility group.

Set-HCXMobilityGroup -MobilityGroup $mobilityGroup -Migration $newHCXMobilityGroupMigration -AddMigration

Step 3: Explore More Related Commands:


New-HCXMobilityGroupConfiguration This cmdlet creates an HCX mobility group configuration request.
Set-HCXMobilityGroupConfiguration This cmdlet updates the HCX mobility group configurations.
Start-HCXMobilityGroupMigration This cmdlet starts the HCX Mobility Group migrations.
Stop-HCXMobilityGroupMigration This cmdlet stops the migration of all virtual machines in the mobility group.
Test-HCXMobilityGroup This cmdlet validates an HCX mobility group object.