Ovf Manager Create Descriptor
Create an OVF descriptor for the specified ManagedEntity, which may be a VirtualMachine or a VirtualApp.
To create the complete OVF descriptor, the client must already have downloaded the files that are part of the entity, because information about these files (compression, chunking, filename etc.) is part of the descriptor.
However, these downloads can be quite time-consuming, so if the descriptor for some reason cannot be generated, the client will want to know this before downloading the files.
For this reason, the client may do an initial "dry run" with the ovfFiles parameter unset. Default filenames will then be used in the descriptor, and the client can examine any warnings and/or errors before downloading the files.
After the final call to this method, client must release the lock on the entity given to it by VirtualMachine.exportVm or VirtualApp.exportVApp.
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 8.0.2.0 APIs.
{
"obj": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"cdp": {
"_typeName": "string",
"ovfFiles": [
{
"_typeName": "string",
"deviceId": "string",
"path": "string",
"compressionMethod": "string",
"chunkSize": 0,
"size": 0,
"capacity": 0,
"populatedSize": 0
}
],
"name": "string",
"description": "string",
"includeImageFiles": false,
"exportOption": [
"string"
],
"snapshot": {
"_typeName": "string",
"type": "string",
"value": "string"
}
}
}
An instance of CreateDescriptorResult
{
"_typeName": "string",
"ovfDescriptor": "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"
}
]
}
],
"includeImageFiles": false
}
The OVF descriptor for the entity.
Errors that happened during processing.
For example, unknown or unsupported devices could be found (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.
Returns true if there are ISO or Floppy images attached to one or more VMs.
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.
{
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
}