VsanReconfigureFileShareRequestType

VsanReconfigureFileShareRequestType
VsanReconfigureFileShareRequestType

The parameters of VsanReconfigureFileShare.

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

JSON Example
{
    "shareUuid": "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"
    },
    "cluster": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "deleteLabelKeys": [
        "string"
    ],
    "force": false
}
string
shareUuid
Required

The UUID of the file share to be reconfigured.

config
Required

The file services configuration. Only set the fields that require reconfiguration, and leave the others unset. This API will update or create the labels specified in the config. Labels to be deleted should be specified in the 'deleteLabelKeys' parameter. Other labels will remain intact.

cluster
Optional

The target cluster. Ignored when called on ESXi hosts.

Required privileges: Host.Config.Storage

array of string
deleteLabelKeys
Optional

The keys of share labels to be deleted. If a specified label key does not exist in the file share, the deletion of this label will be ignored.

boolean
force
Optional

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

Parameter To