RegisterVMRequestType

RegisterVMRequestType
RegisterVMRequestType

The parameters of RegisterVM_Task.

JSON Example
{
    "path": "string",
    "name": "string",
    "asTemplate": false,
    "pool": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "host": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    }
}
string
path
Required

A datastore path to the virtual machine.

string
name
Optional

The name to be assigned to the virtual machine. If this parameter is not set, the displayName configuration parameter of the virtual machine is used. An entity name must be a non-empty string of less than 80 characters. The slash (/), backslash (\) and percent (%) will be escaped using the URL syntax. For example, %2F.

boolean
asTemplate
Required

Flag to specify whether or not the virtual machine should be marked as a template.

pool
Optional

The resource pool to which the virtual machine should be attached. If imported as a template, this parameter is not set.

Required privileges: Resource.AssignVMToPool

host
Optional

The target host on which the virtual machine will run. This parameter must specify a host that is a member of the ComputeResource indirectly specified by the pool. For a stand-alone host or a cluster, the parameter can be omitted, and the system selects a default.

Parameter To