Vsan Remote Datastore System Vsan Destroy Datastore Source

Destroy an existing Datastore Source configuration.

Required privileges: Host.Config.Storage

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/vsan/VsanRemoteDatastoreSystem/{moId}/VsanDestroyDatastoreSource

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 VsanRemoteDatastoreSystem/{moId}.

string

release

Required

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

Request Body

VsanDestroyDatastoreSourceRequestType of type(s) application/json

Required

Show optional properties

{
    "datastoreSource": {}
}

{
    "datastoreSource": {
        "_typeName": "string",
        "vcInfo": {
            "_typeName": "string",
            "linkType": "string",
            "vcHost": "string"
        }
    }
}

datastoreSource

Required

The Datastore Source to be destroyed. If the vCenter is an ELM linked vCenter, only VsanRemoteVcInfo.vcHost needs to be specified. For a standalone vCenter, the VsanRemoteVcInfoStandalone.user and VsanRemoteVcInfoStandalone.password needs to be specified for an user credential with the privileges to delete the service account.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

The task for destroying Datastore Source operation.

Returns MoRefTask of type(s) application/json

This response body class contains all of the following: MoRefExtensibleManagedObject

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

500

NotFound: The specified Datastore Source is not found.

ResourceInUse: The specified Datastore Source still has datastores being mounted.

VsanFault: Other vSAN related faults.

Returns VimFault of type(s) application/json

This response body class contains all of the following: MethodFault

{
    "_typeName": "string",
    "faultCause": {
        "_typeName": "string",
        "faultCause": "MethodFault Object",
        "faultMessage": [
            {
                "_typeName": "string",
                "key": "string",
                "arg": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "value": {
                            "_typeName": "string"
                        }
                    }
                ],
                "message": "string"
            }
        ]
    },
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"datastoreSource":"{}"}' https://{api_host}/sdk/vim25/{release}/vsan/VsanRemoteDatastoreSystem/{moId}/VsanDestroyDatastoreSource

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

V San Service Api Operations

POST

Vsan Remote Datastore System Vsan Create Datastore Source