Vslm V Storage Object Manager Vslm Update V Storage Object Metadata Task

Update metadata KV pairs to a virtual storage object.

And this API is by design supposed to be used for all of the addition, modification and deletion operations of metadata KV pairs.

Requires Datastore.FileManagement privilege on the datastore where the virtual storage object is located.

VslmSyncFault will set in the task error if the updateVStorageObjectMetadata completed successfully but the datastore synchronization or FCD retrieval failed. The sync fault can be ignored with the risk of Pandora DB having stale metadata information consequently affecting the return of VslmListVStorageObjectForSpec and VslmRetrieveVStorageObjects APIs.

Required privileges: System.View

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/vslm/VslmVStorageObjectManager/{moId}/VslmUpdateVStorageObjectMetadata_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 VslmVStorageObjectManager/{moId}.

string

release

Required

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

Request Body

VslmUpdateVStorageObjectMetadataRequestType of type(s) application/json

Required

Show optional properties

{
    "id": {
        "id": "string"
    }
}

{
    "id": {
        "_typeName": "string",
        "id": "string"
    },
    "metadata": [
        {
            "_typeName": "string",
            "key": "string",
            "value": "string"
        }
    ],
    "deleteKeys": [
        "string"
    ]
}

Required

This data object type describes an identifier class which is globally unique to identify the associated object.

array of KeyValue

metadata

Optional

array of key/value strings. (keys must be unique within the list)

array of string

deleteKeys

Optional

array of keys need to be deleted

Authentication

This operation uses the following authentication methods.

Session

Responses

200

This method returns a Task object with which to monitor the operation.

Returns MoRefTask of type(s) application/json

This response body class contains all of the following: MoRefExtensibleManagedObject

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

500

InvalidDatastore: If the operation cannot be performed on the datastore, such as datastore cannot be found or inaccessible.

InvalidState: If the operation cannot be performed on the disk.

NotFound: If specified virtual storage object cannot be found.

VslmFault: If a VSLM internal server error occurred.

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