1. Operations
2. vcenter
3. ovf
4. library item

## vcenter ovf library item: deploy

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 `ovf_library_item_id`. It uses the deployment specification in `deployment_spec` to deploy the OVF package to the location specified by `target`.

### Request:

#### HTTP request

POST https://{server}/rest/com/vmware/vcenter/ovf/library-item/id:{ovf_library_item_id}?~action=deploy

#### Path Parameters

Name | Type | Description
--- | --- | ---
Required
ovf_library_item_id | string | Identifier of the content library item containing the OVF package to be deployed.

#### Request Body Structure:

- JSON
- XML

{
"client_token": "string",
"deployment_spec": {
"accept_all_EULA": true,
"additional_parameters": [
{
"@class": "com.vmware.vcenter.ovf.ovf_params",
"type": "string"
},
{
"@class": "com.vmware.vcenter.ovf.ovf_params",
"type": "string"
}
],
"annotation": "string",
"default_datastore_id": "obj-103",
"flags": [
"string",
"string"
],
"locale": "string",
"name": "string",
"network_mappings": [
{
"key": "string",
"value": "obj-103"
}
],
"storage_mappings": [
{
"key": "string",
"value": {
"datastore_id": "obj-103",
"provisioning": "thin",
"storage_profile_id": "obj-103",
"type": "DATASTORE"
}
}
],
"storage_profile_id": "obj-103",
"storage_provisioning": "thin"
},
"target": {
"folder_id": "obj-103",
"host_id": "obj-103",
"resource_pool_id": "obj-103"
}
}
<?xml version="1.0" ?>
<ns0:Deploy-Input xmlns:ns0="http://vmware.com/vcenter/ovf/library_item" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<deployment_spec>
<annotation>string</annotation>
<network_mappings-array>
<array-item>
<value>obj-103</value>
<key>string</key>
</array-item>
</network_mappings-array>
<flags-array>
<array-item>string</array-item>
<array-item>string</array-item>
</flags-array>
<storage_provisioning>thin</storage_provisioning>
<storage_mappings-array>
<array-item>
<value>
<datastore_id>obj-103</datastore_id>
<storage_profile_id>obj-103</storage_profile_id>
<type>DATASTORE</type>
<provisioning>thin</provisioning>
</value>
<key>string</key>
</array-item>
</storage_mappings-array>
<locale>string</locale>
<name>string</name>
<default_datastore_id>obj-103</default_datastore_id>
<additional_parameters-array>
<array-item class="com.vmware.vcenter.ovf.ovf_params">
<type>string</type>
</array-item>
<array-item class="com.vmware.vcenter.ovf.ovf_params">
<type>string</type>
</array-item>
</additional_parameters-array>
<storage_profile_id>obj-103</storage_profile_id>
<accept_all_EULA>true</accept_all_EULA>
</deployment_spec>
<client_token>string</client_token>
<target>
<folder_id>obj-103</folder_id>
<host_id>obj-103</host_id>
<resource_pool_id>obj-103</resource_pool_id>
</target>
</ns0:Deploy-Input>

#### Request Body Parameters:

