FarmSettings

FarmSettings
FarmSettings

Settings related to the Farm.

JSON Example
{
    "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"
    }
}
boolean
delete_in_progess
Optional

Indicates whether the Farm is in the process of being deleted. Default value is false.

string
desktop_id
Optional

Desktop pool Id representing the RDS Desktop pool to which this Farm belongs.

display_protocol_settings
Optional

display_protocol_settings

load_balancer_settings
Optional

load_balancer_settings

integer As int32 As int32
server_error_threshold
Optional

The minimum number of machines that must be fully operational in order toavoid showing the farm in an error state. Default value is 0.

session_settings
Optional

session_settings

Property Of