Get Farm

Get Farm

Gets the Farm information.

Request
URI
GET
https://{api_host}//localhost/rest/inventory/v1/farms/{id}
COPY
Path Parameters
string
id
Required

id

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns FarmInfo of type(s) */* 
{
    "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": false,
            "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"
}
string
description
Optional

Farm description. The maximum length is 1024 characters.

string
display_name
Optional

Display name of the Farm. The maximum length is 256 characters.

boolean
enabled
Optional

Indicates whether the Farm is enabled for brokering. Default value is true.

string
id
Required

Unique ID representing Farm.

string
name
Required

Name of the Farm. The maximum length is 64 characters.

FarmSettings
settings
Required

settings

string
source
Optional

Type of the Farm.

  • INSTANT_CLONE: The Farm uses instant clone technology for provisioning the RDS Servers.Applicable for AUTOMATED type Farms only.
  • LINKED_CLONE: The Farm uses linked clone technology for provisioning the RDS Servers.Applicable for AUTOMATED type Farms only.
Possible values are : INSTANT_CLONE, LINKED_CLONE,
string
type
Required

Type of the Farm.

  • AUTOMATED: Automated Farm.
  • MANUAL: Manual Farm.
Possible values are : AUTOMATED, MANUAL,

401

User is not authenticated

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

On This Page
Inventory Operations
GET
Get Desktop Pool
GET
Get Farm
GET
Get Machine Using GET
GET
List Desktop Pools
GET
List Farms