Vcenter V Storage Object Manager Relocate V Storage Object Task

Relocate a virtual storage object.

Requires Datastore.FileManagement privilege on both source and destination datastore.

If there is no host that has access to both source and destination datastore, then limited number of concurrent relocations are supported. This number is set to 10.

Required privileges: System.View

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/VcenterVStorageObjectManager/{moId}/RelocateVStorageObject_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 VcenterVStorageObjectManager/{moId}.

string

release

Required

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

Request Body

RelocateVStorageObjectRequestType of type(s) application/json

Required

Show optional properties

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

{
    "id": {
        "_typeName": "string",
        "id": "string"
    },
    "datastore": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "spec": {
        "_typeName": "string",
        "backingSpec": {
            "_typeName": "string",
            "datastore": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            },
            "path": "string"
        },
        "profile": [
            {
                "_typeName": "string"
            }
        ],
        "consolidate": false,
        "disksCrypto": {
            "_typeName": "string",
            "parent": "DiskCryptoSpec Object",
            "crypto": {
                "_typeName": "string"
            }
        },
        "service": {
            "_typeName": "string",
            "instanceUuid": "string",
            "url": "string",
            "credential": {
                "_typeName": "string"
            },
            "sslThumbprint": "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.

VslmRelocateSpec

spec

Required

Specification for relocating a virtual storage object.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

Returns MoRefTask of type(s) application/json

This response body class contains all of the following: MoRefExtensibleManagedObject

{
    "_typeName": "string",
    "type": "string",
    "value": "string"
}

500

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

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

InvalidState: If the operation cannot be performed on the disk. The disk may be consumed and cannot be relocated.

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

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Virtual Infrastructure Operations