create_rdsh_farm
Creates a new RDS farm in Horizon, provisioning VMs for automated farms if configured; confirm before starting automated provisioning.
Instructions
Create a new RDS farm.
CAUTION: Provisioning an AUTOMATED farm immediately begins creating VMs in vCenter. Always confirm with the user before calling this.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| spec | Yes | Full farm specification, verified live against a real Horizon server (2606). Required top-level keys: name, type (AUTOMATED | MANUAL), access_group_id (from the horizon://config/local-access-groups resource). AUTOMATED farms require an automated_farm_settings object — NOT the same shape as create_desktop_pool's provisioning_settings, and nested one level deeper — containing: vcenter_id (list_virtual_centers), max_session_type (LIMITED | UNLIMITED — max_sessions is required when LIMITED); provisioning_settings: {parent_vm_id (list_base_vms), base_snapshot_id (list_base_vm_snapshots), datacenter_id (list_datacenters), vm_folder_id (list_vm_folders), host_or_cluster_id (list_hosts_or_clusters), resource_pool_id (list_resource_pools)}; storage_settings: {datastores: [{datastore_id}]} (list_datastores); customization_settings: {instant_clone_domain_account_id (list_ic_domain_accounts), ad_container_rdn (list_ad_domains + list_ad_containers)}; pattern_naming_settings: {naming_pattern, max_number_of_rds_servers}. settings.desktop_id links the farm to its RDS desktop pool. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||