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
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}.
The vSphere release schema. The current specification covers vSphere 9.0.0.0 APIs.
"ParseDescriptorRequestType Object"The OVF descriptor to examine.
Additional parameters for parseDescriptor, wrapped in an instance of ParseDescriptorParams.
The information about the descriptor
"OvfParseDescriptorResult Object"The list of all EULAs contained in the OVF
The list of networks required by the OVF
The kind of IP allocation supported by the guest.
See VAppIPAssignmentInfo.
The IP protocols supported by the guest.
See VAppIPAssignmentInfo.
Metadata about the properties contained in the OVF
The product info contained in the OVF
The annotation info contained in the OVF
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.
The OVF Manager's best guess as to the total amount of space required to deploy the entity if using flat disks.
The OVF Manager's best guess as to the total amount of space required to deploy the entity using sparse disks.
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.
True if the OVF contains a vApp (containing one or more vApps and/or virtual machines), as opposed to a single virtual machine.
The list of possible deployment options.
The key of the default deployment option.
Empty only if there are no deployment options.
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".
The annotated OST for the OVF descriptor, generated by OVF consumers.
See OvfConsumer for details.
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).
Non-fatal warnings from the processing.
The result will be valid, but the user may choose to reject it based on these warnings.
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.
"VimFault Object" curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/OvfManager/{moId}/ParseDescriptor