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

vcenter vm tools: update

Update the properties of VMware Tools. This operation was added in vSphere API 7.0.0.0.

Request:

HTTP request

PATCH https://{server}/rest/vcenter/vm/{vm}/tools

Path Parameters

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

Request Body Structure:

{
    "spec" : {
        "upgrade_policy" : "MANUAL"
    }
}

Request Body Parameters:

Name Type Description
bold = required
spec update_spec The new values.
spec.upgrade_policy string Tools upgrade policy setting for the virtual machine. vcenter.vm.tools.upgrade_policy. This attribute was added in vSphere API 7.0.0.0.

Optional. If this field is omitted the value will not be changed.

Response:

HTTP Status Code: 200

None

Errors:

HTTP Status Code Type Description
500 error if the system reports an error while responding to the request.
400 invalid_argument if the vcenter.vm.tools.update_spec.upgrade_policy field contains a value that is not supported by the server.
404 not_found if the virtual machine is not found.