| Local Properties | ||
Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
Name | Type | Description |
---|---|---|
affinityLocation* | xsd:string |
The affinity location for the vSAN File Share. The file share can
only be placed on the preferred fault domain or the secondary fault
domain. If this field is set when the cluster is not a stretched
cluster, an InvalidArgument will be thrown. To specify the
affinityLocation, at least two file server IPs should be specified
to serve the traffic for the preferred and secondary site, respectively.
Refer to #{vim.vsan.VsanSiteLocationType} for the supported values. In the
file share reconfiguration workflow, when the affinityLocation is not set, it
means to leave the original affinityLocation unchanged. Use the
#{vim.vsan.VsanSiteLocationType#None} to remove the current site affinity. See VsanSiteLocationType Since vSAN API vSAN 7.0U2 |
domainName* | xsd:string |
The name of the file service domain the file share belongs to. This
configuration is required for file share creation.
|
labels* | KeyValue[] |
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.
|
name* | xsd:string |
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 |
nfsSecType* | xsd:string |
Security type possible values are krb5, krb5i, krb5p and sys.
Only used for NFS shares. Default value is 'sys'.
For SMB share this should remain unset. See VsanFileShareNfsSecType Since vSAN API vSAN 7.0U1 |
permission* | VsanFileShareNetPermission[] |
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.
|
protocols* | xsd:string[] |
File Share protocols supported on the share.
Default value is [ NFSv3, NFSv4 ], if protocols is not specified or empty. See VsanFileProtocol Since vSAN API vSAN 7.0U1 |
quota* | xsd:string |
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.
|
smbOptions* | VsanFileShareSmbOptions |
The options of the SMB file share.
Since vSAN API vSAN 7.0U1 |
softQuota* | xsd:string |
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.
|
storagePolicy* | VirtualMachineProfileSpec |
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.
|
Properties inherited from DynamicData | ||
None |
Top of page | Local Properties | ||
Managed Object Types | Data Object Types | All Properties | All Methods |