Vcenter VmTemplate LibraryItems deploy

Deploys a virtual machine as a copy of the source virtual machine template contained in the library item specified by templateLibraryItem. It uses the deployment specification in spec. If Vcenter VmTemplate LibraryItems DeploySpec.powered_on and/or Vcenter VmTemplate LibraryItems DeploySpec.guest_customization are specified, the server triggers the power on and/or guest customization operations, which are executed asynchronously.

This operation was added in vSphere API 6.8.

Returns an authorization error if you do not have all of the privileges described as follows:

Operation execution requires System.Read.
The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires VirtualMachine.Provisioning.DeployTemplate.
The resource Datastore referenced by the property Vcenter VmTemplate LibraryItems DeploySpecVmHomeStorage.datastore requires System.Read.
The resource com.vmware.spbm.StorageProfile referenced by the property Vcenter VmTemplate LibraryItems DeploySpecVmHomeStoragePolicy.policy requires System.Read.
The resource Datastore referenced by the property Vcenter VmTemplate LibraryItems DeploySpecDiskStorage.datastore requires System.Read.
The resource com.vmware.spbm.StorageProfile referenced by the property Vcenter VmTemplate LibraryItems DeploySpecDiskStoragePolicy.policy requires System.Read.
The resource com.vmware.vcenter.vm.hardware.Disk referenced by the map key of property Vcenter VmTemplate LibraryItems DeploySpec.disk_storage_overrides requires System.Read.
The resource Folder referenced by the property Vcenter VmTemplate LibraryItems DeployPlacementSpec.folder requires System.Read.
The resource ResourcePool referenced by the property Vcenter VmTemplate LibraryItems DeployPlacementSpec.resource_pool requires System.Read.
The resource HostSystem referenced by the property Vcenter VmTemplate LibraryItems DeployPlacementSpec.host requires System.Read.
The resource ClusterComputeResource referenced by the property Vcenter VmTemplate LibraryItems DeployPlacementSpec.cluster requires System.Read.
The resource com.vmware.vcenter.vm.hardware.Ethernet referenced by the map key of property Vcenter VmTemplate LibraryItems HardwareCustomizationSpec.nics requires System.Read.
The resource Network referenced by the property Vcenter VmTemplate LibraryItems EthernetUpdateSpec.network requires System.Read.
The resource com.vmware.vcenter.vm.hardware.Disk referenced by the property Vcenter VmTemplate LibraryItems HardwareCustomizationSpec.disks_to_remove requires System.Read.
The resource com.vmware.vcenter.vm.hardware.Disk referenced by the map key of property Vcenter VmTemplate LibraryItems HardwareCustomizationSpec.disks_to_update requires System.Read.

Request

URI

POST

https://{api_host}/api/vcenter/vm-template/library-items/{templateLibraryItem}?action=deploy

COPY

Path Parameters

string

templateLibraryItem

Required

identifier of the content library item containing the source virtual machine template to be deployed.

The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

Request Body

specification of how the virtual machine should be deployed.

Vcenter VmTemplate LibraryItems DeploySpec of type(s) application/json

Required

Show optional properties

{
    "name": "string"
}

{
    "name": "string",
    "description": "string",
    "vm_home_storage": {
        "datastore": "string",
        "storage_policy": {
            "type": "string",
            "policy": "string"
        }
    },
    "disk_storage": {
        "datastore": "string",
        "storage_policy": {
            "type": "string",
            "policy": "string"
        }
    },
    "disk_storage_overrides": {
        "disk_storage_overrides": {
            "datastore": "string",
            "storage_policy": {
                "type": "string",
                "policy": "string"
            }
        }
    },
    "placement": {
        "folder": "string",
        "resource_pool": "string",
        "host": "string",
        "cluster": "string"
    },
    "powered_on": false,
    "guest_customization": {
        "name": "string"
    },
    "hardware_customization": {
        "nics": {
            "nics": {
                "network": "string"
            }
        },
        "disks_to_remove": [
            "string"
        ],
        "disks_to_update": {
            "disks_to_update": {
                "capacity": 0
            }
        },
        "cpu_update": {
            "num_cpus": 0,
            "num_cores_per_socket": 0
        },
        "memory_update": {
            "memory": 0
        }
    }
}

string

name

Required

Name of the deployed virtual machine.

This property was added in vSphere API 6.8.

string

description

Optional

Description of the deployed virtual machine.

This property was added in vSphere API 6.8.

If missing or null, the deployed virtual machine has the same description as the source library item.

vm_home_storage

Optional

Storage location for the deployed virtual machine's configuration and log files.

This property was added in vSphere API 6.8.

If missing or null, 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

Optional

Storage specification for the deployed virtual machine's disks.

This property was added in vSphere API 6.8.

