Register VM
Creates a virtual machine from existing virtual machine files on storage. if you do not have all of the privileges described as follows: - The resource Datastore referenced by the attribute VM.RegisterSpec.datastore requires System.Read. - The resource Folder referenced by the attribute VM.InventoryPlacementSpec.folder requires VirtualMachine.Inventory.Register. - The resource ResourcePool referenced by the attribute VM.ComputePlacementSpec.resource-pool requires Resource.AssignVMToPool.
Request
URLURL
https://{api_host}/rest/vcenter/vm?action=register
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
VMRegisterRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"spec": {
"placement": {
"folder": "string"
}
}
}
spec
Required
Specification of the location of the virtual machine files and the placement of the new virtual machine.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
VMRegisterResponseBody of type application/json
Identifier of the newly-created virtual machine. The result will be an identifier for the resource type: VirtualMachine.
{
"value": "string"
}
string
value
Optional
Identifier of the newly-created virtual machine. The result will be an identifier for the resource type: VirtualMachine.
Errors
400
com.vmware.vapi.std.errors.already_exists : if a virtual machine with the specified name already exists or if a virtual machine using the specified virtual machine files already exists. | com.vmware.vapi.std.errors.invalid_argument : if any of the specified parameters are invalid.
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn’t have the required privileges.
404
com.vmware.vapi.std.errors.not_found : if any of the resources specified in spec could not be found.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request. | com.vmware.vapi.std.errors.resource_inaccessible : if a specified resource (eg. host) is not accessible. | com.vmware.vapi.std.errors.unable_to_allocate_resource : if any of the resources needed to register the virtual machine could not be allocated.
503
com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"spec":{"datastore":"string","datastore_path":"string","name":"string","path":"string","placement":{"cluster":"string","folder":"string","host":"string","resource_pool":"string"}}}' https://{api_host}/rest/vcenter/vm?action=register
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: register
Availability
Added in 6.8.7
On This Page
VM Operations
get
post
get
delete
post
post
post
post
post
post
post
