Deploy Library Items
If vSphere APIs begin with /rest (vs /api), any maps are consumed/returned instead as arrays of objects, each containing a key and a value property field.
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 LibraryItems.DeploySpec.powered-on and/or LibraryItems.DeploySpec.guest-customization are specified, the server triggers the power on and/or guest customization operations, which are executed asynchronously. 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 attribute LibraryItems.DeploySpecVmHomeStorage.datastore requires System.Read. - The resource com.vmware.spbm.StorageProfile referenced by the attribute LibraryItems.DeploySpecVmHomeStoragePolicy.policy requires System.Read. - The resource Datastore referenced by the attribute LibraryItems.DeploySpecDiskStorage.datastore requires System.Read. - The resource com.vmware.spbm.StorageProfile referenced by the attribute LibraryItems.DeploySpecDiskStoragePolicy.policy requires System.Read. - The resource com.vmware.vcenter.vm.hardware.Disk referenced by the map key of attribute LibraryItems.DeploySpec.disk-storage-overrides requires System.Read. - The resource Folder referenced by the attribute LibraryItems.DeployPlacementSpec.folder requires System.Read. - The resource ResourcePool referenced by the attribute LibraryItems.DeployPlacementSpec.resource-pool requires System.Read. - The resource HostSystem referenced by the attribute LibraryItems.DeployPlacementSpec.host requires System.Read. - The resource ClusterComputeResource referenced by the attribute LibraryItems.DeployPlacementSpec.cluster requires System.Read. - The resource com.vmware.vcenter.vm.hardware.Ethernet referenced by the map key of attribute LibraryItems.HardwareCustomizationSpec.nics requires System.Read. - The resource Network referenced by the attribute LibraryItems.EthernetUpdateSpec.network requires System.Read. - The resource com.vmware.vcenter.vm.hardware.Disk referenced by the attribute LibraryItems.HardwareCustomizationSpec.disks-to-remove requires System.Read. - The resource com.vmware.vcenter.vm.hardware.Disk referenced by the map key of attribute LibraryItems.HardwareCustomizationSpec.disks-to-update requires System.Read.
Request
URLURL
https://{api_host}/rest/vcenter/vm-template/library-items/{template_library_item}?action=deploy
Parameters
Parameters
string
template_library_item
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.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
Example: b00db39f948d13ea1e59b4d6fce56389
Request Body
Request Body
VmTemplateLibraryItemsDeployRequestBody of type application/json (required){
"spec": {
"name": "string",
"placement": {
"folder": "string"
}
}
}
spec
Required
specification of how the virtual machine should be deployed.
Response
Response
Response BodyResponse Body
200 OK returns
VmTemplateLibraryItemsDeployResponseBody
of type application/json
Identifier of the deployed virtual machine. The result will be an identifier for the resource type: VirtualMachine.
{
"value": "string"
}
string
value
Optional
Identifier of the deployed virtual machine. The result will be an identifier for the resource type: VirtualMachine.
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"spec":{"description":"string","disk_storage":{"datastore":"string","storage_policy":{"policy":"string","type":"enum"}},"disk_storage_overrides":{"key":{"datastore":"string","storage_policy":{"policy":"string","type":"enum"}}},"guest_customization":{"name":"string"},"hardware_customization":{"cpu_update":{"num_cores_per_socket":0,"num_cpus":0},"disks_to_remove":["string"],"disks_to_update":{"key":{"capacity":0}},"memory_update":{"memory":0},"nics":{"key":{"network":"string"}}},"name":"string","placement":{"cluster":"string","folder":"string","host":"string","resource_pool":"string"},"powered_on":false,"vm_home_storage":{"datastore":"string","storage_policy":{"policy":"string","type":"enum"}}}}' https://{api_host}/rest/vcenter/vm-template/library-items/{template_library_item}?action=deploy
Errors
401
com.vmware.vapi.std.errors.unauthenticated : if the user that requested the operation cannot be authenticated. | com.vmware.vapi.std.errors.unauthorized : if the user that requested the operation is not authorized to perform the operation.
404
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request. | com.vmware.vapi.std.errors.not_found : if the library item specified by templateLibraryItem cannot be found.
if any resource specified by a field of the LibraryItems.DeploySpec structure, specified by spec cannot be found. | com.vmware.vapi.std.errors.resource_inaccessible : 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.
409
com.vmware.vapi.std.errors.already_exists : if a virtual machine with the name specified by LibraryItems.DeploySpec.name already exists. | com.vmware.vapi.std.errors.not_allowed_in_current_state : if either a specified host or a specified datastore is in an invalid state for the deployment, such as maintenance mode.
503
com.vmware.vapi.std.errors.service_unavailable : if any of the services involved in the operation are unavailable.
507
com.vmware.vapi.std.errors.unable_to_allocate_resource : if there was an error in allocating any of the resources required by the operation.
