This API has a deprecated equivalent from v7.0U1.
Upgrade Tools
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}/api/vcenter/vm/{vm}/tools?action=upgrade
Path Parameters
Path Parameters
string
vm
Required
Identifier of the virtual machine.
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
vmware-api-session-id example
b00db39f948d13ea1e59b4d6fce56389
Request Body
Request Body
VmToolsUpgradeRequestBody of mimetype application/json
Optional
This is a request body class for an operation.
(The request body parameter is missing description)
{
"command_line_options": "string"
}
string
command_line_options
Optional
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}/api/vcenter/vm/{vm}/tools?action=upgrade
Errors
400
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.
500
com.vmware.vapi.std.errors.error : if the upgrade process fails inside the guest operating system.
Availability
Added in 7.0U2