Name | Type | Description
--- | --- | ---
bold = required
client_token | string | 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.
target | deployment_target | Specification of the deployment target.
target.resource_pool_id | string | Identifier of the resource pool to which the virtual machine or virtual appliance should be attached. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `ResourcePool`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `ResourcePool`.
target.host_id | string | Identifier of the target host on which the virtual machine or virtual appliance will run. The target host must be a member of the cluster that contains the resource pool identified by vcenter.ovf.library_item.deployment_target.resource_pool_id. Optional. If unset, the server will automatically select a target host from the resource pool if vcenter.ovf.library_item.deployment_target.resource_pool_id is a stand-alone host or a cluster with Distributed Resource Scheduling (DRS) enabled.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `HostSystem`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `HostSystem`.
target.folder_id | string | Identifier of the vCenter folder that should contain the virtual machine or virtual appliance. The folder must be virtual machine folder. Optional. If unset, the server will choose the deployment folder.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `Folder`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `Folder`.
deployment_spec | resource_pool_deployment_spec | Specification of how the OVF package should be deployed to the target.
deployment_spec.name | string | Name assigned to the deployed target virtual machine or virtual appliance. Optional. If unset, the server will use the name from the OVF package.
deployment_spec.annotation | string | Annotation assigned to the deployed target virtual machine or virtual appliance. Optional. If unset, the server will use the annotation from the OVF package.
deployment_spec.accept_all_EULA | boolean | Whether to accept all End User License Agreements. See vcenter.ovf.library_item.ovf_summary.EULAs.
deployment_spec.network_mappings | list | Specification of the target network to use for sections of type ovf:NetworkSection in the OVF descriptor. The key in the key/value pairs is the section identifier of the ovf:NetworkSection section in the OVF descriptor and the value is the target network to be used for deployment. Optional. If unset, the server will choose a network mapping.When clients pass a value of this structure as a parameter, the value in the field key/value pairs must be an identifier for the resource type: `Network`. When operations return a value of this structure as a result, the value in the field key/value pairs will be an identifier for the resource type: `Network`.
deployment_spec.network_mappings[].key | string |
deployment_spec.network_mappings[].value | string |
deployment_spec.storage_mappings | list | Specification of the target storage to use for sections of type vmw:StorageGroupSection in the OVF descriptor. The key in the key/value pairs is the section identifier of the ovf:StorageGroupSection section in the OVF descriptor and the value is the target storage specification to be used for deployment. See vcenter.ovf.library_item.storage_group_mapping. Optional. If unset, the server will choose a storage mapping.
deployment_spec.storage_mappings[].key | string |
deployment_spec.storage_mappings[].value | storage_group_mapping |
deployment_spec.storage_mappings[].value.type | string | Type of storage deployment target to use for the vmw:StorageGroupSection section. The specified value must be DATASTORE or STORAGE_PROFILE. Defines the supported types of storage targets for sections of type vmw:StroageGroupSection in the OVF descriptor. Value is one of: DATASTORE: Storage deployment target is a datastore. STORAGE_PROFILE: Storage deployment target is a storage profile.
deployment_spec.storage_mappings[].value.datastore_id | string | Target datastore to be used for the storage group. Optional. It is only relevant when type has value DATASTORE. This field is optional and it is only relevant when the value of `type` is DATASTORE.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `Datastore`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `Datastore`.
deployment_spec.storage_mappings[].value.storage_profile_id | string | Target storage profile to be used for the storage group. Optional. It is only relevant when type has value STORAGE_PROFILE. This field is optional and it is only relevant when the value of `type` is STORAGE_PROFILE.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `StorageProfile`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `StorageProfile`.
deployment_spec.storage_mappings[].value.provisioning | string | Target provisioning type to use for the storage group. Optional. If unset, vcenter.ovf.library_item.resource_pool_deployment_spec.storage_provisioning will be used.
deployment_spec.storage_provisioning | string | Default storage provisioning type to use for all sections of type vmw:StorageSection in the OVF descriptor. Optional. If unset, the server will choose the provisioning type.
deployment_spec.storage_profile_id | string | Default storage profile to use for all sections of type vmw:StorageSection in the OVF descriptor. Optional. If unset, the server will choose the default profile.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `StorageProfile`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `StorageProfile`.
deployment_spec.locale | string | The locale to use for parsing the OVF descriptor. Optional. If unset, the server locale will be used.
deployment_spec.flags | string[] | Flags to be use for deployment. The supported flag values can be obtained using list. Optional. If unset, no flags will be used.
deployment_spec.additional_parameters | object[] | Additional OVF parameters that may be needed for the deployment. Additional OVF parameters may be required by the OVF descriptor of the OVF package in the library item. Examples of OVF parameters that can be specified through this field include, but are not limited to: vcenter.ovf.deployment_option_params vcenter.ovf.extra_config_params vcenter.ovf.ip_allocation_params vcenter.ovf.property_params vcenter.ovf.scale_out_params vcenter.ovf.vcenter_extension_params Optional. If unset, the server will choose default settings for all parameters necessary for the `deploy` operation. See deploy.When clients pass a value of this structure as a parameter, the field must contain all the attributes defined in vcenter.ovf.ovf_params. When operations return a value of this structure as a result, the field will contain all the attributes defined in vcenter.ovf.ovf_params.
deployment_spec.default_datastore_id | string | Default datastore to use for all sections of type vmw:StorageSection in the OVF descriptor. Optional. If unset, the server will choose the default datastore.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `Datastore`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `Datastore`.

