Virtual Machine Upgrade Tools Task
Begins the tools upgrade process.
To monitor the status of the tools install, clients should check the tools status, toolsVersionStatus and toolsRunningStatus.
Required privileges: VirtualMachine.Interact.ToolsInstall
The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId
, in this case VirtualMachine/{moId}
.
The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.
{
"installerOptions": "string"
}
Command line options passed to the installer to modify the installation procedure for tools.
This method returns a Task object with which to monitor the operation.
{
"_typeName": "string",
"type": "string",
"value": "string"
}
InvalidState: if the virtual machine is not running or is suspended.
NotSupported: if upgrading tools is not supported.
TaskInProgress: if an upgrade is already taking place.
VmToolsUpgradeFault: if the upgrade failed.
ToolsUnavailable: if VMware Tools is not running.
{
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
}