Vsan File Service System Vsan Cluster Remove Share

Removes a file share in the domain.

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/vsan/VsanFileServiceSystem/{moId}/VsanClusterRemoveShare

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

string

release

Required

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

Request Body

VsanClusterRemoveShareRequestType of type(s) application/json

Required

Show optional properties

{
    "shareUuid": "string"
}

{
    "shareUuid": "string",
    "cluster": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "force": false
}

string

shareUuid

Required

The UUID of the file share to be removed.

cluster

Optional

The target cluster. Ignored when called on ESXi hosts.

Required privileges: Host.Config.Storage

boolean

force

Optional

The force flag is to force the removal of a vSphere managed file share, for example, the file share managed by Cloud Native Storage (CNS) service.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

A task tracking the file share remove progress.

Returns MoRefTask of type(s) application/json

This response body class contains all of the following: MoRefExtensibleManagedObject

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

500

InvalidState: Exception when vSAN file service is not enabled in this cluster.

InvalidArgument: Exception for invalid input arguments, for example, if the file share does not exist in this cluster.

Returns MethodFault of type(s) application/json

This response body class contains all of the following: Any

{
    "_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"
        }
    ]
}

faultCause

Optional

Fault which is the cause of this fault.

array of object

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.

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"shareUuid":"string"}' https://{api_host}/sdk/vim25/{release}/vsan/VsanFileServiceSystem/{moId}/VsanClusterRemoveShare

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

V San Service Api Operations

POST

Vsan File Service System Vsan Cluster Create Fs Domain