### Response:

#### HTTP Status Code: 200

#### Representations:

- JSON
- XML

{
"value": {
"error": {
"errors": [
{
"category": "VALIDATION",
"error": {
"data": {
"@class": "dynamic_structure"
},
"messages": [
{
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
{
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
}
]
},
"issues": [
{
"category": "VALUE_ILLEGAL",
"column_number": 1,
"file": "string",
"line_number": 1,
"message": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
}
},
{
"category": "VALUE_ILLEGAL",
"column_number": 1,
"file": "string",
"line_number": 1,
"message": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
}
}
],
"message": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
"name": "string",
"value": "string"
},
{
"category": "VALIDATION",
"error": {
"data": {
"@class": "dynamic_structure"
},
"messages": [
{
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
{
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
}
]
},
"issues": [
{
"category": "VALUE_ILLEGAL",
"column_number": 1,
"file": "string",
"line_number": 1,
"message": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
}
},
{
"category": "VALUE_ILLEGAL",
"column_number": 1,
"file": "string",
"line_number": 1,
"message": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
}
}
],
"message": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
"name": "string",
"value": "string"
}
],
"information": [
{
"messages": [
{
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
{
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
}
]
},
{
"messages": [
{
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
{
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
}
]
}
],
"warnings": [
{
"category": "VALIDATION",
"error": {
"data": {
"@class": "dynamic_structure"
},
"messages": [
{
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
{
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
}
]
},
"issues": [
{
"category": "VALUE_ILLEGAL",
"column_number": 1,
"file": "string",
"line_number": 1,
"message": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
}
},
{
"category": "VALUE_ILLEGAL",
"column_number": 1,
"file": "string",
"line_number": 1,
"message": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
}
}
],
"message": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
"name": "string",
"value": "string"
},
{
"category": "VALIDATION",
"error": {
"data": {
"@class": "dynamic_structure"
},
"messages": [
{
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
{
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
}
]
},
"issues": [
{
"category": "VALUE_ILLEGAL",
"column_number": 1,
"file": "string",
"line_number": 1,
"message": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
}
},
{
"category": "VALUE_ILLEGAL",
"column_number": 1,
"file": "string",
"line_number": 1,
"message": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
}
}
],
"message": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
"name": "string",
"value": "string"
}
]
},
"resource_id": {
"id": "obj-103",
"type": "string"
},
"succeeded": true
}
}
<?xml version="1.0" ?>
<ns0:Deploy-Result xmlns:ns0="http://vmware.com/vcenter/ovf/library_item" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<value>
<succeeded>true</succeeded>
<resource_id>
<id>obj-103</id>
<type>string</type>
</resource_id>
<error>
<information-array>
<array-item>
<messages-array>
<array-item>
<default_message>string</default_message>
<id>string</id>
<args-array>
<array-item>string</array-item>
<array-item>string</array-item>
</args-array>
</array-item>
<array-item>
<default_message>string</default_message>
<id>string</id>
<args-array>
<array-item>string</array-item>
<array-item>string</array-item>
</args-array>
</array-item>
</messages-array>
</array-item>
<array-item>
<messages-array>
<array-item>
<default_message>string</default_message>
<id>string</id>
<args-array>
<array-item>string</array-item>
<array-item>string</array-item>
</args-array>
</array-item>
<array-item>
<default_message>string</default_message>
<id>string</id>
<args-array>
<array-item>string</array-item>
<array-item>string</array-item>
</args-array>
</array-item>
</messages-array>
</array-item>
</information-array>
<errors-array>
<array-item>
<message>
<default_message>string</default_message>
<id>string</id>
<args-array>
<array-item>string</array-item>
<array-item>string</array-item>
</args-array>
</message>
<category>VALIDATION</category>
<error>
<data class="dynamic_structure">
</data>
<messages-array>
<array-item>
<default_message>string</default_message>
<id>string</id>
<args-array>
<array-item>string</array-item>
<array-item>string</array-item>
</args-array>
</array-item>
<array-item>
<default_message>string</default_message>
<id>string</id>
<args-array>
<array-item>string</array-item>
<array-item>string</array-item>
</args-array>
</array-item>
</messages-array>
</error>
<issues-array>
<array-item>
<message>
<default_message>string</default_message>
<id>string</id>
<args-array>
<array-item>string</array-item>
<array-item>string</array-item>
</args-array>
</message>
<category>VALUE_ILLEGAL</category>
<file>string</file>
<line_number>1</line_number>
<column_number>1</column_number>
</array-item>
<array-item>
<message>
<default_message>string</default_message>
<id>string</id>
<args-array>
<array-item>string</array-item>
<array-item>string</array-item>
</args-array>
</message>
<category>VALUE_ILLEGAL</category>
<file>string</file>
<line_number>1</line_number>
<column_number>1</column_number>
</array-item>
</issues-array>
<name>string</name>
<value>string</value>
</array-item>
<array-item>
<message>
<default_message>string</default_message>
<id>string</id>
<args-array>
<array-item>string</array-item>
<array-item>string</array-item>
</args-array>
</message>
<category>VALIDATION</category>
<error>
<data class="dynamic_structure">
</data>
<messages-array>
<array-item>
<default_message>string</default_message>
<id>string</id>
<args-array>
<array-item>string</array-item>
<array-item>string</array-item>
</args-array>
</array-item>
<array-item>
<default_message>string</default_message>
<id>string</id>
<args-array>
<array-item>string</array-item>
<array-item>string</array-item>
</args-array>
</array-item>
</messages-array>
</error>
<issues-array>
<array-item>
<message>
<default_message>string</default_message>
<id>string</id>
<args-array>
<array-item>string</array-item>
<array-item>string</array-item>
</args-array>
</message>
<category>VALUE_ILLEGAL</category>
<file>string</file>
<line_number>1</line_number>
<column_number>1</column_number>
</array-item>
<array-item>
<message>
<default_message>string</default_message>
<id>string</id>
<args-array>
<array-item>string</array-item>
<array-item>string</array-item>
</args-array>
</message>
<category>VALUE_ILLEGAL</category>
<file>string</file>
<line_number>1</line_number>
<column_number>1</column_number>
</array-item>
</issues-array>
<name>string</name>
<value>string</value>
</array-item>
</errors-array>
<warnings-array>
<array-item>
<message>
<default_message>string</default_message>
<id>string</id>
<args-array>
<array-item>string</array-item>
<array-item>string</array-item>
</args-array>
</message>
<category>VALIDATION</category>
<error>
<data class="dynamic_structure">
</data>
<messages-array>
<array-item>
<default_message>string</default_message>
<id>string</id>
<args-array>
<array-item>string</array-item>
<array-item>string</array-item>
</args-array>
</array-item>
<array-item>
<default_message>string</default_message>
<id>string</id>
<args-array>
<array-item>string</array-item>
<array-item>string</array-item>
</args-array>
</array-item>
</messages-array>
</error>
<issues-array>
<array-item>
<message>
<default_message>string</default_message>
<id>string</id>
<args-array>
<array-item>string</array-item>
<array-item>string</array-item>
</args-array>
</message>
<category>VALUE_ILLEGAL</category>
<file>string</file>
<line_number>1</line_number>
<column_number>1</column_number>
</array-item>
<array-item>
<message>
<default_message>string</default_message>
<id>string</id>
<args-array>
<array-item>string</array-item>
<array-item>string</array-item>
</args-array>
</message>
<category>VALUE_ILLEGAL</category>
<file>string</file>
<line_number>1</line_number>
<column_number>1</column_number>
</array-item>
</issues-array>
<name>string</name>
<value>string</value>
</array-item>
<array-item>
<message>
<default_message>string</default_message>
<id>string</id>
<args-array>
<array-item>string</array-item>
<array-item>string</array-item>
</args-array>
</message>
<category>VALIDATION</category>
<error>
<data class="dynamic_structure">
</data>
<messages-array>
<array-item>
<default_message>string</default_message>
<id>string</id>
<args-array>
<array-item>string</array-item>
<array-item>string</array-item>
</args-array>
</array-item>
<array-item>
<default_message>string</default_message>
<id>string</id>
<args-array>
<array-item>string</array-item>
<array-item>string</array-item>
</args-array>
</array-item>
</messages-array>
</error>
<issues-array>
<array-item>
<message>
<default_message>string</default_message>
<id>string</id>
<args-array>
<array-item>string</array-item>
<array-item>string</array-item>
</args-array>
</message>
<category>VALUE_ILLEGAL</category>
<file>string</file>
<line_number>1</line_number>
<column_number>1</column_number>
</array-item>
<array-item>
<message>
<default_message>string</default_message>
<id>string</id>
<args-array>
<array-item>string</array-item>
<array-item>string</array-item>
</args-array>
</message>
<category>VALUE_ILLEGAL</category>
<file>string</file>
<line_number>1</line_number>
<column_number>1</column_number>
</array-item>
</issues-array>
<name>string</name>
<value>string</value>
</array-item>
</warnings-array>
</error>
</value>
</ns0:Deploy-Result>

