Data Object - FarmRecomposeSpec

Class
VMware.Hv.RecomposeSpec
Parameter to
Farm_Recompose
See also
BaseImageSnapshotId, BaseImageVmId, RDSServerId
Since
Horizon View 6.2

Data Object Description

Specification for the recompose operation.

Data Object Properties

Properties

Name Type Description
parentVmBaseImageVmId

New base image VM for automated farm's RDS Servers. This must be in the same datacenter as the base image of the RDS Server.
snapshotBaseImageSnapshotId

Base image snapshot for the Automated Farm's RDS Servers.
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 RDS servers 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 RDS Servers. 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 RDS Servers without active sessions.
stopOnFirstErrorxsd:boolean

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

The RDS Servers to recompose.