Vcenter VM register
Creates a virtual machine from existing virtual machine files on storage.
This operation was added in vSphere API 6.8.7.
Returns an authorization error if you do not have all of the privileges described as follows:
- The resource
Datastorereferenced by the property Vcenter VM RegisterSpec.datastore requiresSystem.Read. - The resource
Folderreferenced by the property Vcenter VM InventoryPlacementSpec.folder requiresVirtualMachine.Inventory.Register. - The resource
ResourcePoolreferenced by the property Vcenter VM ComputePlacementSpec.resource_pool requiresResource.AssignVMToPool.
Specification of the location of the virtual machine files and the placement of the new virtual machine.
{
"datastore": "string",
"path": "string",
"datastore_path": "string",
"name": "string",
"placement": {
"folder": "string",
"resource_pool": "string",
"host": "string",
"cluster": "string"
}
}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.
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.
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.
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.
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.
Identifier of the newly-created virtual machine.
The response will be an identifier for the resource type: VirtualMachine.
Vapi Std Errors AlreadyExists if a virtual machine with the specified name already exists or if a virtual machine using the specified virtual machine files already exists.
Vapi Std Errors InvalidArgument if any of the specified parameters are invalid.
"Vapi Std Errors Error Object"Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
if the user cannot be authenticated.
"Vapi Std Errors Unauthenticated Object"Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.
For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"
This property was added in vSphere API 7.0.0.0.
This property is optional because it was added in a newer version than its parent node.
if the user doesn't have the required privileges.
"Vapi Std Errors Unauthorized Object"if any of the resources specified in spec could not be found.
"Vapi Std Errors NotFound Object"Vapi Std Errors Error if the system reports an error while responding to the request.
Vapi Std Errors ResourceInaccessible if a specified resource (eg. host) is not accessible.
Vapi Std Errors UnableToAllocateResource if any of the resources needed to register the virtual machine could not be allocated.
"Vapi Std Errors Error Object"Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
if the system is unable to communicate with a service to complete the request.
"Vapi Std Errors ServiceUnavailable Object" curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/vcenter/vm?action=register