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
Parameters
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, acquired from Create Session API under CIS product
vmware-api-session-id Example
b00db39f948d13ea1e59b4d6fce56389
Request Body
Request Body
VmToolsUpgradeRequestBody of type application/json (required){
"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}/rest/vcenter/vm/{vm}/tools?action=upgrade
Errors
404
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
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.
default
'Default' means this response is used for all HTTP codes that are not covered individually for this operation.
