Get-HCXMigration Command | Vmware PowerCLI Reference

Get-HCXMigration

This cmdlet retrieves the list of HCX migrations.

Syntax

Get-HCXMigration
-Id < String[] >
[-Server < HcxServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
Id String[] named
Specifies the ID of the migration that you want to retrieve.
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.
Get-HCXMigration
[-EntityId < String[] > ]
[-MigrationType < MigrationType > ]
[-NumberOfMigration < Int32 > ]
[-Server < HcxServer[] > ]
[-State < MigrationState > ]
[-Username < String[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional EntityId String[] named
Specifies the virtual machine ID for which you want to retrieve a list of the HCX migrations.
optional MigrationType MigrationType named
Specifies the type of migration that you want to retrieve.
optional NumberOfMigration Int32 named
Specifies the number of migrations that you want to retrieve.
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.
optional State MigrationState named
Specifies the state of migrations that you want to retrieve.
optional Username String[] named
Filters the retrieved list of migrations by the username of the user.

Output

VMware.VimAutomation.Hcx.Types.V1.HCXMigration

Examples

Example 1

Get-HCXMigration -NumberOfMigration 10 -Username abc -State MIGRATE_FAILED
 -MigrationType Bulk -EntityId vm-101

Retrieves 10 HCX migrations where username is abc, state is failed, migration type is bulk, and entityId is vm-101.

Related Commands

HCXMigration

This cmdlet retrieves the list of HCX migrations.

This cmdlet creates an HCX migration request.

This cmdlet modifies the HCX migrations.

This cmdlet starts the HCX migrations.

This cmdlet validates an HCX migration request.