REST API - upgrade
  1. Operations
  2. vcenter
  3. vm
  4. tools

vcenter vm tools: upgrade

Begins the Tools upgrade process. To monitor the status of the Tools upgrade, clients should check the Tools status by calling get and examining version_status and run_state. This operation was added in vSphere API 7.0.0.

Request:

HTTP request

POST https://{server}/rest/vcenter/vm/{vm}/tools?action=upgrade

Path Parameters

Name Type Description
Required
vm string Identifier of the virtual machine.

Request Body Structure:

{
    "command_line_options" : "string"
}

Request Body Parameters:

Name Type Description
bold = required
command_line_options string Optional. Command line options passed to the installer to modify the installation procedure for Tools.

Response:

HTTP Status Code: 200

None

Errors:

HTTP Status Code Type Description
404 not_found if the virtual machine is not found.
503 service_unavailable if the VMware Tools are not running.
400 not_allowed_in_current_state if the virtual machine is not powered on.
400 already_in_desired_state is an upgrade is already in progress.
500 error if the upgrade process fails inside the guest operating system.