Ovf Manager Parse Descriptor

Ovf Manager Parse Descriptor

Parse the OVF descriptor and return as much information about it as possible without knowing the host on which it will be imported.

Typically, this method is called once without a deploymentOption parameter to obtain the values for the default deployment option. Part of the result is the list of possible deployment options. To obtain the values for a particular deployment option, call this method again, specifying that option.

Required privileges: System.View

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/OvfManager/{moId}/ParseDescriptor
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case OvfManager/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.


Request Body
ParseDescriptorRequestType of type(s) application/json
Required
{
    "ovfDescriptor": "string",
    "pdp": {
        "_typeName": "string",
        "locale": "string",
        "deploymentOption": "string",
        "msgBundle": [
            {
                "_typeName": "string",
                "key": "string",
                "value": "string"
            }
        ],
        "importOption": [
            "string"
        ]
    }
}
string
ovfDescriptor
Required

The OVF descriptor to examine.

pdp
Required

Additional parameters for parseDescriptor, wrapped in an instance of ParseDescriptorParams.

Authentication
This operation uses the following authentication methods.
Responses
200

The information about the descriptor

Returns OvfParseDescriptorResult of type(s) application/json
This response body class contains all of the following: DataObject
{
    "_typeName": "string",
    "eula": [
        "string"
    ],
    "network": [
        {
            "_typeName": "string",
            "name": "string",
            "description": "string"
        }
    ],
    "ipAllocationScheme": [
        "string"
    ],
    "ipProtocols": [
        "string"
    ],
    "property": [
        {
            "_typeName": "string",
            "key": 0,
            "classId": "string",
            "instanceId": "string",
            "id": "string",
            "category": "string",
            "label": "string",
            "type": "string",
            "typeReference": "string",
            "userConfigurable": false,
            "defaultValue": "string",
            "value": "string",
            "description": "string"
        }
    ],
    "productInfo": {
        "_typeName": "string",
        "key": 0,
        "classId": "string",
        "instanceId": "string",
        "name": "string",
        "vendor": "string",
        "version": "string",
        "fullVersion": "string",
        "vendorUrl": "string",
        "productUrl": "string",
        "appUrl": "string"
    },
    "annotation": "string",
    "approximateDownloadSize": 0,
    "approximateFlatDeploymentSize": 0,
    "approximateSparseDeploymentSize": 0,
    "defaultEntityName": "string",
    "virtualApp": false,
    "deploymentOption": [
        {
            "_typeName": "string",
            "key": "string",
            "label": "string",
            "description": "string"
        }
    ],
    "defaultDeploymentOption": "string",
    "entityName": [
        {
            "_typeName": "string",
            "key": "string",
            "value": "string"
        }
    ],
    "annotatedOst": {
        "_typeName": "string",
        "id": "string",
        "type": "string",
        "section": [
            {
                "_typeName": "string",
                "lineNumber": 0,
                "xml": "string"
            }
        ],
        "child": [
            "OvfConsumerOstNode Object"
        ],
        "entity": {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        }
    },
    "error": [
        {
            "_typeName": "string",
            "faultCause": "MethodFault Object",
            "faultMessage": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "arg": [
                        {
                            "_typeName": "string",
                            "key": "string",
                            "value": {
                                "_typeName": "string"
                            }
                        }
                    ],
                    "message": "string"
                }
            ]
        }
    ],
    "warning": [
        {
            "_typeName": "string",
            "faultCause": "MethodFault Object",
            "faultMessage": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "arg": [
                        {
                            "_typeName": "string",
                            "key": "string",
                            "value": {
                                "_typeName": "string"
                            }
                        }
                    ],
                    "message": "string"
                }
            ]
        }
    ]
}
array of string
eula
Optional

The list of all EULAs contained in the OVF

network
Optional

The list of networks required by the OVF

array of string
ipAllocationScheme
Optional

The kind of IP allocation supported by the guest.

See VAppIPAssignmentInfo.

array of string
ipProtocols
Optional

The IP protocols supported by the guest.

See VAppIPAssignmentInfo.

property
Optional

Metadata about the properties contained in the OVF

productInfo
Optional

Information that describes what product a vApp contains, for example, the software that is installed in the contained virtual machines.

string
annotation
Required

The annotation info contained in the OVF

integer As int64 As int64
approximateDownloadSize
Optional

The OVF Manager's best guess as to the total amount of data that must be transferred to download the entity.

This may be inaccurate due to disk compression etc.

integer As int64 As int64
approximateFlatDeploymentSize
Optional

The OVF Manager's best guess as to the total amount of space required to deploy the entity if using flat disks.

integer As int64 As int64
approximateSparseDeploymentSize
Optional

The OVF Manager's best guess as to the total amount of space required to deploy the entity using sparse disks.

string
defaultEntityName
Required

The default name to use for the entity, if a product name is not specified.

This is the ID of the OVF top-level entity, or taken from a ProductSection.

boolean
virtualApp
Required

True if the OVF contains a vApp (containing one or more vApps and/or virtual machines), as opposed to a single virtual machine.

deploymentOption
Optional

The list of possible deployment options.

string
defaultDeploymentOption
Required

The key of the default deployment option.

Empty only if there are no deployment options.

array of KeyValue
entityName
Optional

A list of the child entities contained in this package and their location in the vApp hierarchy.

Each entry is a (key,value) pair, where the key is the display name, and the value is a unique path identifier for the entity in the vApp. The path is constructed by appending the id of each entity of the path down to the entity, separated by slashes. For example, the path for a child of the root entity with id = "vm1", would simply be "vm1". If the vm is the child of a VirtualSystemCollection called "webTier", then the path would be "webTier/vm".

annotatedOst
Optional

A node in the OVF section tree.

This class represents a node on which OVF sections can be defined. The possible node types are OstNodeType.envelope, OstNodeType.virtualSystem or OstNodeType.virtualSystemCollection, corresponding to the identically named OVF element types.

Since the node contains a list of children, it can also be regarded as a tree. This tree mirrors the structure of the OVF descriptor. It is provided to OVF consumers as a more convenient way to navigate and modify the OVF than by working directly on the XML.

error
Optional

Errors that happened during processing.

Something will be wrong with the result.

For example, during export, devices could be missing (in which case this array will contain one or more instances of Unsupported-/UnknownDevice).

warning
Optional

Non-fatal warnings from the processing.

The result will be valid, but the user may choose to reject it based on these warnings.


500

TaskInProgress: if a required managed entity is busy.

VmConfigFault: if a configuration issue prevents the operation from succeeding. Typically, a more specific subclass is thrown.

ConcurrentAccess: if a concurrency issue prevents the operation from succeeding.

FileFault: if there is a generic file error

InvalidState: if the operation failed due to the current state of the system.

Returns VimFault of type(s) application/json
This response body class contains all of the following: MethodFault
{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}