create_desktop_pool
Creates a new desktop pool in Horizon, provisioning VMs for automated pools. Confirm with user before use, as provisioning starts immediately.
Instructions
Create a new desktop pool.
CAUTION: Provisioning an AUTOMATED pool immediately begins creating VMs in vCenter. Always confirm with the user before calling this.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| spec | Yes | Full pool specification, verified against a live Horizon server (2606). Required top-level keys: name, type (AUTOMATED | MANUAL | RDS), source (INSTANT_CLONE | LINKED_CLONE | VIRTUAL_CENTER | RDS | UNMANAGED), user_assignment (FLOATING | DEDICATED), naming_method (SPECIFIED | PATTERN), access_group_id (required for AUTOMATED/MANUAL pools — get one from the horizon://config/local-access-groups resource). AUTOMATED pools ALSO require these — all top-level, NOT nested under provisioning_settings, despite what that name suggests: vcenter_id (from list_virtual_centers); 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: {customization_type: 'CLONE_PREP' for instant clone, ad_container_rdn (list_ad_domains + list_ad_containers), instant_clone_domain_account_id (list_ic_domain_accounts)}; pattern_naming_settings: {naming_pattern, max_number_of_machines} when naming_method='PATTERN'. nics is optional and top-level (network_interface_card_id + network_label_assignment_specs) — if omitted, new machines simply inherit the parent image's existing network settings. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||