Vslm V Storage Object Manager Vslm Rename V Storage Object

Rename a virtual storage object.

VslmSyncFault is thrown when the underlying rename operation of the FCD succeeded, however, there was a issue with syncing the datastore or FCD. Rename operation of the FCD is not idempotent, implying, any attempt to rename the FCD with it's current name would result in a error. The sync fault can be ignored with the risk of Pandora DB having stale name, 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}/VslmRenameVStorageObject

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

VslmRenameVStorageObjectRequestType of type(s) application/json

Required

Show optional properties

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

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

Required

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

string

name

Required

The new name for the virtual storage object.

Authentication

This operation uses the following authentication methods.

Session

Responses

204

No Content

Operation doesn't return any data structure

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.

VslmSyncFault: If an error occurs during datastore synchornization, implies the renameVStorageObject completed successfully, however, there was an exception during datastore synchornization.

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