List Desktop Pools | VMware Horizon Server API

List Desktop Pools

Lists the Desktop Pools in the environment.

Request

URI

GET

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

COPY

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

[
    {
        "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": false,
                "max_number_of_monitors": 2,
                "max_resolution_of_any_one_monitor": true,
                "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"
    }
]

401

User is not authenticated

Operation doesn't return any data structure

On This Page

Description

Request

Authentication

Response

200 Response Body

Errors

Inventory Operations

GET