DesktopPoolSessionSettings

Machine settings applicable when a user logs off or when a desktop pool is no longer keeping a machine as a spare.

JSON Example

{
    "allow_multiple_sessions_per_user": false,
    "allow_users_to_reset_machines": false,
    "delete_or_refresh_machine_after_logoff": "NEVER",
    "disconnected_session_timeout_minutes": 5,
    "disconnected_session_timeout_policy": "NEVER",
    "empty_session_timeout_minutes": 5,
    "empty_session_timeout_policy": "AFTER",
    "logoff_after_timeout": false,
    "power_policy": "ALWAYS_POWERED_ON",
    "refresh_os_disk_after_logoff": "NEVER",
    "refresh_period_days_for_replica_os_disk": 20,
    "refresh_threshold_percentage_for_replica_os_disk": 30
}

boolean

allow_multiple_sessions_per_user

Optional

Indicates whether multiple sessions are allowed per user in case of Floating User Assignment. Default value is false. This property can be used for sorting.

boolean

allow_users_to_reset_machines

Optional

Indicates whether the user can be allowed to reset or restart their machines. Default value is false. This property can be used for sorting.

string

delete_or_refresh_machine_after_logoff

Optional

Whether machines are to be deleted or refreshed after logoff in case of Floating User Assignment.This is applicable for automated desktops with virtual machines names based onpattern naming. This is not applicable for desktops that are using specified naming since dynamic creation and deletion of VMs is not supported.For Instant clone desktops this setting can only be set to DELETE. Default value is NEVER. This property can be used for sorting.

DELETE: Delete the machine after user logoff.
NEVER: Never delete or refresh the machine in the desktop pool.
REFRESH: Refresh the machine after user logoff.

Possible values are : DELETE, NEVER, REFRESH,

integer As int32 As int32

disconnected_session_timeout_minutes

Optional

Disconnected sessions timeout (in minutes). Will be set when disconnected_session_timeout_policy is set to AFTER. This property can be used for sorting.

string

disconnected_session_timeout_policy

Optional

Log-off policy after disconnected session. Default value is NEVER. This property can be used for sorting.

AFTER: Logoff after the specified number of minutes after user disconnect.
IMMEDIATELY: Immediately Logoff after user disconnect.
NEVER: Do not logoff after user disconnect.

Possible values are : AFTER, IMMEDIATELY, NEVER,

integer As int32 As int32

empty_session_timeout_minutes

Optional

Application empty session timeout (in minutes). An empty session (that has no remote-ablewindow) is disconnected after the timeout. Default value is 1.Will be set when the empty_session_timeout_policy set to AFTER. This property can be used for sorting.

string

empty_session_timeout_policy

Optional

Application empty session timeout policy. Default value is AFTER. This property can be used for sorting.

AFTER: Empty session will be disconnected after specified number of minutes.
IMMEDIATE: Empty session will be disconnected immediately.
NEVER: Empty session will never disconnected.

Possible values are : AFTER, IMMEDIATE, NEVER,

boolean

logoff_after_timeout

Optional

Indicates whether the empty application sessions are logged off (true) or disconnected (false) after timeout.Default value is false. This property can be used for sorting.

string

power_policy

Optional

Power policy for the machines in the desktop pool after logoff. This setting is only relevant for managed machines.Default value is TAKE_NO_POWER_ACTION. This property can be used for sorting.

ALWAYS_POWERED_ON: Ensure machines in the Desktop pool are always powered on. The connection server will monitor and power on machines as necessary.
POWER_OFF: Power off when a user logs off or when desktop pool is no longer keeping a machine as a spare. This does not affect spare and newly provisioned machines.
SUSPEND: Suspend when a user logs off or when desktop pool is no longer keeping a machine as a spare. This does not affect spare and newly provisioned machines.
TAKE_NO_POWER_ACTION: No action will be taken when user logs off.

Possible values are : ALWAYS_POWERED_ON, POWER_OFF, SUSPEND, TAKE_NO_POWER_ACTION,

string

refresh_os_disk_after_logoff

Optional

Whether and when to refresh the OS disks for dedicated-assignment, linked-clone and instant-clone machines.Default value is NEVER. This property can be used for sorting.

ALWAYS: The OS disk is refreshed every time the user logs off.
AT_SIZE: The 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.
EVERY: The 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.
NEVER: The OS disk is never refreshed.

Possible values are : ALWAYS, AT_SIZE, EVERY, NEVER,

integer As int32 As int32

refresh_period_days_for_replica_os_disk

Optional

Regular interval at which to refresh the OS disk. Will be set when refresh_os_disk_after_logoff set to EVERY. This property can be used for sorting.

integer As int32 As int32

refresh_threshold_percentage_for_replica_os_disk

Optional

With the 'AT_SIZE' option for refreshOsDiskAfterLogoff, the size of the linked clone's OS diskin 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.Will be set when refresh_os_disk_after_logoff set to AT_SIZE. This property can be used for sorting.

Property Of

DesktopPoolSettings