Vsan File Service System Vsan Cluster Query File Shares

Lists all file shares in the domain.

To list all the file shares in the domain, leave both the shareUuids and shareNames field empty. Otherwise the return result will be a set of file shares matches the share UUID or share name provided in the parameters. If both fields are provided, only those file shares with both share name and share UUID matched will be returned. Note that if none of file shares matches the querySpec, the return value is None.

Request

URI

POST

https://{api_host}/sdk/vim25/{release}/vsan/VsanFileServiceSystem/{moId}/VsanClusterQueryFileShares

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.0.0.0 APIs.

Request Body

VsanClusterQueryFileSharesRequestType of type(s) application/json

Required

"VsanClusterQueryFileSharesRequestType Object"

querySpec

Required

The specifications of the file shares to be queried.

cluster

Optional

The target cluster. Ignored when called on ESXi hosts.

Required privileges: System.Read

Authentication

This operation uses the following authentication methods.

Session

Responses

200

Result of the file share query.

This response body class contains all of the following: FileShareQueryResult

{
    "0": "F",
    "1": "i",
    "2": "l",
    "3": "e",
    "4": "S",
    "5": "h",
    "6": "a",
    "7": "r",
    "8": "e",
    "9": "Q",
    "10": "u",
    "11": "e",
    "12": "r",
    "13": "y",
    "14": "R",
    "15": "e",
    "16": "s",
    "17": "u",
    "18": "l",
    "19": "t",
    "20": " ",
    "21": "O",
    "22": "b",
    "23": "j",
    "24": "e",
    "25": "c",
    "26": "t"
}

500

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

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: InlineMethodFault0

"MethodFault Object"

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 '[{}]' https://{api_host}/sdk/vim25/{release}/vsan/VsanFileServiceSystem/{moId}/VsanClusterQueryFileShares

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