PowerCLI Reference

Get-HCXMigration

Synopsis

This cmdlet retrieves the list of HCX migrations.

Syntax

Get-HCXMigration [-EntityId <String[]>] [-MigrationType {vMotion | Bulk | Cold}] [-NumberOfMigration <Int32>] [-Server <HcxServer[]>] [-State {MIGRATED | MIGRATE_CANCELED | MIGRATE_FAILED | MIGRATING}] [-Username <String[]>] [<CommonParameters>]

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

Related Commands

Detailed Description

This cmdlet retrieves the list of HCX migrations.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
EntityIdString[]Specifies the virtual machine ID for which you want to retrieve a list of the HCX migrations.falseFalse
IdString[]Specifies the ID of the migration that you want to retrieve.trueFalse
MigrationTypeMigrationTypeSpecifies the type of migration that you want to retrieve.falseFalse
NumberOfMigrationInt32Specifies the number of migrations that you want to retrieve.falseFalse
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
StateMigrationStateSpecifies the state of migrations that you want to retrieve.falseFalse
UsernameString[]Filters the retrieved list of migrations by the username of the user.falseFalse

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.


Copyright © VMware, Inc. All rights reserved.