Unregister VM
If vSphere APIs begin with /rest (vs /api), any maps are consumed/returned instead as arrays of objects, each containing a key and a value property field.
Removes the virtual machine corresponding to vm from the vCenter inventory without removing any of the virtual machine’s files from storage. All high-level information stored with the management server (ESXi or vCenter) is removed, including information such as statistics, resource pool association, permissions, and alarms. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Inventory.Unregister.
Request
URLURL
https://{api_host}/rest/vcenter/vm/{vm}?action=unregister
Parameters
Parameters
string
vm
Required
Identifier of the virtual machine to be unregistered.
The parameter must be an identifier for the resource type: VirtualMachine.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
Example: b00db39f948d13ea1e59b4d6fce56389
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/vcenter/vm/{vm}?action=unregister
Errors
409
com.vmware.vapi.std.errors.not_allowed_in_current_state : if the virtual machine is running (powered on). | com.vmware.vapi.std.errors.resource_busy : if the virtual machine is busy performing another operation.
503
com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request.
401
com.vmware.vapi.std.errors.unauthenticated : if the user can not be authenticated. | com.vmware.vapi.std.errors.unauthorized : if the user doesn't have the required privileges.
404
com.vmware.vapi.std.errors.not_found : if there is no virtual machine associated with vm in the system.
On This Page
VM Operations
get
post
delete
get
post
post
post
post
post
post
post
