Set-HCXMigration Command | Vmware PowerCLI Reference

Set-HCXMigration

This cmdlet modifies the HCX migrations. You can use the cmdlet to either abort a migration or change the schedule for a bulk migration.

Syntax

Set-HCXMigration
-Abort
-Migration < HCXMigration >
[-Server < HcxServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
Abort SwitchParameter named
Indicates that you can cancel the migration.
required
Migration HCXMigration named
  • pipeline
Specifies the HCX migration 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.
Set-HCXMigration
-Migration < HCXMigration >
-ScheduleEndTime < DateTime >
-ScheduleStartTime < DateTime >
[-Server < HcxServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
Migration HCXMigration named
  • pipeline
Specifies the HCX migration that you want to update.
required
ScheduleEndTime DateTime named
Specifies the end time of the schedule window.
required
ScheduleStartTime DateTime named
Specifies the start time of the schedule window.
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.
Set-HCXMigration
-MobilityGroupMigration < HCXMobilityGroupMigration >
[-DiskProvisionType < DiskProvisionType > ]
[-Folder < HCXFolderContainer > ]
[-ForcePowerOffVm < Boolean > ]
[-MigrationType < MigrationType > ]
[-NetworkMapping < HCXNetworkMapping[] > ]
[-RemoveISOs < Boolean > ]
[-RemoveSnapshots < Boolean > ]
[-RetainMac < Boolean > ]
[-ScheduleEndTime < DateTime > ]
[-ScheduleStartTime < DateTime > ]
[-Server < HcxServer[] > ]
[-TargetComputeContainer < HCXComputeContainer > ]
[-TargetDatastore < HCXDatastore > ]
[-TargetStorageProfile < HCXStorageProfile > ]
[-UpgradeHardware < Boolean > ]
[-UpgradeVMTools < Boolean > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
MobilityGroupMigration HCXMobilityGroupMigration named
optional DiskProvisionType DiskProvisionType named
optional Folder HCXFolderContainer named
optional ForcePowerOffVm Boolean named
optional MigrationType MigrationType named
optional NetworkMapping HCXNetworkMapping[] named
optional RemoveISOs Boolean named
optional RemoveSnapshots Boolean named
optional RetainMac Boolean named
optional ScheduleEndTime DateTime named
Specifies the end time of the schedule window.
optional ScheduleStartTime DateTime named
Specifies the start time of the schedule window.
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 TargetComputeContainer HCXComputeContainer named
optional TargetDatastore HCXDatastore named
optional TargetStorageProfile HCXStorageProfile named
optional UpgradeHardware Boolean named
optional UpgradeVMTools Boolean named
Set-HCXMigration
-Migration < HCXMigration >
-RemoveSwitchOver
[-Server < HcxServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
Migration HCXMigration named
  • pipeline
Specifies the HCX migration that you want to update.
required
RemoveSwitchOver SwitchParameter named
Specifies that you want to remove the schedule window for the migration.
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.HCXMigration

Examples

Example 1

Set-HCXMigration -ScheduleStartTime '01/18/2019 3:57 PM' -ScheduleEndTime '01/18/2019 4:57 PM' -Migration $migration

Modifies the schedule start time and schedule end time for the given migration. You can use the cmdlet in case of bulk migration.

Example 2

Set-HCXMigration -Abort -Migration $migration

Aborts the given migration and you can use it in case of bulk migration.

Example 3

Set-HCXMigration -Migration $migration -RemoveSwitchOver

Removes the schedule window and you can use it in case of bulk migration.

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.