Host V Storage Object Manager Host Update V Storage Object Metadata Task

Host V Storage Object Manager Host 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.

Required privileges: System.View

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/HostVStorageObjectManager/{moId}/HostUpdateVStorageObjectMetadata_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 HostVStorageObjectManager/{moId}.

string
release
Required

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

Request Body
HostUpdateVStorageObjectMetadataRequestType of type(s) application/json
Required 
{
    "id": {
        "id": "string"
    },
    "datastore": {
        "type": "string",
        "value": "string"
    },
    "metadata": [
        {
            "_typeName": "string",
            "key": "string",
            "value": "string"
        }
    ],
    "deleteKeys": [
        "string"
    ]
}
ID
id
Required

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

MoRefDatastore
datastore
Required

Reference to an instance of the Datastore managed 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.
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.

Returns VimFault of type(s) application/json
This response body class contains all of the following: MethodFault 
{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

On This Page
Host Vstorage Object Manager Operations
POST
Host V Storage Object Manager Host Clear V Storage Object Control Flags
POST
Host V Storage Object Manager Host Clone V Storage Object Task
POST
Host V Storage Object Manager Host Create Disk Task
POST
Host V Storage Object Manager Host Delete V Storage Object Task
POST
Host V Storage Object Manager Host Delete V Storage Object Ex Task
POST
Host V Storage Object Manager Host Extend Disk Task
POST
Host V Storage Object Manager Host Inflate Disk Task
POST
Host V Storage Object Manager Host List V Storage Object
POST
Host V Storage Object Manager Host Reconcile Datastore Inventory Task
POST
Host V Storage Object Manager Host Register Disk
POST
Host V Storage Object Manager Host Relocate V Storage Object Task
POST
Host V Storage Object Manager Host Rename V Storage Object
POST
Host V Storage Object Manager Host Retrieve V Storage Infrastructure Object Policy
POST
Host V Storage Object Manager Host Retrieve V Storage Object
POST
Host V Storage Object Manager Host Retrieve V Storage Object Metadata
POST
Host V Storage Object Manager Host Retrieve V Storage Object Metadata Value
POST
Host V Storage Object Manager Host Retrieve V Storage Object State
POST
Host V Storage Object Manager Host Schedule Reconcile Datastore Inventory
POST
Host V Storage Object Manager Host Set V Storage Object Control Flags
POST
Host V Storage Object Manager Host Update V Storage Object Metadata Task
POST
Host V Storage Object Manager Host Update V Storage Object Metadata Ex Task
POST
Host V Storage Object Manager Host V Storage Object Create Disk From Snapshot Task
POST
Host V Storage Object Manager Host V Storage Object Create Snapshot Task
POST
Host V Storage Object Manager Host V Storage Object Delete Snapshot Task
POST
Host V Storage Object Manager Host V Storage Object Retrieve Snapshot Info
POST
Host V Storage Object Manager Host V Storage Object Revert Task
POST
Host V Storage Object Manager Rename V Storage Object Ex
POST
Host V Storage Object Manager Revert V Storage Object Ex Task
POST
Host V Storage Object Manager V Storage Object Create Snapshot Ex Task
POST
Host V Storage Object Manager V Storage Object Delete Snapshot Ex Task
POST
Host V Storage Object Manager V Storage Object Extend Disk Ex Task