REST API - deploy

vcenter vm template library items: deploy spec

The deploy_spec structure defines the deployment parameters that can be specified for the deploy operation. Warning: This structure is available as technical preview. It may be changed in a future release.

Representation:

JSON

{
    "description": "string",
    "disk_storage": {
        "datastore": "obj-103",
        "storage_policy": {
            "policy": "obj-103",
            "type": "USE_SPECIFIED_POLICY"
        }
    },
    "disk_storage_overrides": [
        {
            "key": "obj-103",
            "value": {
                "datastore": "obj-103",
                "storage_policy": {
                    "policy": "obj-103",
                    "type": "USE_SPECIFIED_POLICY"
                }
            }
        }
    ],
    "guest_customization": {
        "name": "string"
    },
    "hardware_customization": {
        "cpu_update": {
            "num_cores_per_socket": 1,
            "num_cpus": 1
        },
        "disks_to_remove": [
            "obj-103",
            "obj-103"
        ],
        "disks_to_update": [
            {
                "key": "obj-103",
                "value": {
                    "capacity": 1
                }
            }
        ],
        "memory_update": {
            "memory": 1
        },
        "nics": [
            {
                "key": "obj-103",
                "value": {
                    "network": "obj-103"
                }
            }
        ]
    },
    "name": "string",
    "placement": {
        "cluster": "obj-103",
        "folder": "obj-103",
        "host": "obj-103",
        "resource_pool": "obj-103"
    },
    "powered_on": true,
    "vm_home_storage": {
        "datastore": "obj-103",
        "storage_policy": {
            "policy": "obj-103",
            "type": "USE_SPECIFIED_POLICY"
        }
    }
}

Attributes:

Name	Type	Description
Required
name	string	Name of the deployed virtual machine. Warning: This attribute is available as technical preview. It may be changed in a future release.
Optional
description	string	Description of the deployed virtual machine. Warning: This attribute is available as technical preview. It may be changed in a future release. Optional. If unset, the deployed virtual machine has the same description as the source library item.
vm_home_storage	deploy_spec_vm_home_storage	Storage location for the deployed virtual machine's configuration and log files. Warning: This attribute is available as technical preview. It may be changed in a future release. Optional. If unset, the deployed virtual machine's configuration and log files are created with the same storage spec as the source virtual machine template's configuration and log files.
disk_storage	deploy_spec_disk_storage	Storage specification for the deployed virtual machine's disks. Warning: This attribute is available as technical preview. It may be changed in a future release. Optional. If both `disk_storage_overrides` and `disk_storage` are unset, the deployed virtual machine's disks are created with the same storage spec as the corresponding disks in the source virtual machine template contained in the library item. If `disk_storage_overrides` is unset and `disk_storage` is specified, all of the deployed virtual machine's disks are created with the storage spec specified by `disk_storage`. If `disk_storage_overrides` is specified and `disk_storage` is unset, disks with identifiers that are not in `disk_storage_overrides` are created with the same storage spec as the corresponding disks in the source virtual machine template contained in the library item. If both `disk_storage_overrides` and `disk_storage` are specified, disks with identifiers that are not in `disk_storage_overrides` are created with the storage spec specified by `disk_storage`. .
disk_storage_overrides	list	Storage specification for individual disks in the deployed virtual machine. This is specified as a mapping between disk identifiers in the source virtual machine template contained in the library item and their storage specifications. Warning: This attribute is available as technical preview. It may be changed in a future release. Optional. If both `disk_storage_overrides` and `disk_storage` are unset, the deployed virtual machine's disks are created with the same storage spec as the corresponding disks in the source virtual machine template contained in the library item. If `disk_storage_overrides` is unset and `disk_storage` is specified, all of the deployed virtual machine's disks are created with the storage spec specified by `disk_storage`. If `disk_storage_overrides` is specified and `disk_storage` is unset, disks with identifiers that are not in `disk_storage_overrides` are created with the same storage spec as the corresponding disks in the source virtual machine template contained in the library item. If both `disk_storage_overrides` and `disk_storage` are specified, disks with identifiers that are not in `disk_storage_overrides` are created with the storage spec specified by `disk_storage`. . When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: `com.vmware.vcenter.vm.hardware.Disk`. When operations return a value of this structure as a result, the key in the field key/value pairs will be an identifier for the resource type: `com.vmware.vcenter.vm.hardware.Disk`.
placement	deploy_placement_spec	Information used to place the deployed virtual machine. Warning: This attribute is available as technical preview. It may be changed in a future release. Optional. This field is currently required. In the future, if this field is unset, the system will use the values from the source virtual machine template contained in the library item. If specified, each field will be used for placement. If the fields result in disjoint placement, the operation will fail. If the fields along with the placement values of the source virtual machine template result in disjoint placement, the operation will fail. .
powered_on	boolean	Specifies whether the deployed virtual machine should be powered on after deployment. Warning: This attribute is available as technical preview. It may be changed in a future release. Optional. If unset, the virtual machine will not be powered on after deployment.
guest_customization	guest_customization_spec	Guest customization spec to apply to the deployed virtual machine. Warning: This attribute is available as technical preview. It may be changed in a future release. Optional. If unset, the guest operating system is not customized after deployment.
hardware_customization	hardware_customization_spec	Hardware customization spec which specifies updates to the deployed virtual machine. Warning: This attribute is available as technical preview. It may be changed in a future release. Optional. If unset, the deployed virtual machine has the same hardware configuration as the source virtual machine template contained in the library item.