Adding SMB shares using the CLI

Content Software for File CLI Reference

Part Number


weka smb share add

Use the following command line to add a new share to be exposed to SMB:

weka smb share add <share-name> <fs-name> [--description description] [--internal-path internal-path] [--mount-option mount-option] [--file-create-mask file-create-mask] [--directory-create-mask directory-create-mask] [--obs-direct obs-direct] [--encryption encryption] [--read-only read-only] [--user-list-type user-list-type] [--users users]... [--allow-guest-access allow-guest-access] [--hidden hidden]


Name Type Value Limitations Mandatory Default
share-name String Name of the share being added Must be a valid name (ASCII) Yes  
fs-name String Name of the filesystem to share Must be a valid name. A filesystem set with required authentication cannot be used for SMB share. Yes  
description String Description of what the share will receive when viewed remotely Must be a valid string No No description
internal-path String The internal path within the filesystem (relative to its root) which will be exposed Must be a valid path No  
mount-option   The mount mode for the share. Possible values: readcache, writecache     readcache
file-create-mask String POSIX permissions for the file created through the SMB share Numeric (octal) notation No 0744
directory-create-mask String POSIX permissions for directories created through the SMB share Numeric (octal) notation No 0755

Enable Windows ACLs on the share (which is translated to POSIX). Supports up to 16 ACEs per file depending on the available space in the Extended Attribute (xattr). For details, see Filesystem Extended Attributes considerations. Possible values: on , off

obs-direct   A special mount option to bypass the time-based policies. For details, see Object store direct-mount option. Possible values for legacy SMB: on , off. SMB-W: not supported     off
encryption   The share encryption policy.

cluster_default: The share encryption policy follows the global SMB cluster setting.

desired : If negotiation is enabled globally, it turns on data encryption for this share for clients that support encryption.

required : Enforces encryption for the shares. Clients that do not support encryption are denied when accessing the share. If the global option is disabled , the access is restricted to these shares for all clients.

Possible value for SMB-W: cluster_default.

Possible values for legacy SMB: cluster_default , desired , required.

read-only   Sets the share as read-only. Users cannot create or modify files in this share.

Possible values: on , off

user-list-type   The type of initial permissions list for users .

SMB-W: not supported

Possible values for legacy SMB: read_only : List of users who have been denied write access to the shared resource write access to the share, regardless of the read-only setting.

read_write : List of users given write access to the share, regardless of the read-only setting.

valid : List of users that are allowed to log-in to this share SMB service (empty list all users are allowed) invalid

- list of users that are not allowed to log-in to this share SMB service

users   A list of users to use with the user-list-type list. Can use the @ notation to allow groups of users, e.g. root, Jack, @domain\admins .

SMB-W: not supported

Possible values for legacy SMB: Up to 8 users/groups for all lists combined per share.

    Empty list
allow-guest-access   Allows connecting to the SMB service without a password. Permissions are as the nobody user account permissions.

SMB-W: not supported.

Possible values for legacy SMB: on , off

hidden   Setst he share as non-browsable. It will be accessible for mounting and IOs but not discoverable by SMB clients. Possible values: on , off      
Note: If it is necessary to set share specific options to the SMB library, contact customer support.
For example: The following is an example for adding users to a share mounted on a filesystem named "default":
weka smb share add rootShare default
weka smb share add internalShare default --internal-path some/dir --description "Exposed share"
In this example, the first SMB share added has the Content Software for File system share for default. The second SMB share has internal for default.