Syntax
Get-HCXMigration [-EntityId <String[]>] [-MigrationType {vMotion | Bulk | Cold}] [-NumberOfMigration <Int32>] [-Server <HcxServer[]>] [-State {MIGRATED | MIGRATE_CANCELED | MIGRATE_FAILED | MIGRATING}] [-Username <String[]>] [<CommonParameters>]Related Commands
Detailed Description
This cmdlet retrieves the list of HCX migrations.Parameters
| Name | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| EntityId | String[] | Specifies the virtual machine ID for which you want to retrieve a list of the HCX migrations. | false | False | |
| Id | String[] | Specifies the ID of the migration that you want to retrieve. | true | False | |
| MigrationType | MigrationType | Specifies the type of migration that you want to retrieve. | false | False | |
| NumberOfMigration | Int32 | Specifies the number of migrations that you want to retrieve. | false | 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 | |
| State | MigrationState | Specifies the state of migrations that you want to retrieve. | false | False | |
| Username | String[] | Filters the retrieved list of migrations by the username of the user. | false | False |
Return Type
VMware.VimAutomation.Hcx.Types.V1.HCXMigration[]Notes
Examples
-------------------------- Example 1 --------------------------
PS C:\> 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.