DesktopPoolSettings

DesktopPoolSettings
DesktopPoolSettings

Information related to Desktop Pool Settings.

JSON Example
{
    "allow_mutilple_sessions_per_user": false,
    "category_folder_name": "dir1",
    "cloud_assigned": false,
    "cloud_managed": false,
    "cs_restriction_tags": [
        "CS1_TAG1"
    ],
    "delete_in_progress": false,
    "display_protocol_settings": {
        "allow_users_to_choose_protocol": true,
        "default_display_protocol": "PCOIP",
        "display_protocols": [
            "PCOIP",
            "BLAST",
            "RDP"
        ],
        "grid_vgpus_enabled": false,
        "html_access_enabled": true,
        "max_number_of_monitors": 2,
        "max_resolution_of_any_one_monitor": "WUXGA",
        "renderer3d": true,
        "session_collaboration_enabled": false,
        "vgpu_grid_profile": "instant-profile",
        "vram_size_mb": 64
    },
    "enable_client_restrictions": false,
    "session_settings": {
        "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
    },
    "session_type": "DESKTOP",
    "shortcut_locations": [
        "Desktop"
    ]
}
boolean
allow_mutilple_sessions_per_user
Optional

Whether multiple sessions are allowed per user for this pool. This is valid for RDS desktop pools.For other Desktops, allow_multiple_sessions_per_user in settings will be applicable.Default value is false.

string
category_folder_name
Optional

Name of the category folder in the user's OS containing a shortcut to the desktop pool.Will be unset if the desktop does not belong to a category.This property defines valid folder names with a max length of 64 characters and up to 4 subdirectory levels.The subdirectories can be specified using a backslash, e.g. (dir1\dir2\dir3\dir4). Folder names can't start orend with a backslash nor can there be 2 or more backslashes together. Combinations such as(\dir1, dir1\dir2, dir1\dir2, dir1\\dir2) are invalid. The windows reserved keywords(CON, PRN, NUL, AUX, COM1 - COM9, LPT1 - LPT9 etc.) are not allowed in subdirectory names.

boolean
cloud_assigned
Optional

Indicates whether this desktop is assigned to a workspace in Horizon Cloud Services. Default value is false.

boolean
cloud_managed
Optional

Indicates whether this desktop is managed by Horizon Cloud Services.This can be false only when cloud_assigned is false. Default value is false.

array of string
cs_restriction_tags
Optional

List of tags for which the access to the desktop pool is restricted to.No list indicates that desktop pool can be accessed from any connection server.

boolean
delete_in_progress
Optional

Indicates whether the desktop pool is in the process of being deleted.Default value is false.

display_protocol_settings
Optional

display_protocol_settings

boolean
enable_client_restrictions
Optional

Client restrictions to be applied to the desktop pool.Currently it is valid for RDS desktop pools only. Default value is false.

session_settings
Optional

session_settings

string
session_type
Optional

Supported session types for this desktop pool. If application sessions are selected to besupported then this desktop pool can be used for application pool creation. This will beuseful when the machines in the pool support application remoting. Default value of DESKTOP.

  • DESKTOP: Only desktop sessions are supported.
  • APPLICATION: Only application sessions are supported.
  • DESKTOP_AND_APPLICATION: Both desktop and application sessions are supported.
Possible values are : DESKTOP, APPLICATION, DESKTOP_AND_APPLICATION,
array of string
shortcut_locations
Optional

Locations of the category folder in the user's OS containing a shortcut to the desktop pool.The value will be present if categoryFolderName is set.

Property Of