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

vcenter ovf library item: create

Creates a library item in content library from a virtual machine or virtual appliance.

This operation creates a library item in content library whose content is an OVF package derived from a source virtual machine or virtual appliance, using the supplied create specification. The OVF package may be stored as in a newly created library item or in an in an existing library item. For an existing library item whose content is updated by this operation, the original content is overwritten.

Request:

HTTP request

POST https://{server}/rest/com/vmware/vcenter/ovf/library-item

Request Body Structure:

{
    "client_token": "string",
    "create_spec": {
        "description": "string",
        "flags": [
            "string",
            "string"
        ],
        "name": "string"
    },
    "source": {
        "id": "obj-103",
        "type": "string"
    },
    "target": {
        "library_id": "obj-103",
        "library_item_id": "obj-103"
    }
}
<?xml version="1.0" ?>
<ns0:Create-Input xmlns:ns0="http://vmware.com/vcenter/ovf/library_item" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <create_spec>
    <flags-array>
      <array-item>string</array-item>
      <array-item>string</array-item>
    </flags-array>
    <description>string</description>
    <name>string</name>
  </create_spec>
  <source>
    <id>obj-103</id>
    <type>string</type>
  </source>
  <client_token>string</client_token>
  <target>
    <library_id>obj-103</library_id>
    <library_item_id>obj-103</library_item_id>
  </target>
</ns0:Create-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.
source deployable_identity Identifier of the virtual machine or virtual appliance to use as the source.
source.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.
source.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.
target create_target Specification of the target content library and library item.
target.library_id string Identifier of the library in which a new library item should be created. This field is not used if the library_item_id field is specified.

Optional. If unset, the library_item_id field must be specified.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.content.Library. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.content.Library.
target.library_item_id string Identifier of the library item that should be should be updated.

Optional. If unset, a new library item will be created. The library_id field must be specified if this field is unset.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.content.library.Item. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.content.library.Item.
create_spec create_spec Information used to create the OVF package from the source virtual machine or virtual appliance.
create_spec.name string Name to use in the OVF descriptor stored in the library item.

Optional. If unset, the server will use source's current name.
create_spec.description string Description to use in the OVF descriptor stored in the library item.

Optional. If unset, the server will use source's current annotation.
create_spec.flags string[] Flags to use for OVF package creation. The supported flags can be obtained using list.

Optional. If unset, no flags will be used.

Response:

HTTP Status Code: 200

Representations:

{
    "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"
                }
            ]
        },
        "ovf_library_item_id": "obj-103",
        "succeeded": true
    }
}
<?xml version="1.0" ?>
<ns0:Create-Result xmlns:ns0="http://vmware.com/vcenter/ovf/library_item" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <value>
    <succeeded>true</succeeded>
    <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>
    <ovf_library_item_id>obj-103</ovf_library_item_id>
  </value>
</ns0:Create-Result>

Response Type:

Name Type Description
bold = required
value create_result Information about the success or failure of the operation, along with the details of the result or failure.
value.succeeded boolean Whether the create operation completed successfully.
value.ovf_library_item_id string Identifier of the created or updated library item.

Optional. If unset, the create operation failed and vcenter.ovf.library_item.create_result.error will describe the error(s) that caused the failure.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.content.library.Item. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.content.library.Item.
value.error result_info Errors, warnings, and informational messages produced by the create operation.

Optional. If unset, no errors, warnings, or informational messages were reported by the create 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 create_spec contains invalid arguments.
404 not_found if the virtual machine or virtual appliance specified by source does not exist.
400 not_allowed_in_current_state if the operation cannot be performed because of the specified virtual machine or virtual appliance's current state. For example, if the virtual machine configuration information is not available, or if the virtual appliance is running.
400 resource_inaccessible if there was an error accessing a file from the source virtual machine or virtual appliance.
400 resource_busy if the specified virtual machine or virtual appliance is busy.