Manage SMB using the GUI
This page provides procedures for setting up an SMB cluster over WEKA filesystems and managing the cluster itself, using the GUI.
Last updated
This page provides procedures for setting up an SMB cluster over WEKA filesystems and managing the cluster itself, using the GUI.
Last updated
Using the GUI, you can:
Configure the SMB cluster (not applicable for legacy SMB)
An SMB cluster comprises at least three WEKA servers running the SMB-W stack.
Before you begin
Verify that the dedicated filesystem for persistent protocol configurations is created. If not, create it. For details, see
Procedure
From the menu, select Manage > Protocols.
From the Protocols pane, select SMB.
On the Configuration tab, select Configure.
In the SMB Cluster Configuration dialog, set the following properties:
Name: NetBIOS name for the SMB cluster must be 1-15 characters long, using only alphanumeric characters (A-Z, 0-9) and hyphens (-). Names are case-insensitive, cannot start with a hyphen, and must be unique within the network. Spaces and special characters are not allowed. This will be the name of the Active Directory computer object and the hostname part of the FQDN.
Domain: The Active Directory domain to join the SMB cluster.
Domain NetBIOS Name: (Optional) The domain NetBIOS name.
Encryption: Select the in-transit encryption mode to use in the SMB cluster:
enabled: Enables encryption negotiation but doesn't turn it on automatically for supported sessions and shared connections.
desired: Enables encryption negotiation and turns on data encryption for supported sessions and shared connections.
required: Enforces data encryption on sessions and shared connections. Clients that do not support encryption will be denied access to the server.
Servers: List 3-8 WEKA system servers to participate in the SMB cluster based on the server IDs in WEKA.
IPs: (Optional) List of virtual IPs (comma-separated) used as floating IPs for the SMB cluster to provide HA to clients. These IPs must be unique; do not assign these IPs to any host on the network. For an IP range, use the following format: a.b.c.x-y.
Config Filesystem: select the filesystem used for persisting cluster-wide protocol configurations.
Symbolic Link: Determines if symbolic links are allowed in the SMB cluster:
ON: Enables symbolic links. Use with caution, as it can introduce security risks by exposing data across shares.
OFF: Disables symbolic links, enhancing security by preventing link-based vulnerabilities.
Important: If a symbolic link in one share points to a file system in another share, users in the first share can access the data in the second share. Ensure you understand the security implications before enabling this option.
Due to cloud provider network limitations, setting a list of SMB floating IPs in all cloud installations is impossible. In this case, the SMB service must be accessed using the cluster nodes' primary addresses.
Select Save.
Once the system completes configuration, the server statuses change from not ready (❌) to ready (✅).
You can modify the encryption and IP settings according to your needs.
Procedure
In the SMB Cluster Configuration, select the pencil icon.
In the Edit SMB Configuration dialog, do the following:
Encryption: Select one of the in-transit encryption enforcements: enabled, desired, or required.
IPs: List of virtual IPs (comma-separated) used as floating IPs for the SMB cluster. (Floating IPs are not supported for cloud installations.)
3. Select Save.
To enable the SMB cluster to use Active Directory to resolve the access of users and user groups, join the SMB cluster to Active Directory (AD).
Before you begin
Procedure
In the SMB Cluster Configuration, select Join.
In the Join to Active Directory dialog, set the following properties:
Username and Password: A username and password of an account that has join privileges to the Active Directory domain. WEKA does not save these credentials. Instead, the SMB cluster creates a computer account for use.
Server: (Optional) WEKA automatically identifies an AD Domain Controller server based on the AD domain name. You do not need to set the server name. In some cases, specify the AD server if required. (This is not applicable for SMB-W yet.)
Computers Org. Unit: The default AD organizational unit (OU) for the computer account is the Computers directory. You can define any OU to create the computer account that the joining account has permission to, such as SMB servers or corporate computers. (This is not applicable for SMB-W yet.)
Once the SMB cluster joins the Active Directory domain, the join status next to the domain changes to Joined.
To join an existing SMB cluster to a different Active Directory domain, select Leave. To confirm the action, enter the username and password used to join the Active Directory domain.
The following procedures are provided for reference purposes. For specific steps related to your environment, contact your IT administrator.
Adding servers to the SMB cluster can provide several benefits and address various requirements, such as scalability, load balancing, high availability, and improved fault tolerance.
Before you begin
Ensure the SMB cluster is joined to an Active Directory domain. See Join the SMB cluster to Active Directory.
On the Servers pane, select Add.
In the Add SMB Cluster Servers dialog, select one or more available servers (a maximum of eight servers) from the list.
Select Save.
If the SMB cluster has more servers than you need, you can remove the server.
The minimum required number of servers in an SMB cluster is three.
To remove one server, select the three dots next to the server to remove and select Remove.
To remove more than one server, select the servers to remove from the Remove SMB Cluster Servers dialog (click the X), and select Save.
Deleting the SMB cluster resets its configuration data. Deleting an SMB cluster only applies to SMB-W.
In the SMB Cluster Configuration, select the trash icon.
In the SMB Configuration Reset message, select Reset.
The Shares tab displays the SMB shares created in the system. You can also customize the table columns of the SMB shares.
Procedure
From the menu, select Manage > Protocols.
From the Protocols pane, select SMB.
Select the Shares tab. You can filter the list using any column in the table.
Once the SMB cluster is created, you can create SMB shares (maximum of 1024). Each share must have a name and a shared path to the filesystem, which can be the root of the filesystem or a subdirectory
Before you begin
Ensure the SMB cluster is joined to the Active Directory. For details, see Join the SMB cluster to Active Directory.
Ensure the filesystem is already mounted and the directory you want to share is created in the filesystem. For details, see Mount filesystems;
Procedure
In the Shares tab, select +Create.
In the Add SMB Share dialog, set the following properties:
Name: A meaningful name for the SMB share.
Filesystem: The filesystem name that includes the directory to share. Select one from the list. A filesystem with Required Authentication set to ON cannot be used for SMB share.
Description: A description or purpose of the SMB share.
Path: A valid internal path, relative to the root, within the filesystem to expose the SMB share.
Encryption: Select in-transit encryption enforcement of the share. The global cluster encryption settings can affect the actual encryption.
Read Only: Select to set the share as read-only.
Hidden: Select if you want to hide the share so it is not visible when viewing the list of system shares.
Allow Guest Access: Select if you want guests to access without authentication.
Access Permissions: Define the share access permissions. If you select ON, select the access type and the users or groups allowed to access the share (comma-separated users and groups list, add '@' as a group prefix). Not supported in SMB-W.
Files/Directories POSIX Mode Mask: Set the new default file and directory permissions in a numeric (octal) format created through the share.
ACLs Enabled: Enables or disables Windows Access-Control Lists (ACLs) for the share. When enabled, WEKA applies the selected Access Control Model. Only applicable for SMB-W.
Access Control Model: Specifies the type of access control to use for the share. Options include POSIX, Windows, or Hybrid (default: POSIX). Hybrid ACL allows seamless interoperability between POSIX and Windows systems by exchanging permissions based on timestamps. The most recent permission, regardless of the system it originated from, takes precedence. Only applicable for SMB-W.
Case Sensitivity: Enables or disables case sensitivity for the specified SMB share (default: ON). When enabled, the share distinguishes between files with the same name but different capitalization. This option applies exclusively to the SMB-W cluster.
ADS: Enables using Alternate Data Streams (ADS) on a specified SMB share.
Possible values: ON, OFF (default: ON). For macOS clients, if ACLs are disabled (acl=off), set enable-ADS to off. For Windows clients, when enabled, ADS data is stored in the file’s extended attributes (XAttr), which consumes XAttr space.
Select Save.
You can update some of the SMB share settings. These include encryption, hiding the share, allowing guest access, and setting the share as read-only.
Procedure
In the Shares tab, select the three dots of the share and select Edit.
In the Update Share Settings dialog, update the relevant properties and select Save.
Procedure
In the Shares tab, select the three dots of the share and select Remove.
In the confirmation message that appears, select Confirm. The removed share no longer appears in the SMB Shares list.
