Host System Update Product Locker Location Task

Change and reconfigure the VMware Tools repository on the host.

If the new path is the same as the path already configured on the host, no changes will be made to the host. The host should be powered on.

This task is not cancellable and cannot be reverted once started.

Required privileges: Host.Config.ProductLocker

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/HostSystem/{moId}/UpdateProductLockerLocation_Task

COPY

Path Parameters

string

moId

Required

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 HostSystem/{moId}.

string

release

Required

The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.

Request Body

UpdateProductLockerLocationRequestType of type(s) application/json

Required

{
    "path": "string"
}

string

path

Required

The absolute path for the VMware Tools repository on the host. It should have "/vmfs/volumes/" prefix and it should be a valid existing path, or it could be empty to restore to default value.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

This method returns a Task object with which to monitor the operation. The info.result property in the Task contains the stable vmfs path of the VMware Tools repository upon success. A stable vmfs path is of the form: /vmfs/volumes/[datastore-uuid]/[path/inside/datastore] or empty to indicate restoring to default value.

Returns MoRefTask of type(s) application/json

This response body class contains all of the following: MoRefExtensibleManagedObject

{
    "_typeName": "string",
    "type": "string",
    "value": "string"
}

500

InvalidArgument: if the path does not have "/vmfs/volumes/" prefix and is not empty.

FileNotFound: if the path does not exist.

TaskInProgress: if there is another task configuring the VMware Tools repository on the host.

HostConfigFault: if the configuration could not be written.

Returns MethodFault of type(s) application/json

This response body class contains all of the following: Any

{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

MethodFault

faultCause

Optional

The base data object type for all the object model faults that an application might handle.

array of LocalizableMessage

faultMessage

Optional

Message which has details about the error Message can also contain a key to message catalog which can be used to generate better localized messages.

On This Page

Description

Request

Path Parameters