DesktopPoolCustomizationSettings

DesktopPoolCustomizationSettings
DesktopPoolCustomizationSettings

Customization settings.

JSON Example
{
    "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",
    "do_not_power_on_vms_after_creation": false,
    "instant_clone_domain_account_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
    "quickprep_customization_settings": {
        "post_synchronization_script_parameters": "p1 p2 p3",
        "post_synchronization_script_path": "quickprep_postsync_script",
        "power_off_script_parameters": "p1 p2 p3",
        "power_off_script_path": "quickprep_poweroff_script"
    },
    "reuse_pre_existing_accounts": false,
    "sysprep_customization_spec_id": "a219420d-4799-4517-8f78-39c74c7c4efc",
    "view_composer_domain_account_id": "0ebb464a-8780-4860-924f-8b2d1d1b33ef"
}
string
ad_container_rdn
Optional

Applicable To: Full/instant clone automated desktop pools.
Full clone and Instant Clone Engine Active Directory container for SysPrep and ClonePrep. This property can be used for sorting.

cloneprep_customization_settings
Optional

cloneprep_customization_settings

string
customization_type
Optional

Type of customization to use. This property can be used for sorting.

  • CLONE_PREP: Applicable To: Instant clone desktop pools.
    ClonePrep is a VMware system tool executed by Instant Clone Engine during a instant clone machine deployment. ClonePrep personalizes each machine created from the Master image.
  • NONE: Applicable To: Full clone desktop pools.
    No customization.
  • SYS_PREP: Applicable To: Full clone desktop pools.
    Microsoft Sysprep is a tool to deploy the configured operating system installation from a base image. The machine can then be customized based on an answer script. Sysprep can modify a larger number of configurable parameters than QuickPrep.
Possible values are : CLONE_PREP, NONE, SYS_PREP,
boolean
do_not_power_on_vms_after_creation
Optional

Whether to power on VMs after creation. This is the settings when customization will be done manually. This property can be used for sorting.

string
instant_clone_domain_account_id
Optional

Applicable To: Instant clone and Full clone desktop pools.
Instant clone or full clone domain account. This is the administrator which will add the machines to its domain upon creation.

quickprep_customization_settings
Optional

quickprep_customization_settings

boolean
reuse_pre_existing_accounts
Optional

Applicable To: Manual and automated desktop pools.
Whether to allow the use of existing AD computer accounts when the VM names of newly created clones match the existing computer account names. This is applicable only for automated desktop pools. This property can be used for sorting.

string
sysprep_customization_spec_id
Optional

Customization specification to use when Sysprep customization is requested.

string
view_composer_domain_account_id
Optional

Applicable To: Linked clone automated desktop pools.
View Composer domain account. This is the administrator which will add the machines to its domain upon creation. This must be set for linked-clone automated desktop pools.