PowerCLI Reference

Set-HCXMobilityGroupConfiguration

Synopsis

This cmdlet updates the HCX mobility group configurations.

Syntax

Set-HCXMobilityGroupConfiguration [-Confirm] [-DiskProvisionType {SameAsSource | Thick | Thin}] [-ForcePowerOffVm <Boolean>] [-MigrationType {vMotion | Bulk | Cold | RAV | OsAssistedMigration}] -MobilityGroup <HCXMobilityGroup> [-NetworkMapping <HCXNetworkMapping[]>] [-RemoveISOs <Boolean>] [-RemoveSnapshots <Boolean>] [-RetainMac <Boolean>] [-ScheduleEndTime <DateTime>] [-ScheduleStartTime <DateTime>] [-Server <HcxServer[]>] [-TargetComputeContainer <HCXComputeContainer>] [-TargetComputeFolder <HCXFolderContainer>] [-TargetDatastore <HCXDatastore>] [-TargetStorageProfile <HCXStorageProfile>] [-UpgradeHardware <Boolean>] [-UpgradeVMTools <Boolean>] [-WhatIf] [<CommonParameters>]

Related Commands

Detailed Description

This cmdlet updates the HCX mobility group configurations.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
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
DiskProvisionTypeDiskProvisionTypeSpecifies the type of the disk provisioning that you want to use.falseFalse
ForcePowerOffVmBooleanSpecifies whether you want the virtual machine to be in a powered off state after the migration.falseFalse
MigrationTypeMigrationTypeSpecifies the type of migration that you want to perform.falseFalse
MobilityGroupHCXMobilityGroupSpecifies the mobility group where you want to perform an update operation.trueTrue (ByValue)
NetworkMappingHCXNetworkMapping[]Specifies the source and destination networks you want to use.falseFalse
RemoveISOsBooleanSpecifies whether you want to remove the ISO files after the migration.falseFalse
RemoveSnapshotsBooleanSpecifies whether you want to remove the snapshots after the migration.falseFalse
RetainMacBooleanSpecifies whether you want to retain the MAC address after the migration.falseFalse
ScheduleEndTimeDateTimeSpecifies the end time of the schedule window in case of bulk migration.falseFalse
ScheduleStartTimeDateTimeSpecifies the start time of the schedule window in case of bulk migration.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
TargetComputeContainerHCXComputeContainerSpecifies the container on the destination site. If you want to retrieve the container, run Get-HCXContainer -Type ComputeContainer -Site $DestinationSite -Name "Container name".falseTrue (ByValue)
TargetComputeFolderHCXFolderContainerSpecifies the folder on the destination site. If you want to retrieve the folder, run Get-HCXContainer -Type Folder -Site $DestinationSite -Name "Folder name".falseTrue (ByValue)
TargetDatastoreHCXDatastoreSpecifies the datastore on the destination site. If you want to retrieve the datastore, run Get-HCXDatastore -Site $DestinationSite -Name "datastore name".falseTrue (ByValue)
TargetStorageProfileHCXStorageProfileSpecifies the storage profile at the destination site that you want to use.falseTrue (ByValue)
UpgradeHardwareBooleanSpecifies whether you want to upgrade the hardware after the migration.falseFalse
UpgradeVMToolsBooleanSpecifies whether you want to upgrade the VM tools after the migration.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.HCXMobilityGroup

Notes

Examples

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

PS C:\> Set-HCXMobilityGroupConfiguration -MobilityGroup $mobilityGroup -RemoveSnapshots true -ScheduleStartTime '01/02/2019 7:50:40 PM' -ScheduleEndTime '01/02/2019 8:50:40 PM' -UpgradeHardware true -RetainMac false

Updates the default group configuration with the specified configuration.


Copyright © VMware, Inc. All rights reserved.