VsanFileShareConfig

Configurations of a file share.

A file share is a root folder that is created in file service domain and provide file sharing access under the root folder. Multiple users can have remote access to those files using protocols like Server Message Block (SMB) or Network File System (NFS) protocol.

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

AllOf

This class requires all of the following:

DataObject

JSON Example

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

string

name

Optional

The name of the file share.

Must be unique within the file service domain. The share name cannot exceed 80 characters, and can only contain alphabets (A-Z, a-z), numbers (0-9) and '-' character. Every '-' character must be immediately preceded and followed by a number or alphabet. Consecutive '-'s are not allowed. This configuration is required for file share creation. This is the visible name in the URL of the file share. For example, a SMB file share can be like this:
smb://host-address/file-share-name

string

domainName

Optional

The name of the file service domain the file share belongs to.

This configuration is required for file share creation.

string

quota

Optional

The hard quota configuration at the file share level.

This will be defined in nearest MB/GB/TB terms in integer (no space allowed between the number and the unit). A valid quota string could be "10GB", "10G", "10g", "100m", "100M", "1000MB", etc. This will be the hard quota for the file share. A hard quota will fail the write I/O right away when the write is exceeding the quota. To set an unlimited hard quota for the file share, set the quota value to 0. Note that the file share size is still limited by the vSAN datastore size.

string

softQuota

Optional

The soft quota configuration at the file share level.

This will be defined in nearest MB/GB/TB terms in integer (no space allowed between the number and the unit). A valid quota string could be "10GB", "10G", "10g", "100m", "100M", "1000MB", etc. This will be the soft quota for the file share. A soft quota will raise alerts which is detected by periodically checks. To set an unlimited soft quota for the file share, set the soft quota value to 0.

array of KeyValue

labels

Optional

The labels attached to the file share.

The label key cannot exceed 250 bytes, cannot be '.' or '..', and cannot contain '/' or non-printable characters. The label value cannot exceed 1024 bytes.

storagePolicy

Optional

vSAN storage policy for all the vSAN objects that are created to back this file share.

vSAN datastore default policy is used when this field is not set.

array of VsanFileShareNetPermission

permission

Optional

The network permissions for NFS shares.

CreateFileShare: If this field is not set, then no client can access this file share. ReconfigureFileShare: If this field is set it will replace all the existing permissions on the file share. If it is not set, no changes will be done.

array of string

protocols

Optional

File Share protocols supported on the share.

Default value is [ NFSv3, NFSv4 ], if protocols is not specified or empty.