Vcenter VM RegisterSpec

The Vcenter VM RegisterSpec schema contains information used to create a virtual machine from existing virtual machine files on storage.

The location of the virtual machine files on storage must be specified by providing either Vcenter VM RegisterSpec.datastore and Vcenter VM RegisterSpec.path or by providing Vcenter VM RegisterSpec.datastore_path. If Vcenter VM RegisterSpec.datastore and Vcenter VM RegisterSpec.path are set, Vcenter VM RegisterSpec.datastore_path must be missing or null, and if Vcenter VM RegisterSpec.datastore_path is set, Vcenter VM RegisterSpec.datastore and Vcenter VM RegisterSpec.path must be missing or null.

This schema was added in vSphere API 6.8.7.

JSON Example

{
    "datastore": "string",
    "path": "string",
    "datastore_path": "string",
    "name": "string",
    "placement": {
        "folder": "string",
        "resource_pool": "string",
        "host": "string",
        "cluster": "string"
    }
}

string

datastore

Optional

Identifier of the datastore on which the virtual machine's configuration state is stored.

This property was added in vSphere API 6.8.7.

If missing or null, Vcenter VM RegisterSpec.path must also be missing or null and Vcenter VM RegisterSpec.datastore_path must be set.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: Datastore. When operations return a value of this schema as a response, the property will be an identifier for the resource type: Datastore.

string

path

Optional

Path to the virtual machine's configuration file on the datastore corresponding to {@link #datastore).

This property was added in vSphere API 6.8.7.

If missing or null, Vcenter VM RegisterSpec.datastore must also be missing or null and Vcenter VM RegisterSpec.datastore_path must be set.

string

datastore_path

Optional

Datastore path for the virtual machine's configuration file in the format "[datastore name] path". For example "[storage1] Test-VM/Test-VM.vmx".

This property was added in vSphere API 6.8.7.

If missing or null, both Vcenter VM RegisterSpec.datastore and Vcenter VM RegisterSpec.path must be set.

string

name

Optional

Virtual machine name.

This property was added in vSphere API 6.8.7.

If missing or null, the display name from the virtual machine's configuration file will be used.

placement

Optional

Virtual machine placement information.

This property was added in vSphere API 6.8.7.

This property is currently required. In the future, if this property is missing or null, the system will attempt to choose suitable resources on which to place the virtual machine.

Parameter To

Vcenter VM register