Set-HCXMobilityGroupConfiguration Command | Vmware PowerCLI Reference

Set-HCXMobilityGroupConfiguration

This cmdlet updates the HCX mobility group configurations.

Syntax

Set-HCXMobilityGroupConfiguration
-MobilityGroup < HCXMobilityGroup >
[-DiskProvisionType < DiskProvisionType > ]
[-ForcePowerOffVm < Boolean > ]
[-MigrationType < MigrationType > ]
[-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 > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
MobilityGroup HCXMobilityGroup named
  • pipeline
Specifies the mobility group where you want to perform an update operation.
optional DiskProvisionType DiskProvisionType named
Specifies the type of the disk provisioning that you want to use.
optional ForcePowerOffVm Boolean named
Specifies whether you want the virtual machine to be in a powered off state after the migration.
optional MigrationType MigrationType named
Specifies the type of migration that you want to perform.
optional NetworkMapping HCXNetworkMapping[] named
Specifies the source and destination networks you want to use.
optional RemoveISOs Boolean named
Specifies whether you want to remove the ISO files after the migration.
optional RemoveSnapshots Boolean named
Specifies whether you want to remove the snapshots after the migration.
optional RetainMac Boolean named
Specifies whether you want to retain the MAC address after the migration.
optional ScheduleEndTime DateTime named
Specifies the end time of the schedule window in case of bulk migration.
optional ScheduleStartTime DateTime named
Specifies the start time of the schedule window in case of bulk 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.
optional TargetComputeContainer HCXComputeContainer named
  • pipeline
Specifies the container on the destination site. If you want to retrieve the container, run Get-HCXContainer -Type ComputeContainer -Site $DestinationSite -Name "Container name".
optional TargetComputeFolder HCXFolderContainer named
  • pipeline
Specifies the folder on the destination site. If you want to retrieve the folder, run Get-HCXContainer -Type Folder -Site $DestinationSite -Name "Folder name".
optional TargetDatastore HCXDatastore named
  • pipeline
Specifies the datastore on the destination site. If you want to retrieve the datastore, run Get-HCXDatastore -Site $DestinationSite -Name "datastore name".
optional TargetStorageProfile HCXStorageProfile named
  • pipeline
Specifies the storage profile at the destination site that you want to use.
optional UpgradeHardware Boolean named
Specifies whether you want to upgrade the hardware after the migration.
optional UpgradeVMTools Boolean named
Specifies whether you want to upgrade the VM tools after the migration.

Output

VMware.VimAutomation.Hcx.Types.V1.HCXMobilityGroup

Examples

Example 1

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.

Related Commands

HCXMobilityGroup

This cmdlet retrieves a list of HCX mobility groups.

This cmdlet creates an HCX mobility group request.

This cmdlet modifies the HCX mobility group.

This cmdlet validates an HCX mobility group object.

HCXMobilityGroupConfiguration

This cmdlet creates an HCX mobility group configuration request.

This cmdlet updates the HCX mobility group configurations.

HCXMobilityGroupMigration

This cmdlet starts the HCX Mobility Group migrations.

This cmdlet stops the migration of all virtual machines in the mobility group.