If both disk_storage_overrides and disk_storage are missing or null, 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 missing or null 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 missing or null, 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.

object

disk_storage_overrides

Optional

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.

This property was added in vSphere API 6.8.

If disk_storage_overrides is missing or null and disk_storage is specified, all of the deployed virtual machine's disks are created with the storage spec specified by disk_storage.

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 schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.

placement

Optional

Information used to place the deployed virtual machine.

This property was added in vSphere API 6.8.

This property is currently required. In the future, if this property is missing or null, the system will use the values from the source virtual machine template contained in the library item.

If specified, each property will be used for placement. If the properties result in disjoint placement, the operation will fail. If the properties along with the placement values of the source virtual machine template result in disjoint placement, the operation will fail.

boolean

powered_on

Optional

Specifies whether the deployed virtual machine should be powered on after deployment.

This property was added in vSphere API 6.8.

If missing or null, the virtual machine will not be powered on after deployment.

guest_customization

Optional

Guest customization spec to apply to the deployed virtual machine.

This property was added in vSphere API 6.8.

If missing or null, the guest operating system is not customized after deployment.

hardware_customization

Optional

Hardware customization spec which specifies updates to the deployed virtual machine.

This property was added in vSphere API 6.8.

If missing or null, the deployed virtual machine has the same hardware configuration as the source virtual machine template contained in the library item.

Authentication

This operation uses the following authentication methods.

api_key_auth

Responses

200

Identifier of the deployed virtual machine.

The response will be an identifier for the resource type: VirtualMachine.

Returns string of type(s) application/json

Operation doesn't return any data structure

400

Vapi Std Errors AlreadyExists if a virtual machine with the name specified by Vcenter VmTemplate LibraryItems DeploySpec.name already exists.

Vapi Std Errors InvalidArgument if spec contains invalid arguments.

Vapi Std Errors NotAllowedInCurrentState if either a specified host or a specified datastore is in an invalid state for the deployment, such as maintenance mode.

Returns Vapi Std Errors Error of type(s) application/json

"Vapi Std Errors Error Object"

array of object

messages

Required

Stack of one or more localizable messages for human error consumers.

The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.

Each subsequent message in the stack describes the "cause" of the prior message.

object

data

Optional

Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.

Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.

The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.

Some operations will not set this property when reporting errors.

string

error_type

Required

Discriminator field to help API consumers identify the structure type.

For more information see: Vapi Std Errors Error Type.

This property was added in vSphere API 6.7.2.

Can be missing or null for compatibility with preceding implementations.

401

if the user that requested the operation cannot be authenticated.

Returns Vapi Std Errors Unauthenticated of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors Unauthenticated0

"Vapi Std Errors Unauthenticated Object"

string

challenge

Optional

Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.

For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"

This property was added in vSphere API 7.0.0.0.

This property is optional because it was added in a newer version than its parent node.

403

if the user that requested the operation is not authorized to perform the operation.

Returns Vapi Std Errors Unauthorized of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors Unauthorized0

"Vapi Std Errors Unauthorized Object"

404

if the library item specified by templateLibraryItem cannot be found.

if any resource specified by a property of the Vcenter VmTemplate LibraryItems DeploySpec schema, specified by spec cannot be found.

Returns Vapi Std Errors NotFound of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors NotFound0

"Vapi Std Errors NotFound Object"

500

Vapi Std Errors Error if the system reports an error while responding to the request.

Vapi Std Errors ResourceInaccessible:

if there was an error accessing the source virtual machine template contained in the library item specified by templateLibraryItem.
if there an error accessing any of the resources specified in the spec.

Vapi Std Errors UnableToAllocateResource if there was an error in allocating any of the resources required by the operation.

Returns Vapi Std Errors Error of type(s) application/json

"Vapi Std Errors Error Object"

array of object

messages

Required

Stack of one or more localizable messages for human error consumers.

The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.

Each subsequent message in the stack describes the "cause" of the prior message.

object

data

Optional

Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.

Some operations will not set this property when reporting errors.

string

error_type

Required

Discriminator field to help API consumers identify the structure type.

For more information see: Vapi Std Errors Error Type.

This property was added in vSphere API 6.7.2.

Can be missing or null for compatibility with preceding implementations.

503

if any of the services involved in the operation are unavailable.

Returns Vapi Std Errors ServiceUnavailable of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors ServiceUnavailable0

"Vapi Std Errors ServiceUnavailable Object"

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name:"string"}' https://{api_host}/api/vcenter/vm-template/library-items/{templateLibraryItem}?action=deploy

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Vcenter Vm Template Operations

POST

Vcenter VmTemplate LibraryItems create

POST

Vcenter VmTemplate LibraryItems deploy

GET

Vcenter VmTemplate LibraryItems get