This API has a deprecated equivalent from v7.0U1.
Deploy Library Item
Deploys an OVF package stored in content library to a newly created virtual machine or virtual appliance. This operation deploys an OVF package which is stored in the library item specified by ovfLibraryItemId. It uses the deployment specification in deploymentSpec to deploy the OVF package to the location specified by target.
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 ovfLibraryItemId requires System.Read. - The resource HostSystem referenced by the attribute LibraryItem.DeploymentTarget.host-id requires System.Read. - The resource Network referenced by the map value of attribute LibraryItem.ResourcePoolDeploymentSpec.network-mappings requires System.Read. - The resource StorageProfile referenced by the attribute LibraryItem.ResourcePoolDeploymentSpec.storage-profile-id requires System.Read. - The resource Datastore referenced by the attribute LibraryItem.ResourcePoolDeploymentSpec.default-datastore-id requires System.Read. - The resource ResourcePool referenced by the attribute LibraryItem.DeploymentTarget.resource-pool-id requires VApp.Import. - The resource Folder referenced by the attribute LibraryItem.DeploymentTarget.folder-id requires VApp.Import.
Request
URLURL
https://{api_host}/api/vcenter/ovf/library-item/{ovf_library_item_id}?action=deploy
Path Parameters
Path Parameters
string
ovf_library_item_id
Required
Identifier of the content library item containing the OVF package to be deployed. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.
Header Parameters
Header Parameters
string
client_token
Optional
Client-generated token used to retry a request if the client fails to get a response from the server. If the original request succeeded, the result of that request will be returned, otherwise the operation will be retried. If unset, the server will create a token.
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
OvfLibraryItemDeployRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"deployment_spec": {
"accept_all_EULA": false
},
"target": {
"resource_pool_id": "string"
}
}
deployment_spec
Required
Specification of how the OVF package should be deployed to the target.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
OvfLibraryItemDeploymentResult
of type application/json
Information about the success or failure of the operation, along with the details of the result or failure.
{
"error": {
"errors": [
{
"category": "VALIDATION",
"error": {},
"issues": [
{
"category": "VALUE_ILLEGAL",
"column_number": 0,
"file": "string",
"line_number": 0,
"message": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
}
}
],
"message": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"name": "string",
"value": "string"
}
],
"information": [
{
"messages": [
{
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
}
]
}
],
"warnings": [
{
"category": "VALIDATION",
"error": {},
"issues": [
{
"category": "VALUE_ILLEGAL",
"column_number": 0,
"file": "string",
"line_number": 0,
"message": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
}
}
],
"message": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"name": "string",
"value": "string"
}
]
},
"resource_id": {
"id": "string",
"type": "string"
},
"succeeded": false
}
boolean
succeeded
Required
Whether the LibraryItem.deploy operation completed successfully.
error
Optional
Errors, warnings, and informational messages produced by the LibraryItem.deploy operation. If unset, no errors, warnings, or informational messages were reported by the LibraryItem.deploy operation.
resource_id
Optional
Identifier of the deployed resource entity. If unset, the LibraryItem.deploy operation failed and LibraryItem.DeploymentResult.error will describe the error(s) that caused the failure.
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if target contains invalid arguments. if deploymentSpec contains invalid arguments or has fields that are inconsistent with target.
403
com.vmware.vapi.std.errors.unauthorized : if you do not have all of the privileges described as follows : - Operation execution requires VirtualMachine.Config.AddNewDisk if the OVF descriptor has a disk drive (type 17) section. - Operation execution requires VirtualMachine.Config.AdvancedConfig if the OVF descriptor has an ExtraConfig section. - Operation execution requires Extension.Register for specified resource group if the OVF descriptor has a vServiceDependency section. - Operation execution requires Network.Assign for target network if specified. - Operation execution requires Datastore.AllocateSpace for target datastore if specified.
404
com.vmware.vapi.std.errors.not_found : if the library item specified by ovfLibraryItemId does not exist. if any resource specified by a field of the LibraryItem.DeploymentTarget structure, specified by target, does not exist.
500
com.vmware.vapi.std.errors.resource_inaccessible : if there was an error accessing the OVF package stored in the library item specified by ovfLibraryItemId.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
$OvfLibraryItemDeploymentTarget = Initialize-OvfLibraryItemDeploymentTarget -ResourcePoolId "MyResourcePoolId"
$OvfLibraryItemResourcePoolDeploymentSpec = Initialize-OvfLibraryItemResourcePoolDeploymentSpec -AcceptAllEULA $false
$OvfLibraryItemDeployRequestBody = Initialize-OvfLibraryItemDeployRequestBody -Target $OvfLibraryItemDeploymentTarget -DeploymentSpec $OvfLibraryItemResourcePoolDeploymentSpec
Invoke-DeployOvfLibraryItemId -OvfLibraryItemId "MyOvfLibraryItemId" -OvfLibraryItemDeployRequestBody $OvfLibraryItemDeployRequestBody
PowerCLI Client SDK All Parameters Example
$OvfLibraryItemDeploymentTarget = Initialize-OvfLibraryItemDeploymentTarget -ResourcePoolId "MyResourcePoolId" -HostId "MyHostId" -FolderId "MyFolderId"
$OvfLibraryItemStorageGroupMapping = Initialize-OvfLibraryItemStorageGroupMapping -Type "DATASTORE" -DatastoreId "MyDatastoreId" -StorageProfileId "MyStorageProfileId" -Provisioning "thin"
$OvfLibraryItemResourcePoolDeploymentSpec = Initialize-OvfLibraryItemResourcePoolDeploymentSpec -Name "MyName" -Annotation "MyAnnotation" -AcceptAllEULA $false -NetworkMappings @{ key_example = "MyInner" } -StorageMappings @{ key_example = $OvfLibraryItemStorageGroupMapping } -StorageProvisioning "thin" -StorageProfileId "MyStorageProfileId" -Locale "MyLocale" -Flags "MyFlags" -AdditionalParameters -DefaultDatastoreId "MyDefaultDatastoreId"
$OvfLibraryItemDeployRequestBody = Initialize-OvfLibraryItemDeployRequestBody -Target $OvfLibraryItemDeploymentTarget -DeploymentSpec $OvfLibraryItemResourcePoolDeploymentSpec
Invoke-DeployOvfLibraryItemId -OvfLibraryItemId "MyOvfLibraryItemId" -OvfLibraryItemDeployRequestBody $OvfLibraryItemDeployRequestBody -ClientToken "MyClientToken"
cURL Command
curl -X POST -H "client_token: string" -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"deployment_spec":{"accept_all_EULA":false,"additional_parameters":{},"annotation":"string","default_datastore_id":"string","flags":["string"],"locale":"string","name":"string","network_mappings":{"key":"string"},"storage_mappings":{"key":{"datastore_id":"string","provisioning":"thin","storage_profile_id":"string","type":"DATASTORE"}},"storage_profile_id":"string","storage_provisioning":"thin"},"target":{"folder_id":"string","host_id":"string","resource_pool_id":"string"}}' https://{api_host}/api/vcenter/ovf/library-item/{ovf_library_item_id}?action=deploy
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/com/vmware/vcenter/ovf/library-item/id:{ovf_library_item_id}?~action=deploy
x-vmw-doc-operation: deploy
Availability
Added in 7.0U2
