Update Farm

All the listed privileges are required -

Privileges	Description
POOL_MANAGEMENT	Caller should have permission to this privilege, on the associated access group of the farm. To update the access group for the farm, caller should also have permission to this privilege on the access group to which farm will be associated after update.

Request

URI

PUT

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

COPY

Path Parameters

string

Required

Request Body

FarmUpdateSpec of type(s) application/json

Required

Show optional properties

{
    "access_group_id": "6fd4638a-381f-4518-aed6-042aa3d9f14c",
    "display_name": "ManualFarm",
    "display_protocol_settings": {
        "allow_users_to_choose_protocol": true,
        "default_display_protocol": "PCOIP",
        "session_collaboration_enabled": false
    },
    "enabled": true,
    "server_error_threshold": 0,
    "session_settings": {
        "disconnected_session_timeout_policy": "NEVER",
        "empty_session_timeout_policy": "AFTER"
    },
    "use_custom_script_for_load_balancing": false
}

{
    "access_group_id": "6fd4638a-381f-4518-aed6-042aa3d9f14c",
    "automated_farm_settings": {
        "customization_settings": {
            "ad_container_rdn": "CN=Computers",
            "cloneprep_customization_settings": {
                "post_synchronization_script_name": "cloneprep_postsync_script",
                "post_synchronization_script_parameters": "p1 p2 p3",
                "power_off_script_name": "cloneprep_poweroff_script",
                "power_off_script_parameters": "p1 p2 p3",
                "priming_computer_account": "a219420d-4799-4517-8f78-39c74c7c4efc"
            },
            "reuse_pre_existing_accounts": false
        },
        "enable_provisioning": true,
        "max_session_type": "LIMITED",
        "max_sessions": 50,
        "min_ready_vms": 0,
        "nics": [
            {
                "network_interface_card_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
                "network_label_assignment_specs": [
                    {
                        "enabled": true,
                        "max_label": 1,
                        "max_label_type": "LIMITED",
                        "network_label_name": "vm-network"
                    }
                ]
            }
        ],
        "pattern_naming_settings": {
            "max_number_of_rds_servers": 5,
            "naming_pattern": "vm-{n}-sales"
        },
        "provisioning_settings": {
            "host_or_cluster_id": "domain-s425",
            "resource_pool_id": "resgroup-1"
        },
        "stop_provisioning_on_error": true,
        "storage_settings": {
            "datastores": [
                {
                    "datastore_id": "datastore-1"
                }
            ],
            "replica_disk_datastore_id": "datastore-1"
        },
        "transparent_page_sharing_scope": "VM"
    },
    "description": "Farm Description",
    "display_name": "ManualFarm",
    "display_protocol_settings": {
        "allow_users_to_choose_protocol": true,
        "default_display_protocol": "PCOIP",
        "session_collaboration_enabled": false
    },
    "enabled": true,
    "load_balancer_settings": {
        "cpu_threshold": 10,
        "disk_queue_length_threshold": 15,
        "disk_read_latency_threshold": 10,
        "disk_write_latency_threshold": 15,
        "include_session_count": true,
        "memory_threshold": 10
    },
    "server_error_threshold": 0,
    "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"
    },
    "use_custom_script_for_load_balancing": false
}

string

access_group_id

Required

Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.

object

automated_farm_settings

Optional

Settings for Automated farm. This is required if type is set to AUTOMATED.

string

description

Optional

Constraints: minLength: 0 maxLength: 1024

Description of the farm.

string

display_name

Required

Constraints: minLength: 0 maxLength: 256

Display name of the farm.

object

display_protocol_settings

Required

Display protocol settings for the farm.

boolean

enabled

Required

Indicates whether the farm is enabled for brokering.

object

load_balancer_settings

Optional

RDSH load balancer settings for the farm. This is required if use_custom_script_for_load_balancing is false.

integer As int32 As int32

server_error_threshold

Required

Constraints: minimum: 0

The minimum number of machines that must be fully operational in order to avoid showing the farm in an error state.

object

session_settings

Required

Session settings related to the Farm.

boolean

use_custom_script_for_load_balancing

Required

Indicates whether to use custom scripts for load balancing or not.

Authentication

This operation uses the following authentication methods.

Bearer

Responses

204

No Content