Upgrade Tools
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
Begins the Tools upgrade process. To monitor the status of the Tools upgrade, clients should check the Tools status by calling Tools.get and examining Tools.Info.version-status and Tools.Info.run-state.
Request
URLURL
https://{api_host}/rest/vcenter/vm/{vm}/tools?action=upgrade
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 VmToolsUpgradeRequestBody
of type application/json
(required)
{
"command_line_options": "string"
}| Required | Property Name | Type | Description |
|---|---|---|---|
| optional | command_line_options | string |
Command line options passed to the installer to modify the installation procedure for Tools. Set if any additional options are desired. |
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"command_line_options":"string"}' https://{api_host}/rest/vcenter/vm/{vm}/tools?action=upgrade
Errors
| Code | Returns | Description |
|---|---|---|
| 503 | ErrorRest | com.vmware.vapi.std.errors.service_unavailable : if the VMware Tools are not running. |
| default | ErrorRest | Not available |
| 404 | ErrorRest | com.vmware.vapi.std.errors.not_found : if the virtual machine is not found. | com.vmware.vapi.std.errors.error : if the upgrade process fails inside the guest operating system. |
| 409 | ErrorRest | com.vmware.vapi.std.errors.not_allowed_in_current_state : if the virtual machine is not powered on. | com.vmware.vapi.std.errors.already_in_desired_state : is an upgrade is already in progress. |
