Vsan File Service System Vsan Cluster Remove Fs Domain

Removes a file service domain in the vSAN cluster.

A file service domain is not allowed to be removed if it still has any file shares.

Request

URI

POST

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

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

VsanClusterRemoveFsDomainRequestType of type(s) application/json

Required

Show optional properties

{
    "domainUuid": "string"
}

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

string

domainUuid

Required

The unique domain uuid that is configured in the directory service, for example, Active Directory (AD) from Microsoft.

cluster

Optional

The target cluster. Ignored when called on ESXi hosts.

Required privileges: Host.Config.Storage

Authentication

This operation uses the following authentication methods.

Session

Responses

200

A task tracking the domain 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, or it still has file shares.

InvalidArgument: Exception for invalid input arguments, for example, if the domain 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 '{"domainUuid":"string"}' https://{api_host}/sdk/vim25/{release}/vsan/VsanFileServiceSystem/{moId}/VsanClusterRemoveFsDomain

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