List Farms | VMware Horizon Server API

List Farms

Lists the Farms in the environment.

Request

URI

GET

https://{api_host}//localhost/rest/inventory/v1/farms

COPY

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

[
    {
        "description": "Farm description",
        "display_name": "Farm-display-1",
        "enabled": true,
        "id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
        "name": "ManualFarm1",
        "settings": {
            "delete_in_progess": false,
            "desktop_id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
            "display_protocol_settings": {
                "allow_display_protocol_override": true,
                "default_display_protocol": "PCOIP",
                "grid_vgpus_enabled": false,
                "html_access_enabled": true,
                "session_collaboration_enabled": false,
                "vgpu_grid_profile": "instant-profile"
            },
            "load_balancer_settings": {
                "custom_script_in_use": false,
                "lb_metric_settings": {
                    "cpu_threshold": 50,
                    "disk_queue_length_threshold": 50,
                    "disk_read_latency_threshold": 50,
                    "disk_write_latency_threshold": 50,
                    "include_session_count": true,
                    "memory_threshold": 50
                }
            },
            "server_error_threshold": 5,
            "session_settings": {
                "disconnected_session_timeout_minutes": 5,
                "disconnected_session_timeout_policy": "NEVER",
                "empty_session_timeout_minutes": 5,
                "empty_session_timeout_policy": "AFTER",
                "logoff_after_timeout": false,
                "pre_launch_session_timeout_minutes": 10,
                "pre_launch_session_timeout_policy": "AFTER"
            }
        },
        "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

POST