Data Object - FarmRecomposeSpec

Java Class

com.omnissa.vdi.vlsi.binding.vdi.resources.Farm.RecomposeSpec

Parameter to

Farm_Recompose

Data Object Description¶

Specification for the recompose operation.

Name

Type

Description

parentVm

BaseImageVmId

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.

snapshot

BaseImageSnapshotId

Base image snapshot for the Automated Farm's RDS Servers.

startTime

xsd:dateTime

When to start the operation. If unset the operation will begin immediately. ¹

logoffSetting

xsd: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.

stopOnFirstError

xsd:boolean

Indicates that the operation should stop on first error. ²

rdsServers

RDSServerId[]

The RDS Servers to recompose.