Data Object - VsanFileShareConfig(vim.vsan.FileShareConfig)

Property of: VsanFileShare
Parameter to: VsanCreateFileShare, VsanReconfigureFileShare
Extends: DynamicData
See also: KeyValue, VirtualMachineProfileSpec, VsanFileShareNetPermission
Since: vSAN API 7.0

Data Object Description

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.

Properties

Name	Type	Description
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.
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
permission*	VsanFileShareNetPermission[]	The permission parameters set for this file share. If this field is not set, then no user can access this file share.
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.
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

*Need not be set
Show WSDL type definition

         <complexType xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanFileShareConfig">
            <complexContent>
               <extension base="vsan:DynamicData">
                  <sequence>
                     <element name="name" type="xsd:string" minOccurs="0"/>
                     <element name="domainName" type="xsd:string" minOccurs="0"/>
                     <element name="quota" type="xsd:string" minOccurs="0"/>
                     <element name="softQuota" type="xsd:string" minOccurs="0"/>
                     <element name="labels" type="vsan:KeyValue" minOccurs="0" maxOccurs="unbounded"/>
                     <element name="storagePolicy" type="vsan:VirtualMachineProfileSpec" minOccurs="0"/>
                     <element name="permission" type="vsan:VsanFileShareNetPermission" minOccurs="0" maxOccurs="unbounded"/>
                  </sequence>
               </extension>
            </complexContent>
         </complexType>

vSAN Management API

Data Object - VsanFileShareConfig(vim.vsan.FileShareConfig)

Data Object Description