View API


Data Object - DesktopRecomposeSpec

Class
VMware.Hv.RecomposeSpec
Parameter to
Desktop_Recompose
See also
BaseImageSnapshotId, BaseImageVmId, MachineId
Since
Horizon View 6.0

Data Object Description

Specification for the recompose operation. This operation is applicable only to View Composer sourced desktops.

Data Object Properties

Properties

Name Type Description
parentVmBaseImageVmId

New base image VM for View Composer VMs. This must be in the same datacenter as the base image of the desktop.
snapshotBaseImageSnapshotId

Base image snapshot for the View Composer desktop.
startTimexsd:dateTime

When to start the operation. If unset the operation will begin immediately.
  • This property need not be set.
logoffSettingxsd:string

Determines when to perform the operation on machines which have an active session.
  • This property will be one of:
    Value Description
    "FORCE_LOGOFF"Users will be forced to log off when the system is ready to operate on their virtual machines. Before being forcibly logged off, users may have a grace period in which to save their work (Global Settings).
    "WAIT_FOR_LOGOFF"Wait for connected users to disconnect before the task starts. The operation starts immediately on machines without active sessions.
stopOnFirstErrorxsd:boolean

Indicates that the operation should stop on first error.
  • This property has a default value of true.
machinesMachineId[]

The machines to recompose. These must be associated with the desktop. MachineIds of this type must originate from the Machine service, but not the VirtualMachine or RegisteredPhysicalMachine services.
changeImageForNewVMsxsd:boolean

Change the default image for new machines. If this flag set to TRUE, existing machines in the pool get re-composed to the selected snapshot and new machines creates from the latest snapshot. If this flag is set to FALSE, existing machines in the pool gets re-composed to the selected snapshot and new machines creates from the older snapshot which is selected while creating pool

Since Horizon 7.7
  • This property has a default value of true.
  • This property need not be set.