FileShareQueryResult

FileShareQueryResult
FileShareQueryResult

Result for query file share operation.

This structure may be used only with operations rendered under /vsan.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "fileShares": [
        {
            "_typeName": "string",
            "uuid": "string",
            "config": {
                "_typeName": "string",
                "name": "string",
                "domainName": "string",
                "quota": "string",
                "softQuota": "string",
                "labels": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "value": "string"
                    }
                ],
                "storagePolicy": {
                    "_typeName": "string"
                },
                "permission": [
                    {
                        "_typeName": "string",
                        "ips": "string",
                        "permissions": "string",
                        "allowRoot": false
                    }
                ],
                "protocols": [
                    "string"
                ],
                "smbOptions": {
                    "_typeName": "string",
                    "encryption": "string",
                    "accessBasedEnumeration": false
                },
                "nfsSecType": "string",
                "affinityLocation": "string"
            },
            "runtime": {
                "_typeName": "string",
                "usedCapacity": 0,
                "hostname": "string",
                "address": "string",
                "vsanObjectUuids": [
                    "string"
                ],
                "accessPoints": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "value": "string"
                    }
                ],
                "managedBy": "string",
                "fileServerFQDN": "string"
            }
        }
    ],
    "nextOffset": "string",
    "totalShareCount": 0,
    "maxShareCount": 0
}
array of VsanFileShare
fileShares
Optional

A list of file shares that matches query criteria.

Note that the number of return value will be limited by offset or the limit in the query specification and the total number of remaining file shares.

string
nextOffset
Optional

This field indicates the starting offset for the next query.

If there is no more share to be returned, this value is None. If there are more shares after this result to be returned, it should be passed to next query. For more explanation, see VsanFileShareQuerySpec.offset

integer As int64 As int64
totalShareCount
Optional

The number of file shares created in total.

This value could be used by client to decide if there is a need to make further calls for querying remaining file shares.

integer As int64 As int64
maxShareCount
Optional

This field indicates the maximum number of shares that can be configured in the cluster.

This field will only be set in a vSAN ESA cluster.

Since: 8.0.0.4

Property Of
Used By