vcenter ovf import session: instantiate
Instantiates the virtual machine or virtual appliance.
This method is only valid to call with an import session in state IMPORT_SELECTING_OVF_PARAMS.
During the execution of this method the session state will progress over IMPORT_FILE_TRANSFER and IMPORT_INSTANTIATING to IMPORT_COMPLETED.
This method must be called to complete the session. After the call it is an error to call instantiate.
Request:
HTTP request
POST https://{server}/rest/com/vmware/vcenter/ovf/import-session/id:{id}?~action=instantiate
Path Parameters
| Name | Type | Description |
|---|---|---|
| Required | ||
| id | string | the import session ID. |
Request Body Structure:
{
"instantiation_parameters" : [
{
"@class" : "com.vmware.vcenter.ovf.ovf_params",
"type" : "string"
},
{
"@class" : "com.vmware.vcenter.ovf.ovf_params",
"type" : "string"
}
]
}
"instantiation_parameters" : [
{
"@class" : "com.vmware.vcenter.ovf.ovf_params",
"type" : "string"
},
{
"@class" : "com.vmware.vcenter.ovf.ovf_params",
"type" : "string"
}
]
}
Request Body Parameters:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| instantiation_parameters.type | string | Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters structure. This field must be provided in the input parameters when deploying an OVF package. This field will always be present in the result when retrieving information about an OVF package. |
| instantiation_parameters | object[] | a Array of OVF parameter structures that specifies a set of deployment specific parameters. |
Response:
HTTP Status Code: 200
NoneErrors:
| HTTP Status Code | Type | Description |
|---|---|---|
| 404 | not_found | if the specified session could not be found. It may have been deleted or timed out. |
| 400 | not_allowed_in_current_state | if the specified session is not in the IMPORT_SELECTING_OVF_PARAMS state. |
| 400 | invalid_argument | if the provided instantiationParameters contain an invalid argument. |
| 400 | unsupported | if a session of the given type cannot be instantiated. This happens for probe sessions. |
| 403 | unauthorized | If you do not have all of the privileges described in the following list:
|