FarmAutomatedSettingsUpdateSpecV2

FarmAutomatedSettingsUpdateSpecV2
FarmAutomatedSettingsUpdateSpecV2

Settings for Automated farm.

JSON Example 
{
    "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"
        },
        "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": {
        "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"
}
FarmCustomizationSettingsUpdateSpecV2
customization_settings
Required

customization_settings

boolean
enable_provisioning
Required

Indicates whether to enable provisioning immediately.

string
max_session_type
Required

RDS Server type for max sessions.

  • UNLIMITED: The RDS Server has an unlimited number of sessions.
  • LIMITED: The RDS Server has a limited number of sessions.
Possible values are : UNLIMITED, LIMITED,
integer As int32 As int32
max_sessions
Optional

Maximum number of sessions allowed for RDS Server. This is required if max_session_type is set to LIMITED.

integer As int32 As int32
min_ready_vms
Required

Minimum number of ready (provisioned) RDS Servers during Instant clone maintenance operations. Use this setting to perform machine maintenance operations in a rolling fashion. Increasing this count may decrease the concurrency for Instant clone maintenance operations for the automated farm.

array of FarmNetworkInterfaceCardSettingsUpdateSpec
nics
Optional

Network interface card settings for RDS Servers provisioned for this farm. A NIC may appear at most once in these settings and must be present on this RDS Server's parent's snapshot. Not all NICs need be configured. Any that are not will use default settings.

FarmRDSServersPatternNamingSettingsUpdateSpec
pattern_naming_settings
Required

pattern_naming_settings

FarmProvisioningSettingsUpdateSpec
provisioning_settings
Required

provisioning_settings

boolean
stop_provisioning_on_error
Required

Indicates whether provisioning on all VMs stops on error.

FarmStorageSettingsUpdateSpec
storage_settings
Required

storage_settings

string
transparent_page_sharing_scope
Required

Transparent page sharing scope for the farm.

  • FARM: Inter-VM page sharing among VMs belonging to the same automated farm is permitted.
  • GLOBAL: Inter-VM page sharing among all VMs on the same host is permitted.
  • POD: Inter-VM page sharing among VMs belonging to the same Pod is permitted.
  • VM: Inter-VM page sharing is not permitted.
Possible values are : FARM, GLOBAL, POD, VM,
Property Of