Get Farm

Get Farm

All the listed privileges are required -

Privileges Description
POOL_VIEW Caller should have permission to this privilege, on the associated access group of the farm.
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": 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"
}
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
Optional

Unique ID representing Farm.

string
name
Optional

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

FarmSettings
settings
Optional

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
Optional

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

403

Access to the resource is forbidden

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

On This Page
Inventory Operations
POST
Add Custom Icon
POST
Add Local Application Pools To GAE
POST
Add Local Desktop Pools To GDE
POST
Add Machines
POST
Add Machines By Name
POST
Add Rds Servers
POST
Archive Machines
POST
Assign Machine Aliases
POST
Assign Users
POST
Cancel Desktop Pool Task
POST
Cancel Scheduled Maintenance
POST
Cancel Scheduled Push Image
POST
Check Application Pool Name Availability
POST
Check Desktop Pool Name Availability
POST
Check Farm Name Availability
POST
Check Machine Prefix Availability
POST
Check RDS Server Prefix Availability
POST
Create Application Icon
POST
Create Application Pool
POST
Create Application Pool V2
POST
Create Desktop Pool
POST
Create Desktop Pool V2
POST
Create Farm
POST
Create Farm V2
POST
Create Farm V3
POST
Create Global Application Entitlement
POST
Create Global Desktop Entitlement
POST
Create Global Desktop Entitlement V2
DELETE
Delete Application Pool
DELETE
Delete Desktop Pool
DELETE
Delete Farm
DELETE
Delete Global Application Entitlement
DELETE
Delete Global Desktop Entitlement
DELETE
Delete Machine
DELETE
Delete Machines
DELETE
Delete Physical Machine
DELETE
Delete RDS Server
POST
Desktop Pool Apply Image
POST
Desktop Pool Promote Pending Image
POST
Disconnect Global Sessions
POST
Disconnect Sessions
POST
Enter Maintenance
POST
Exit Maintenance
POST
Farm Apply Image
POST
Farm Promote Pending Image
GET
Get Application Icon
GET
Get Application Pool
GET
Get Application Pool V2
GET
Get Application Pool V3
GET
Get Desktop Pool
GET
Get Desktop Pool Task
GET
Get Desktop Pool V2
GET
Get Desktop Pool V3
GET
Get Desktop Pool V4
GET
Get Desktop Pool V5
GET
Get Desktop Pool V6
GET
Get Farm
GET
Get Farm V2
GET
Get Farm V3
GET
Get Farm V4
GET
Get Global Application Entitlement
GET
Get Global Application Entitlement V2
GET
Get Global Desktop Entitlement
GET
Get Global Desktop Entitlement V2
GET
Get Machine
GET
Get Machine V2
GET
Get Machine V3
GET
Get Physical Machine
GET
Get Physical Machine V2
GET
Get RDS Server
GET
Get Session Info
GET
List Application Icons
GET
List Application Pools
GET
List Application Pools V2
GET
List Application Pools V3
GET
List Compatible Backup GA Es
GET
List Compatible Backup GD Es
GET
List Compatible Local Application Pools
GET
List Compatible Local Desktop Pools
GET
List Desktop Pools
GET
List Desktop Pools V2
GET
List Desktop Pools V3
GET
List Desktop Pools V4
GET
List Desktop Pools V5
GET
List Desktop Pools V6
GET
List Desktop Pool Tasks
GET
List Farms
GET
List Farms V2
GET
List Farms V3
GET
List Farms V4
GET
List Global Application Entitlements
GET
List Global Application Entitlements V2
GET
List Global Desktop Entitlements
GET
List Global Desktop Entitlements V2
GET
List Installed Applications On Desktop Pool
GET
List Installed Applications On Farm
GET
List Local Application Pools
GET
List Local Desktop Pools
GET
List Machines
GET
List Machines V2
GET
List Machines V3
GET
List Physical Machines
GET
List Physical Machines V2
GET
List RDS Servers
GET
List Session Info
POST
Log Off Global Sessions
POST
Log Off Sessions
POST
Pause Desktop Pool Task
GET
Query Global Sessions
POST
Rebuild Machines
POST
Recover Machines
POST
Recover RDS Servers
POST
Register Physical Machine
POST
Register RDS Server
POST
Remove Custom Icon
DELETE
Remove Local Application Pools From GAE
DELETE
Remove Local Desktop Pools From GDE
POST
Remove Machines
POST
Remove Rds Servers
POST
Reset Global Sessions
POST
Reset Machines
POST
Reset Sessions
POST
Restart Global Sessions
POST
Restart Machines
POST
Restart Sessions
POST
Resume Desktop Pool Task
POST
Schedule Maintenance
POST
Schedule Maintenance V2
POST
Schedule Push Image
POST
Schedule Push Image V2
POST
Send Message To Global Sessions
POST
Send Message To Sessions
POST
Unassign Machine Aliases
POST
Unassign Users
PUT
Update Application Pool
PUT
Update Application Pool V2
PUT
Update Desktop Pool
PUT
Update Farm
PUT
Update Farm V2
PUT
Update Farm V3
PUT
Update Global Application Entitlement
PUT
Update Global Desktop Entitlement
PUT
Update RDS Server
POST
Validate Installed Applications On Desktop Pool
POST
Validate Installed Applications On Farm
POST
Validate Specified Names