Update Tools
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
Update the properties of VMware Tools.
Request
URLURL
https://{api_host}/rest/vcenter/vm/{vm}/tools
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine. |
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
Request Body
Request Body
Contains VmToolsUpdateRequestBody
of type application/json
(required)
{
"spec": {
"upgrade_policy": "enum"
}
}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | spec | VmToolsUpdateSpec |
The new values. |
cURL Command
curl -X PATCH -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"spec":{"upgrade_policy":"enum"}}' https://{api_host}/rest/vcenter/vm/{vm}/tools
Errors
| Code | Returns | Description |
|---|---|---|
| default | ErrorRest | Not available |
| 400 | ErrorRest | com.vmware.vapi.std.errors.invalid_argument : if the Tools.UpdateSpec.upgrade-policy field contains a value that is not supported by the server. |
| 404 | ErrorRest | com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request. | com.vmware.vapi.std.errors.not_found : if the virtual machine is not found. |
