PowerCLI Reference

Set-HCXMigration

Synopsis

This cmdlet modifies the HCX migrations.

Syntax

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

Set-HCXMigration [-Migration] <HCXMigration> [-Confirm] -ScheduleEndTime <DateTime> -ScheduleStartTime <DateTime> [-Server <HcxServer[]>] [-WhatIf] [<CommonParameters>]

Set-HCXMigration [-Migration] <HCXMigration> [-Confirm] [-Server <HcxServer[]>] [-WhatIf] -RemoveSwitchOver [<CommonParameters>]

Related Commands

Detailed Description

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

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
MigrationHCXMigrationSpecifies the HCX migration that you want to update.trueTrue (ByValue)
AbortSwitchParameterIndicates that you can cancel the migration.trueFalse
ConfirmSwitchParameterIf the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.falseFalse
RemoveSwitchOverSwitchParameterSpecifies that you want to remove the schedule window for the migration.trueFalse
ScheduleEndTimeDateTimeSpecifies the end time of the schedule window.trueFalse
ScheduleStartTimeDateTimeSpecifies the start time of the schedule window.trueFalse
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
WhatIfSwitchParameterIndicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falseFalse

Return Type

VMware.VimAutomation.Hcx.Types.V1.HCXMigration

Notes

Examples

-------------------------- Example 1 --------------------------

PS C:\> 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 --------------------------

PS C:\> Set-HCXMigration -Abort -Migration $migration

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

-------------------------- Example 3 --------------------------

PS C:\> Set-HCXMigration -Migration $migration -RemoveSwitchOver

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


Copyright © VMware, Inc. All rights reserved.