Update Farm V7
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. |
id
{
"access_group_id": "6fd4638a-381f-4518-aed6-042aa3d9f14c",
"automated_farm_settings": {
"customization_script_settings": {
"post_synchronization_script_name": "postsync_script",
"post_synchronization_script_parameters": "p1 p2 p3",
"power_off_script_name": "poweroff_script",
"power_off_script_parameters": "p1 p2 p3"
},
"customization_settings": {
"ad_container_rdn": "CN=Computers",
"ad_site_name": "Default-First-Site-Name",
"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"
},
"customization_type": "CLONE_PREP",
"instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"reuse_pre_existing_accounts": false,
"sysprep_customization_spec_id": "a219420d-4799-4517-8f78-39c74c7c4efc"
},
"enable_provisioning": true,
"enable_sysprep_domain_join": 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": {
"connecting_session_threshold": 10,
"cpu_threshold": 10,
"disk_queue_length_threshold": 15,
"disk_read_latency_threshold": 10,
"disk_write_latency_threshold": 15,
"include_session_count": true,
"load_index_threshold": 20,
"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",
"session_timeout_policy": "DEFAULT"
},
"use_custom_script_for_load_balancing": false
}
Access groups can organize the entities such as farms in the organization. They can also be used for delegated administration.
Description of the farm.
Display name of the farm.
Indicates whether the farm is enabled for brokering.
The minimum number of machines that must be fully operational in order to avoid showing the farm in an error state.
Indicates whether to use custom scripts for load balancing or not.
No Content
Bad Request
User is not authenticated
Access to the resource is forbidden
Not Found