Ovf Manager Create Import Spec

Ovf Manager Create Import Spec

Validate the OVF descriptor against the hardware supported by the host system.

If the validation succeeds, return a result containing:

  • An ImportSpec to use when importing the entity.
  • A list of items to upload (for example disk backing files, ISO images etc.)

Required privileges: System.View

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/OvfManager/{moId}/CreateImportSpec
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 9.0.0.0 APIs.

Request Body
CreateImportSpecRequestType of type(s) application/json
Required 
"CreateImportSpecRequestType Object"
string
ovfDescriptor
Required

The OVF descriptor of the entity.

resourcePool
Required

The resource pool to import the entity to. May be a vApp.

Required privileges: VApp.Import

datastore
Required

The datastore on which to create the inventory objects of the entity, for example "storage1". The privilege Datastore.AllocateSpace is required on the datastore.

Required privileges: Datastore.AllocateSpace

cisp
Required

Additional parameters to the method, bundled in an instance of CreateImportSpecParams.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns OvfCreateImportSpecResult of type(s) application/json 
"OvfCreateImportSpecResult Object"
importSpec
Optional

The ImportSpec contains information about which VirtualMachines and VirtualApps are present in the entity and how they relate to each other.

array of object
fileItem
Optional

The files that must be uploaded by the caller as part of importing the entity.

The files must be uploaded in order, because some of them may be delta files that patch already-uploaded files.

array of object
warning
Optional

Non-fatal warnings from the processing.

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

array of object
error
Optional

Errors that happened during processing.

Something will be wrong with the ImportSpec, or it is not present.


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: InlineVimFault0 
"VimFault Object"

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/OvfManager/{moId}/CreateImportSpec
On This Page
Virtual Infrastructure Operations
POST
Ovf Manager Create Descriptor
POST
Ovf Manager Create Import Spec
POST
Ovf Manager Parse Descriptor
POST
Ovf Manager Validate Host
GET
Ovf Manager Get Ovf Export Option
GET
Ovf Manager Get Ovf Import Option