Get a Quote   (408) 943-4100               TrueNAS Discord      VendOp_Icon_15x15px   Commercial Support Toggle between Light and Dark mode

SMB Share Screen

  8 minute read.

Last Modified 2022-05-08 17:09 EDT

Use the Sharing SMB screen to setup SMB shares on your TrueNAS. Select Sharing > Windows Shares (SMB) to display the SMB screen.

SharingSMBScreen

Use Columns to change the information displayed in the table. Options are Unselect All, Path, Description, Enabled and Reset to Defaults.

Use Add to display the BASIC Options settings screen.

Use CANCEL to exit without saving and return to the main SMB screen.

Basic Options

SharingSMBBasicOptions

SettingDescription
PathUse the file browser or click the /mnt to select the pool, dataset or directory to share.
NameEnter a name for the SMB share.
PurposeSelect a preset configuration for the share to lock in predetermined values fo rthe share Advanced Options, including the Path Suffix. Select from the dropdown list. Options are No presets, Default share parameters, Multi-user time machine, Multi-protocol (AFP/SMB) shares, Multi-protocol (NFSv3/SMB) shares, Private SMB Datasets and Shares or SMB WORM. Files become readonly via SMB after 5 minutes. See “What do all the presets do?” for more information on presets.
Description
Enabled

The following table shows the preset options for the different Purposes and if those options are locked. An [x] indicates the option is enabled, [ ] means the option is disabled, and [text] indicates a specific value:

Default share parametersMulti-user time machineMulti-protocol (AFP/SMB) sharesMulti-protocol (NFSv3/SMB) sharesPrivate SMB Datasets and SharesFiles become readonly of SMB after 5 minutes
[x] Enable ACL (locked)[x] Enable ACL (unlocked)[x] Enable ACL (locked)[ ] Enable ACL (locked)[ ] Enable ACL (unlocked)[ ] Enable ACL (unlocked)
[ ] Export Read Only (locked)[ ] Export Read Only (unlocked)[ ] Export Read Only (unlocked)[ ] Export Read Only (unlocked)[ ] Export Read Only (unlocked)[ ] Export Read Only (unlocked)
[x] Browsable to Network Clients (locked)[x] Browsable to Network Clients (unlocked)[x] Browsable to Network Clients (unlocked)[x] Browsable to Network Clients (unlocked)[x] Browsable to Network Clients (unlocked)[x] Browsable to Network Clients (unlocked)
[ ] Allow Guest Access (unlocked)[ ] Allow Guest Access (unlocked)[ ] Allow Guest Access (unlocked)[ ] Allow Guest Access (unlocked)[ ] Allow Guest Access (unlocked)[ ] Allow Guest Access (unlocked)
[ ] Access Based Share Enumeration (locked)[ ] Access Based Share Enumeration (unlocked)[ ] Access Based Share Enumeration (unlocked)[ ] Access Based Share Enumeration (unlocked)[ ] Access Based Share Enumeration (unlocked)[ ] Access Based Share Enumeration (unlocked)
[ ] Hosts Allow (locked)[ ] Hosts Allow (unlocked)[ ] Hosts Allow (unlocked)[ ] Hosts Allow (unlocked)[ ] Hosts Allow (unlocked)[ ] Hosts Allow (unlocked)
[ ] Hosts Deny (locked)[ ] Hosts Deny (unlocked)[ ] Hosts Deny (unlocked)[ ] Hosts Deny (unlocked)[ ] Hosts Deny (unlocked)[ ] Hosts Deny (unlocked)
[ ] Use as Home Share (locked)[ ] Use as Home Share (unlocked)[ ] Use as Home Share (unlocked)[ ] Use as Home Share (unlocked)[ ] Use as Home Share (unlocked)[ ] Use as Home Share (unlocked)
[ ] Time Machine (locked)[ ] Time Machine (unlocked)[ ] Time Machine (unlocked)[ ] Time Machine (unlocked)[ ] Time Machine (unlocked)[ ] Time Machine (unlocked)
[x] Enable Shadow Copies (locked)[x] Enable Shadow Copies (unlocked)[x] Enable Shadow Copies (unlocked)[x] Enable Shadow Copies (unlocked)[x] Enable Shadow Copies (unlocked)[x] Enable Shadow Copies (unlocked)
[ ] Export Recycle Bin (locked)[ ] Export Recycle Bin (unlocked)[ ] Export Recycle Bin (unlocked)[ ] Export Recycle Bin (unlocked)[ ] Export Recycle Bin (unlocked)[ ] Export Recycle Bin (unlocked)
[ ] Use Apple-style Character Encoding (locked)[ ] Use Apple-style Character Encoding (unlocked)[x] Use Apple-style Character Encoding (locked)[x] Use Apple-style Character Encoding (unlocked)[x] Use Apple-style Character Encoding (unlocked)[x] Use Apple-style Character Encoding (unlocked)
[x] Enable Alternate Data Streams (locked)[x] Enable Alternate Data Streams (unlocked)[x] Enable Alternate Data Streams (locked)[ ] Enable Alternate Data Streams (locked)[ ] Enable Alternate Data Streams (unlocked)[ ] Enable Alternate Data Streams (unlocked)
[x] Enable SMB2/3 Durable Handles (locked)[x] Enable SMB2/3 Durable Handles (unlocked)[ ] Enable SMB2/3 Durable Handles (locked)[ ] Enable SMB2/3 Durable Handles (locked)[ ] Enable SMB2/3 Durable Handles (unlocked)[ ] Enable SMB2/3 Durable Handles (unlocked)
[ ] Enable FSRVP (locked)[ ] Enable FSRVP (unlocked)[ ] Enable FSRVP (locked)[ ] Enable FSRVP (unlocked)[ ] Enable FSRVP (unlocked)[ ] Enable FSRVP (unlocked)
[ ] Path Suffix (locked)[%U] Path Suffix (locked)[%U] Path Suffix (unlocked)[%U] Path Suffix (unlocked)[%U] Path Suffix (locked)[ ] Path Suffix (locked)
[ ] Auxiliary Parameters (unlocked)[ ] Auxiliary Parameters (unlocked)[ ] Auxiliary Parameters (unlocked)[ ] Auxiliary Parameters (unlocked)[ ] Auxiliary Parameters (unlocked)[ ] Auxiliary Parameters (unlocked)

