Datastore Update V Vol Virtual Machine Files Task

Scan a VVol storage container to update file paths and objectID pointers embedded in virtual machine files on a given storage container.

Required privileges: Datastore.UpdateVirtualMachineFiles

Request

URI

POST

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

string

release

Required

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

Request Body

UpdateVVolVirtualMachineFilesRequestType of type(s) application/json

Required

{
    "failoverPair": [
        {
            "_typeName": "string",
            "srcContainer": "string",
            "tgtContainer": "string",
            "vvolMapping": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": "string"
                }
            ]
        }
    ]
}

array of DatastoreVVolContainerFailoverPair

failoverPair

Optional

Mapping of source to target storage container as well as source to target VVol IDs.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

This method returns a Task object with which to monitor the operation. The result property in the Task contains a VVolVmConfigFileUpdateResult object, which provides a list of successfully updated virtual machine config files and a list of virtual machine config files that failed to update, for all virtual machine config files failed over onto the VVol storage container from the source containers in the failover pair.

Returns MoRefTask of type(s) application/json

This response body class contains all of the following: MoRefExtensibleManagedObject

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

500

NotSupported: if all hosts attached to this datastore do not support updating VVol Virtual Machine Files.

PlatformConfigFault: if any error related to platform occurs during the operation.

TaskInProgress: if the datastore is busy, for example, while another task is updating the datastore.

InvalidDatastore: if the operation cannot be performed due to some error with the datastore.

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