VStorage Object Manager Base Rename V Storage Object Ex

VStorage Object Manager Base Rename V Storage Object Ex

Rename a virtual storage object.

Since: vSphere API Release 8.0.2.0

Required privileges: System.View

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

string
release
Required

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

Request Body
RenameVStorageObjectExRequestType of type(s) application/json
Required 
{
    "id": {
        "id": "string"
    },
    "datastore": {
        "type": "string",
        "value": "string"
    },
    "name": "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.

string
name
Required

The new name for the virtual storage object.

Authentication
This operation uses the following authentication methods.
Responses
200

The vclock info of this operation

Returns vslmVClockInfo of type(s) application/json
This response body class contains all of the following: DataObject 
{
    "_typeName": "string",
    "vClockTime": 0
}
integer As int64 As int64
vClockTime
Required

Virtual clock time of VStorageObject catalog.

It is an epoch or generation ID assigned to each VStorageObject operation on a datastore.


500

FileFault: If an error occurs while renaming the virtual storage object.

NotFound: If the specified virtual storage object cannot be found.

InvalidDatastore: If the operation cannot be performed on the datastore.

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"
        }
    ]
}

Availability
Added in vSphere API Release 8.0.2.0
On This Page
Vstorage Object Manager Base Operations
POST
VStorage Object Manager Base Rename V Storage Object Ex
POST
VStorage Object Manager Base Revert V Storage Object Ex Task
POST
VStorage Object Manager Base V Storage Object Create Snapshot Ex Task
POST
VStorage Object Manager Base V Storage Object Delete Snapshot Ex Task
POST
VStorage Object Manager Base V Storage Object Extend Disk Ex Task