Advanced Options

SharingSMBAdvancedOptions

Options are divided into Access and Other Options groups. Access options control various settings for allowing systems or users to access or modify the shared data.

SettingDescription
Enable ACLSelect to add Access Control List (ACL) support to the share. Leaving checkbox cleared disables ACL support and deletes any existing ACL for the share.
Export Read OnlySelect to prohibit writes to the share. Leave checkbox clear allows writes to the share.
Browsable to Network ClientsSelect to determine whether this share name is included when browsing shares. Home shares are only visible to the owner regardless of this setting.
Allow Guest AccessSelect to make privileges the same as the guest account. Guest access is disabled by default in Windows 10 version 1709 and Windows Server version 1903. Additional client-side configuration is required to provide guest access to these clients.

MacOS clients: Attempting to connect as a user that does not exist in FreeNAS does not automatically connect as the guest account. The Connect As: Guest option must be specifically chosen in MacOS to log in as the guest account. See the Apple documentation for more details.
Access Based Share Enumerationcheckbox
Hosts AllowEnter a list of allowed host names or IP addresses. Separate entries by pressing Enter. A more detailed description with examples see here.
Hosts DenyEnter a list of denied host names or IP addresses. Separate entries by pressing Enter.

The Hosts Allow and Hosts Deny fields work together to produce different situations:

  • If neither Hosts Allow or Hosts Deny contain an entry, then SMB share access is allowed for any host.
  • If there is an entry in Hosts Allow list but none in Hosts Deny list, then only allow hosts on the Hosts Allow list.
  • If there is an entry in Hosts Deny list but none in Hosts Allow list, then allow all hosts that are not on the Hosts Deny list.
  • If there are both an entry in Hosts Allow and Hosts Deny list, then allow all hosts that are on the Hosts Allow list. If there is a host not on the Hosts Allow and not on the Hosts Deny list, then allow it.

The Other Options have settings for improving Apple software compatibility, ZFS snapshot features, and other advanced features.

SettingDescription
Use as Home ShareSelect to allow the share to host user home directories. Each user is given a personal home directory when connecting to the share which is not accessible by other users. This allows for a personal, dynamic share. Only one share can be used as the home share. See the configuring Home Share article for detailed instructions.
Time MachineSelect to enable Apple Time Machine backups on this share.
Enable Shadow CopiesSelect to allow export ZFS snapshots as Shadow Copies for Microsoft Volume Shadow Copy Service (VSS) clients.
Export Recycle BinSelect to allow files that are deleted from the same dataset to moved to the Recycle Bin and not take any additional space. Deleting files over NFS removes the files permanently! When the files are in a different dataset or a child dataset, they are copied to the dataset where the Recycle Bin is located. To prevent excessive space usage, files larger than 20 MiB are deleted rather than moved. Adjust the Auxiliary Parameter crossrename:sizelimit= setting to allow larger files. For example, crossrename:sizelimit=50 allows moves of files up to 50 MiB in size. This means files can be permanently deleted or moved from the recycle bin. This is not a replacement for ZFS snapshots!
Use Apple-style Character EncodingSelect to enable this option converts NTFS illegal characters in the same manner as MacOS SMB clients. By default, Samba uses a hashing algorithm for NTFS illegal characters.
Enable Alternate Data StreamsSelect to allow multiple NTFS data streams. Leave checkbox clear and this option causes MacOS to write streams to files on the file system.
Enable SMB2/3 Durable HandlesSelect to allow using open file handles that can withstand short disconnections. Support for POSIX byte-range locks in Samba is also disabled. This option is not recommended when configuring multi-protocol or local access to files.
Enable FSRVPSelect to enable support for the File Server Remote VSS Protocol (FSVRP). This protocol allows Remote Procedure Call (RPC) clients to manage snapshots for a specific SMB share. The share path must be a dataset mountpoint. Snapshots have the prefix fss- followed by a snapshot creation timestamp. A snapshot must have this prefix for an RPC user to delete it.
Path SuffixAppends a suffix to the share connection path. This provides unique shares on a per-user, per-computer, or per-IP address basis. Suffixes can contain a macro. See the smb.conf manual page for a list of supported macros. The connectpath must be preset before a client connects.
Auxiliary ParametersAdditional smb.conf settings.

Use Submit to save setings, create the share and add it to the Sharing > Windows Shares (SMB) list.

Additional Information

SMB Service Screen

SMB Share Creation

Managing SMB Shares