Skip to content

Data Object - DesktopLogoffSettings

Java Class

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

Property of

DesktopSettings

Since

Horizon View 6.0

Data Object Description

Settings determine how a virtual machine behaves when the user logs off of the associated machine or when a desktop is no longer keeping a machine as a spare.

Data Object Properties

Name Type Description
powerPolicy xsd:string Power policy for the machines in the desktop after logoff. This setting is only relevant for managed machines. Note(s) :- 5 6
* This property will be one of:
ValueDescription
TAKE_NO_POWER_ACTIONTake no power action. The power state will not be changed when a user logs off or when a desktop is no longer keeping a machine as a spare.
ALWAYS_POWERED_ONEnsure machines are always powered on. The connection server will monitor and power on machines as necessary.
SUSPENDSuspend when a user logs off or when a desktop is no longer keeping a machine as a spare. This does not affect spare and newly provisioned machines.
POWER_OFFPower off when a user logs off or when a desktop is no longer keeping a machine as a spare. This does not affect spare and newly provisioned machines.
automaticLogoffPolicy xsd:string Automatically log-off policy after disconnect. 19
* This property will be one of:
ValueDescription
IMMEDIATELYLogoff immediately after disconnect.
NEVERDo not logoff after disconnect.
AFTERLogoff 'x' minutes after disconnect.
automaticLogoffMinutes xsd:int The timeout in minutes for automatic log-off after disconnect. 7 1 3 8
allowUsersToResetMachines xsd:boolean Whether users are allowed to reset/restart their machines. 2
allowMultipleSessionsPerUser xsd:boolean Whether multiple sessions are allowed per user in case of Floating User Assignment. 2
deleteOrRefreshMachineAfterLogoff xsd:string Whether machines are to be deleted or refreshed after logoff in case of Floating User Assignment. Note(s) :- 9 10 19
* This property will be one of:
ValueDescription
NEVERNever delete or refresh the machine.
DELETEDelete the machine.
REFRESHRefresh the machine. Only applicable when the machine source for the automated desktop is VIEW_COMPOSER or when it is an instant clone pool.
refreshOsDiskAfterLogoff xsd:string Whether and when to refresh the OS disks for dedicated-assignment, linked-clone and instant-clone machines. 19
* This property will be one of:
ValueDescription
NEVERThe OS disk is never refreshed.
ALWAYSThe OS disk is refreshed every time the user logs off.
EVERYTHE OS disk is refreshed at regular intervals of a specified number of days. The number of days is counted from the last refresh, or from the initial provisioning if no refresh has occurred yet. For example, if the specified value is 3 days, and three days have passed since the last refresh, the machine is refreshed after the user logs off.
AT_SIZEThe OS disk is refreshed when its current size reaches a specified percentage of its maximum allowable size. The maximum size of a linked clone's OS disk is the size of the replica's OS disk. With this option, the size of the linked clone's OS disk in the datastore is compared to maximum allowable size. This disk-utilization percentage does not reflect disk usage that you might see inside the machine's guest operating system.
refreshPeriodDaysForReplicaOsDisk xsd:int Regular interval at which to refresh the OS disk. 1 3 11
refreshThresholdPercentageForReplicaOsDisk xsd:int With the 'AT_SIZE' option for refreshOsDiskAfterLogoff, the size of the linked clone's OS disk in the datastore is compared to its maximum allowable size. This disk-utilization percentage does not reflect disk usage that you might see inside the machine's guest operating system. 1 3 18 12
emptySessionTimeoutPolicy xsd:string Application empty session timeout policy. Since Horizon 7.9 21 1
* This property will be one of:
ValueDescription
IMMEDIATEEmpty session is disconnected immediately.
NEVEREmpty session is never disconnected.
AFTEREmpty session is disconnected after specified number of minutes.
emptySessionTimeoutMinutes xsd:int Application empty session timeout (in minutes). An empty session (that has no remote-able window) is disconnected after the timeout. Since Horizon 7.9 4 1 3 13
logoffAfterTimeout xsd:boolean Indicates whether the empty application sessions are logged off (true) or disconnected (false) after timeout. Since Horizon 7.9 2 1
preLaunchSessionTimeoutPolicy xsd:string Application pre-launch session timeout policy. Since Horizon 7.12 21 1
* This property will be one of:
ValueDescription
NEVERPre-launched session is never disconnected.
AFTERPre-launched session is disconnected after specified number of minutes.
preLaunchSessionTimeoutMinutes xsd:int Application pre-launch session timeout (in minutes). A pre-launch session is disconnected after the timeout. Since Horizon 7.12 14 1 20 15
sessionTimeoutPolicy xsd:string Specifies the session timeout policy for the applications published from the Desktop. This policy indicates whether the launched application session is a forever application session or not. Since Horizon 8.3 16 1
* This property will be one of:
ValueDescription
DEFAULTIndicates application sessions will be disconnected either on reaching the global idle timeout or on reaching the max session timeout.
NEVERIndicates application sessions will not be disconnected either on reaching the global idle timeout or on reaching the max session timeout.
usedVMPolicy xsd:string Specifies the used VM policy for the desktop pool. Since Horizon 8.12 17 1
* This property will be one of:
ValueDescription
BLOCK_ACCESSMark desktop that were not cleanly logged off as "Already used" and block user access to them.
ALLOW_WITHOUT_REFRESHAllow desktop that were not cleanly logged off to become available without being refreshed.
AUTO_REFRESHAutomatically refresh desktop that were not cleanly logged off and make desktop available.

  1. This property need not be set. ↩↩↩↩↩↩↩↩↩↩

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

  3. This property has a minimum value of 1. ↩↩↩↩

  4. This property has a default value of 1. ↩

  5. For Instant clone desktops this setting can only be set to ALWAYS_POWERED_ON. ↩

  6. This property has a default value of 'TAKE_NO_POWER_ACTION'. ↩

  7. This property has a default value of 120. ↩

  8. This property is required if automaticLogoffPolicy is set to 'AFTER'. ↩

  9. This is applicable for automated desktops with virtual machines names based on pattern naming. This is not applicable for desktops that are using specified naming since dynamic creation and deletion of VMs is not supported. ↩

  10. For Instant clone desktops this setting can only be set to DELETE. ↩

  11. This property is required if refreshOsDiskAfterLogoff is set to 'EVERY'. ↩

  12. This property is required if refreshOsDiskAfterLogoff is set to 'AT_SIZE'. ↩

  13. This property is required if emptySessionTimeoutPolicy is set to 'AFTER'. ↩

  14. This property has a default value of 10. ↩

  15. This property is required if preLaunchSessionTimeoutPolicy is set to 'AFTER'. ↩

  16. This property has a default value of 'DEFAULT'. ↩

  17. This property has a default value of 'BLOCK_ACCESS'. ↩

  18. This property has a maximum value of 100. ↩

  19. This property has a default value of 'NEVER'. ↩↩↩

  20. This property has a minimum value of 10. ↩

  21. This property has a default value of "AFTER". ↩↩