FarmCreateSpecV4

FarmCreateSpecV4
FarmCreateSpecV4

Farm object to be created.

JSON Example
{
    "access_group_id": "6fd4638a-381f-4518-aed6-042aa3d9f14c",
    "automated_farm_settings": {
        "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,
        "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": {
            "base_snapshot_id": "snapshot-1",
            "compute_profile_num_cores_per_socket": 1,
            "compute_profile_num_cpus": 4,
            "compute_profile_ram_mb": 4096,
            "datacenter_id": "datacenter-1",
            "host_or_cluster_id": "domain-s425",
            "im_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
            "im_tag_id": "3d45b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
            "parent_vm_id": "vm-2",
            "resource_pool_id": "resgroup-1",
            "vm_folder_id": "group-v1"
        },
        "stop_provisioning_on_error": true,
        "storage_settings": {
            "datastores": [
                {
                    "datastore_id": "datastore-1"
                }
            ],
            "replica_disk_datastore_id": "datastore-1",
            "use_separate_datastores_replica_and_os_disks": false,
            "use_view_storage_accelerator": false,
            "use_vsan": false
        },
        "transparent_page_sharing_scope": "VM",
        "vcenter_id": "f148f3e8-db0e-4abb-9c33-7e5205ccd360"
    },
    "description": "Farm Description",
    "display_name": "ManualFarm",
    "display_protocol_settings": {
        "allow_users_to_choose_protocol": true,
        "default_display_protocol": "PCOIP",
        "grid_vgpus_enabled": true,
        "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
    },
    "name": "ManualFarm",
    "rds_server_ids": [
        "5134796a-322g-5fe5-343f-4daa5d25ebfe",
        "2a43f96c-102b-4ed3-953f-35deg43d43b0ge"
    ],
    "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"
    },
    "type": "MANUAL",
    "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.

automated_farm_settings
Optional

automated_farm_settings

string
description
Optional

Description of the farm.

string
display_name
Optional

Display name of the farm. If the display name is left blank, it defaults to name.

display_protocol_settings
Optional

display_protocol_settings

boolean
enabled
Optional

Indicates whether the farm is enabled for brokering. Default value is true.

load_balancer_settings
Optional

load_balancer_settings

string As [a-zA-Z0-9_-]{1,64}
name
Required

Name of the farm. This property must contain only alphanumerics, underscores, and dashes.

array of string
rds_server_ids
Optional

List of IDs of RDS Servers in the Manual Farm. This is applicable if type is set to MANUAL.

integer As int32 As int32
server_error_threshold
Optional

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

session_settings
Optional

session_settings

string
type
Required

Type of the farm.

  • AUTOMATED: Automated Farm.
  • MANUAL: Manual Farm.
Possible values are : AUTOMATED, MANUAL,
boolean
use_custom_script_for_load_balancing
Optional

Indicates whether to use custom scripts for load balancing or not. Default value is false.

Parameter To