This API has a deprecated equivalent from v7.0U1.
Update Tools
Update the properties of VMware Tools.
Request
URLURL
https://{api_host}/api/vcenter/vm/{vm}/tools
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, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
{
"upgrade_policy": "MANUAL"
}
upgrade_policy
Optional
The Tools.UpgradePolicy enumerated type defines when Tools are auto-upgraded for a virtual machine.
MANUAL : No auto-upgrades for Tools will be performed for this virtual machine. Users must manually invoke the Tools.upgrade operation to update Tools.
UPGRADE_AT_POWER_CYCLE : When the virtual machine is power-cycled, the system checks for a newer version of Tools when the virtual machine is powered on. If it is available, a Tools upgrade is automatically performed on the virtual machine and it is rebooted if necessary.
Possible values are: MANUAL , UPGRADE_AT_POWER_CYCLE
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if the Tools.UpdateSpec.upgrade-policy field contains a value that is not supported by the server.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
$VmToolsUpdateSpec = Initialize-VmToolsUpdateSpec -UpgradePolicy "MANUAL"
Invoke-UpdateVmTools -Vm "MyVm" -VmToolsUpdateSpec $VmToolsUpdateSpec
cURL Command
curl -X PATCH -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"upgrade_policy":"MANUAL"}' https://{api_host}/api/vcenter/vm/{vm}/tools
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: patch
x-vmw-doc-deprecated-path: /rest/vcenter/vm/{vm}/tools
x-vmw-doc-operation: update
Availability
Added in 7.0U2
