Datastore Rename Datastore

Datastore Rename Datastore

Deprecated as of vSphere API 4.0, use Rename_Task.

Renames a datastore.

Required privileges: Datastore.Rename

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

string
release
Required

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

Request Body
RenameDatastoreRequestType of type(s) application/json
Required 
{
    "newName": "string"
}
string
newName
Required

The new name to assign to the datastore.

Authentication
This operation uses the following authentication methods.
Responses
204

No Content

Operation doesn't return any data structure

500

DuplicateName: if another datastore in this datacenter already has the same name.

InvalidName: if the name is not a valid datastore name.

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
Virtual Infrastructure Operations
POST
Datastore Datastore Enter Maintenance Mode
POST
Datastore Datastore Exit Maintenance Mode Task
POST
Datastore Destroy Task
POST
Datastore Destroy Datastore
GET
Datastore Get Alarm Actions Enabled
GET
Datastore Get Available Field
GET
Datastore Get Browser
GET
Datastore Get Capability
GET
Datastore Get Config Issue
GET
Datastore Get Config Status
GET
Datastore Get Custom Value
GET
Datastore Get Declared Alarm State
GET
Datastore Get Disabled Method
GET
Datastore Get Effective Role
GET
Datastore Get Host
GET
Datastore Get Info
GET
Datastore Get Iorm Configuration
GET
Datastore Get Name
GET
Datastore Get Overall Status
GET
Datastore Get Parent
GET
Datastore Get Permission
GET
Datastore Get Recent Task
GET
Datastore Get Summary
GET
Datastore Get Tag
GET
Datastore Get Triggered Alarm State
GET
Datastore Get Value
GET
Datastore Get Vm
POST
Datastore Is Clustered Vmdk Enabled
POST
Datastore Refresh Datastore
POST
Datastore Refresh Datastore Storage Info
POST
Datastore Reload
POST
Datastore Rename Task
POST
Datastore Rename Datastore
POST
Datastore Set Custom Value
POST
Datastore Update Virtual Machine Files Task
POST
Datastore Update V Vol Virtual Machine Files Task