#### Response Type:

Name | Type | Description
--- | --- | ---
bold = required
value | deployment_result | Information about the success or failure of the operation, along with the details of the result or failure.
value.succeeded | boolean | Whether the `deploy` operation completed successfully.
value.resource_id | deployable_identity | Identifier of the deployed resource entity. Optional. If unset, the `deploy` operation failed and vcenter.ovf.library_item.deployment_result.error will describe the error(s) that caused the failure.
value.resource_id.type | string | Type of the deployable resource. When clients pass a value of this structure as a parameter, the field must be one of `VirtualMachine` or `VirtualApp`. When operations return a value of this structure as a result, the field will be one of `VirtualMachine` or `VirtualApp`.
value.resource_id.id | string | Identifier of the deployable resource. When clients pass a value of this structure as a parameter, the field `type` must contain the actual resource type. When operations return a value of this structure as a result, the field `type` will contain the actual resource type.
value.error | result_info | Errors, warnings, and informational messages produced by the `deploy` operation. Optional. If unset, no errors, warnings, or informational messages were reported by the `deploy` operation.
value.error.errors | ovf_error[] | Errors reported by the `create` or `deploy` operation. These errors would have prevented the `create` or `deploy` operation from completing successfully.
value.error.errors[].category | string | The message category. Defines the categories of messages (see vcenter.ovf.ovf_message). Value is one of: VALIDATION: The OVF descriptor is invalid, for example, syntax errors or schema errors. INPUT: The user provided input parameters are invalid. SERVER: Server error.
value.error.errors[].issues | parse_issue[] | Array of parse issues (see vcenter.ovf.parse_issue). Optional. It is only relevant when category has value VALIDATION. This field is optional and it is only relevant when the value of `category` is VALIDATION.
value.error.errors[].issues[].category | string | The category of the parse issue. Defines the categories of issues that can be found when parsing files inside an OVF package (see vcenter.ovf.parse_issue) including OVF descriptor (which is an XML document), manifest and certificate files, or exporting an OVF package. Value is one of: VALUE_ILLEGAL: Illegal value error. For example, the value is malformed, not a number, or outside of the given range, and so on. ATTRIBUTE_REQUIRED: Required attribute error. It indicates that a required attribute is missing from an element in the OVF descriptor. ATTRIBUTE_ILLEGAL: Illegal attribute error. It indicates that an illegal attribute is set for an element in the OVF descriptor. For example, empty disks do not use format, parentRef, and populatedSize attributes, if these attributes are present in an empty disk element then will get this pasrse issue. ELEMENT_REQUIRED: Required element error. It indicates that a required element is missing from the OVF descriptor. ELEMENT_ILLEGAL: Illegal element error. It indicates that an element is present in a location which is not allowed, or found multiple elements but only one is allowed at the location in the OVF descriptor. ELEMENT_UNKNOWN: Unknown element error. It indicates that an element is unsupported when parsing an OVF descriptor. SECTION_UNKNOWN: Section unknown error. It indicates that a section is unsupported when parsing an OVF descriptor. SECTION_RESTRICTION: Section restriction error. It indicates that a section appears in place in the OVF descriptor where it is not allowed, a section appears fewer times than is required, or a section appears more times than is allowed. PARSE_ERROR: OVF package parsing error, including: OVF descriptor parsing errors, for example, syntax errors or schema errors. Manifest file parsing and verification errors. Certificate file parsing and verification errors. GENERATE_ERROR: OVF descriptor (which is an XML document) generating error, for example, well-formedness errors as well as unexpected processing conditions. VALIDATION_ERROR: An issue with the manifest and signing. EXPORT_ERROR: Issue during OVF export, for example, malformed deviceId, controller not found, or file backing for a device not found. INTERNAL_ERROR: Server encountered an unexpected error which prevented it from fulfilling the request.
value.error.errors[].issues[].file | string | The name of the file in which the parse issue was found.
value.error.errors[].issues[].line_number | long | The line number of the line in the file (see vcenter.ovf.parse_issue.file) where the parse issue was found (or -1 if not applicable).
value.error.errors[].issues[].column_number | long | The position in the line (see vcenter.ovf.parse_issue.line_number) (or -1 if not applicable).
value.error.errors[].issues[].message | localizable_message | A localizable message describing the parse issue.
value.error.errors[].issues[].message.id | string | Unique identifier of the localizable string or message template. This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.
value.error.errors[].issues[].message.default_message | string | The value of this localizable string or message template in the `en_US` (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.
value.error.errors[].issues[].message.args | string[] | Arguments to be substituted into a message template.
value.error.errors[].name | string | The name of input parameter. Optional. It is only relevant when category has value INPUT. This field is optional and it is only relevant when the value of `category` is INPUT.
value.error.errors[].value | string | The value of input parameter. Optional. It is only relevant when category has value INPUT. This field is optional and it is only relevant when the value of `category` is INPUT.
value.error.errors[].message | localizable_message | A localizable message. Optional. It is only relevant when category has value INPUT. This field is optional and it is only relevant when the value of `category` is INPUT.
value.error.errors[].message.id | string | Unique identifier of the localizable string or message template. This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.
value.error.errors[].message.default_message | string | The value of this localizable string or message template in the `en_US` (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.
value.error.errors[].message.args | string[] | Arguments to be substituted into a message template.
value.error.errors[].error | object | Represents a server vapi.std.errors.error. Optional. It is only relevant when category has value SERVER. This field is optional and it is only relevant when the value of `category` is SERVER.When clients pass a value of this structure as a parameter, the field must contain all the attributes defined in vapi.std.errors.error. When operations return a value of this structure as a result, the field will contain all the attributes defined in vapi.std.errors.error.
value.error.warnings | ovf_warning[] | Warnings reported by the `create` or `deploy` operation. These warnings would not have prevented the `create` or `deploy` operation from completing successfully, but there might be issues that warrant attention.
value.error.warnings[].category | string | The message category. Defines the categories of messages (see vcenter.ovf.ovf_message). Value is one of: VALIDATION: The OVF descriptor is invalid, for example, syntax errors or schema errors. INPUT: The user provided input parameters are invalid. SERVER: Server error.
value.error.warnings[].issues | parse_issue[] | Array of parse issues (see vcenter.ovf.parse_issue). Optional. It is only relevant when category has value VALIDATION. This field is optional and it is only relevant when the value of `category` is VALIDATION.
value.error.warnings[].issues[].category | string | The category of the parse issue. Defines the categories of issues that can be found when parsing files inside an OVF package (see vcenter.ovf.parse_issue) including OVF descriptor (which is an XML document), manifest and certificate files, or exporting an OVF package. Value is one of: VALUE_ILLEGAL: Illegal value error. For example, the value is malformed, not a number, or outside of the given range, and so on. ATTRIBUTE_REQUIRED: Required attribute error. It indicates that a required attribute is missing from an element in the OVF descriptor. ATTRIBUTE_ILLEGAL: Illegal attribute error. It indicates that an illegal attribute is set for an element in the OVF descriptor. For example, empty disks do not use format, parentRef, and populatedSize attributes, if these attributes are present in an empty disk element then will get this pasrse issue. ELEMENT_REQUIRED: Required element error. It indicates that a required element is missing from the OVF descriptor. ELEMENT_ILLEGAL: Illegal element error. It indicates that an element is present in a location which is not allowed, or found multiple elements but only one is allowed at the location in the OVF descriptor. ELEMENT_UNKNOWN: Unknown element error. It indicates that an element is unsupported when parsing an OVF descriptor. SECTION_UNKNOWN: Section unknown error. It indicates that a section is unsupported when parsing an OVF descriptor. SECTION_RESTRICTION: Section restriction error. It indicates that a section appears in place in the OVF descriptor where it is not allowed, a section appears fewer times than is required, or a section appears more times than is allowed. PARSE_ERROR: OVF package parsing error, including: OVF descriptor parsing errors, for example, syntax errors or schema errors. Manifest file parsing and verification errors. Certificate file parsing and verification errors. GENERATE_ERROR: OVF descriptor (which is an XML document) generating error, for example, well-formedness errors as well as unexpected processing conditions. VALIDATION_ERROR: An issue with the manifest and signing. EXPORT_ERROR: Issue during OVF export, for example, malformed deviceId, controller not found, or file backing for a device not found. INTERNAL_ERROR: Server encountered an unexpected error which prevented it from fulfilling the request.
value.error.warnings[].issues[].file | string | The name of the file in which the parse issue was found.
value.error.warnings[].issues[].line_number | long | The line number of the line in the file (see vcenter.ovf.parse_issue.file) where the parse issue was found (or -1 if not applicable).
value.error.warnings[].issues[].column_number | long | The position in the line (see vcenter.ovf.parse_issue.line_number) (or -1 if not applicable).
value.error.warnings[].issues[].message | localizable_message | A localizable message describing the parse issue.
value.error.warnings[].issues[].message.id | string | Unique identifier of the localizable string or message template. This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.
value.error.warnings[].issues[].message.default_message | string | The value of this localizable string or message template in the `en_US` (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.
value.error.warnings[].issues[].message.args | string[] | Arguments to be substituted into a message template.
value.error.warnings[].name | string | The name of input parameter. Optional. It is only relevant when category has value INPUT. This field is optional and it is only relevant when the value of `category` is INPUT.
value.error.warnings[].value | string | The value of input parameter. Optional. It is only relevant when category has value INPUT. This field is optional and it is only relevant when the value of `category` is INPUT.
value.error.warnings[].message | localizable_message | A localizable message. Optional. It is only relevant when category has value INPUT. This field is optional and it is only relevant when the value of `category` is INPUT.
value.error.warnings[].message.id | string | Unique identifier of the localizable string or message template. This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.
value.error.warnings[].message.default_message | string | The value of this localizable string or message template in the `en_US` (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.
value.error.warnings[].message.args | string[] | Arguments to be substituted into a message template.
value.error.warnings[].error | object | Represents a server vapi.std.errors.error. Optional. It is only relevant when category has value SERVER. This field is optional and it is only relevant when the value of `category` is SERVER.When clients pass a value of this structure as a parameter, the field must contain all the attributes defined in vapi.std.errors.error. When operations return a value of this structure as a result, the field will contain all the attributes defined in vapi.std.errors.error.
value.error.information | ovf_info[] | Information messages reported by the `create` or `deploy` operation. For example, a non-required parameter was ignored.
value.error.information[].messages | localizable_message[] | A array of localizable messages (see vapi.std.localizable_message).
value.error.information[].messages[].id | string | Unique identifier of the localizable string or message template. This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.
value.error.information[].messages[].default_message | string | The value of this localizable string or message template in the `en_US` (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.
value.error.information[].messages[].args | string[] | Arguments to be substituted into a message template.

#### Errors:

HTTP Status Code | Type | Description
--- | --- | ---
400 | invalid_argument | if `target` contains invalid arguments.
404 | not_found | if the library item specified by `ovf_library_item_id` does not exist.
400 | resource_inaccessible | if there was an error accessing the OVF package stored in the library item specified by `ovf_library_item_id`.
403 | 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.