Developer Documentation
Upgrade Tools
Released in v7.0.0Begins 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. |
Query Parameters
Query Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | action=upgrade |
Request Body
Request Body
Contains
UpgradeRequestBody
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. |
Errors
| Code | Returns | Description |
|---|---|---|
| 503 | Error | com.vmware.vapi.std.errors.service_unavailable : if the VMware Tools are not running. |
| default | Error | Not available |
| 404 | Error | 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 | Error | 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. |
