DesktopPoolSessionSettingsUpdateSpecV2
Applicable To: Automated and Manual desktop pool.
Session related settings for Automated and Manual desktop pool.
{
"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",
"pre_launch_session_timeout_minutes": 10,
"pre_launch_session_timeout_policy": "AFTER",
"refresh_os_disk_after_logoff": "NEVER",
"refresh_period_days_for_replica_os_disk": 20,
"refresh_threshold_percentage_for_replica_os_disk": 30,
"session_timeout_policy": "DEFAULT",
"used_vm_policy": "BLOCK_ACCESS"
}Indicates whether multiple sessions are allowed per user in case of Floating User Assignment.
Indicates whether the user can be allowed to reset or restart their machines.
Indicates whether machines are to be deleted or refreshed after logoff in case of Floating User Assignment. This is applicable for automated desktop pools with virtual machines names based on pattern naming. This is not applicable for desktop pools that are using specified naming since dynamic creation and deletion of VMs is not supported. For Instant clone desktop pools this setting can only be set to DELETE.
- 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.
Disconnected sessions timeout (in minutes). This is required if disconnected_session_timeout_policy is set to AFTER.
Log-off policy after disconnected session.
- AFTER: Logoff after the specified number of minutes after user disconnect.
- IMMEDIATELY: Immediately Logoff after user disconnect.
- NEVER: Do not logoff after user disconnect.
Desktop Pool empty session timeout (in minutes). An empty session (that has no remote-ablewindow) is disconnected after the timeout. This is required if empty_session_timeout_policy is set to AFTER.
Applicable only when session_type is APPLICATION or DESKTOP_AND_APPLICATION.
Desktop Pool empty session timeout policy.
- AFTER: Empty session will be disconnected after specified number of minutes.
- IMMEDIATE: Empty session will be disconnected immediately.
- NEVER: Empty session will never disconnected.
Applicable only when session_type is APPLICATION or DESKTOP_AND_APPLICATION. Indicates whether the empty desktop pool sessions are logged off (true) or disconnected (false) after timeout.
Power policy for the machines in the desktop pool after logoff. This setting is only relevant for managed machines.
- 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.
Desktop Pool pre-launch session timeout (in minutes). A pre-launch session is disconnected after the timeout. This is required if pre-launch session timeout policy is set to AFTER.
Desktop Pool pre-launch session timeout policy.
- AFTER: Pre-launched session is disconnected after specified number of minutes.
- NEVER: Pre-launched session is never disconnected.
Indicates whether and when to refresh the OS disks for dedicated instant-clone desktop pools.
- 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.
Regular interval at which to refresh the OS disk. This is required if when refresh_os_disk_after_logoff set to EVERY.
With the AT_SIZE option for refresh_os_disk_after_logoff, the size of the instant 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.This is required if refresh_os_disk_after_logoff is set to AT_SIZE.
Specifies the session timeout policy for the applications published from the Desktop pool. This policy indicates whether the launched application session is a forever application session or not.
- DEFAULT: Indicates application sessions will be disconnected either on reaching the global idle timeout or on reaching the max session timeout.
- NEVER: Indicates application sessions will not be disconnected either on reaching the global idle timeout or on reaching the max session timeout.
Specifies the cleanup action to be taken in the event of not cleanly logged off for VMs within a pool that is configured with either a 'Refresh machine after logoff' or 'Delete machine after logoff' policy, or to block user access in case of uncleaned logoff. This is applicable for automated desktop pools with floating user assignment.
- ALLOW_WITHOUT_REFRESH: Allow virtual machines that were not cleanly logged off to become available without being refreshed.
- AUTO_REFRESH: Automatically refresh virtual machines that were not cleanly logged off. Users can access these virtual machines after the refresh operation is completed.
- BLOCK_ACCESS: Mark virtual machines that were not cleanly logged off as "Already used" and block user access to them.