Get Desktop Pool | VMware Horizon Server API

Get Desktop Pool

Required Privileges : (This server version allows only Administrators on Root access group to login. These privileges are NOT relevant currently but will be applicable in later server versions.)

All the listed privileges are required -

Privileges	Description
POOL_VIEW	Caller should have permission to this privilege, on the associated access group of the desktop pool.

Request

URI

GET

https://{api_host}//localhost/rest/inventory/v1/desktop-pools/{id}

COPY

Path Parameters

string

Required

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

Returns DesktopPoolInfo of type(s) */*

{
    "description": "Desktop pool description",
    "display_name": "pool",
    "enabled": true,
    "id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
    "name": "sales-pool1",
    "settings": {
        "allow_mutilple_sessions_per_user": false,
        "category_folder_name": "dir1",
        "cloud_assigned": false,
        "cloud_managed": false,
        "cs_restriction_tags": [
            "string"
        ],
        "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": 0,
            "refresh_threshold_percentage_for_replica_os_disk": 0
        },
        "session_type": "DESKTOP",
        "shortcut_locations": [
            "string"
        ]
    },
    "source": "INSTANT_CLONE",
    "type": "AUTOMATED"
}

string

description

Optional

Description of the Desktop Pool. The maximum length is 1024 characters.

string

display_name

Optional

Display name of the Desktop Pool. The maximum length is 256 characters.

boolean

enabled

Required

Indicates whether the Desktop Pool is enabled for brokering.

string

Required

Unique ID representing Desktop Pool.

string

name

Required

Name of the Desktop Pool. The maximum length is 64 characters.

DesktopPoolSettings

settings

Required

settings

string

source

Required

Source of the Machines in this Desktop Pool.

INSTANT_CLONE: The Desktop Pool uses instant clone technology for provisioning the machines.Applicable for AUTOMATED type desktop pools.
LINKED_CLONE: The Desktop Pool uses linked clone technology for provisioning the machines.Applicable for AUTOMATED type desktop pools.
VIRTUAL_CENTER: The Desktop Pool uses Virtual Center as source for provisioning the machines.Applicable for AUTOMATED and MANUAL type desktop pools.
RDS: The Desktop Pool is backed by Farm. The Farm used in this Desktop Pool can be of any Source.
UNMANAGED: The Desktop Pool holds the non-vCenter source machines that includes physical computers,blade PCs and non-vCenter servers. Applicable for MANUAL type desktop pools.