Skip to content

Data Object - DesktopRefreshSpec

Java Class

com.omnissa.vdi.vlsi.binding.vdi.resources.Desktop.RefreshSpec

Parameter to

Desktop_Refresh

See also

MachineId

Since

Horizon View 6.0

Data Object Description

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

Data Object Properties

Name Type Description
startTime xsd:dateTime When to start the operation. If unset the operation will begin immediately. 1
logoffSetting xsd:string Determines when to perform the operation on machines which have an active session.
* This property will be one of:
ValueDescription
FORCE_LOGOFFUsers 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_LOGOFFWait for connected users to disconnect before the task starts. The operation starts immediately on machines without active sessions.
stopOnFirstError xsd:boolean Indicates that the operation should stop on first error. 2
machines MachineId[] The machines to refresh. These must be associated with the desktop. MachineIds of this type must originate from the Machine service, but not the VirtualMachine or RegisteredPhysicalMachine services.

  1. This property need not be set. ↩

  2. This property has a default value of true. ↩