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.3.0 APIs.

Request Body

RenameVStorageObjectExRequestType of type(s) application/json

Required

Show optional properties

{
    "id": {
        "id": "string"
    },
    "datastore": {},
    "name": "string"
}

{
    "id": {
        "_typeName": "string",
        "id": "string"
    },
    "datastore": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "name": "string"
}

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.

Session

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

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Virtual Infrastructure Operations