# Manage SMB using the GUI

Using the GUI, you can:

* [Configure the SMB cluster](#configure-the-smb-cluster) (not applicable for legacy SMB)
* [Edit the SMB cluster](#edit-the-smb-cluster)
* [Join the SMB cluster to Active Directory](#join-the-smb-cluster-in-the-active-directory)
* [Add servers to the SMB cluster](#add-or-remove-smb-cluster-hosts)
* [Remove servers from the SMB cluster](#delete-the-smb-cluster)
* [Delete the SMB cluster](#delete-the-smb-cluster)
* [Display the SMB shares list](#display-the-smb-shares-list)
* [Add an SMB share](#add-an-smb-share)
* [Edit an SMB share](#edit-an-smb-share)
* [Remove an SMB share](#remove-an-smb-share)

## **Configure the SMB cluster** <a href="#configure-the-smb-cluster" id="configure-the-smb-cluster"></a>

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 [#dedicated-filesystem-requirement-for-persistent-protocol-configurations](https://docs.weka.io/4.3/additional-protocols-overview#dedicated-filesystem-requirement-for-persistent-protocol-configurations "mention")

**Procedure**

1. From the menu, select **Manage > Protocols**.
2. From the Protocols pane, select **SMB**.
3. On the Configuration tab, select **Configure**.
4. 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.

{% hint style="warning" %}
**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.
{% endhint %}

{% hint style="info" %}
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.
{% endhint %}

5. Select **Save**.

<figure><img src="https://2959395192-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlGKb8DZItQx3Jy6unw5f%2Fuploads%2FMWCZgKzv26Q3xtgachiG%2Fwmng_smb_configure_dialog_4.3.5.gif?alt=media&#x26;token=babc2c27-4e20-47df-bfa7-a0083a4b966d" alt=""><figcaption><p>SMB cluster configuration</p></figcaption></figure>

Once the system completes configuration, the server statuses change from not ready (❌) to ready (✅).

![SMB cluster configuration example](https://2959395192-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlGKb8DZItQx3Jy6unw5f%2Fuploads%2FmdbiAJo3SurHP45rlfPX%2Fwmng_smb_configure_result.png?alt=media\&token=56b9db4b-4c31-487c-a63e-42c1cdb98065)

## Edit the SMB cluster <a href="#edit-the-smb-cluster" id="edit-the-smb-cluster"></a>

You can modify the encryption and IP settings according to your needs.

**Procedure**

1. In the SMB Cluster Configuration, select the **pencil** icon.

<figure><img src="https://2959395192-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlGKb8DZItQx3Jy6unw5f%2Fuploads%2FNnooSDbr4ts9OM4hJHRi%2Fwmng_smb_cluster_edit.png?alt=media&#x26;token=278cde0a-8201-4cb2-9b5d-fb3057bfe5e1" alt="" width="338"><figcaption><p>Edit the SMB cluster</p></figcaption></figure>

2. In the Edit SMB Configuration dialog, do the following:
   * **Encryption:** Select one of the in-transit encryption enforcements: enabled, desired, or required.
   * &#x20;**IPs:** List of virtual IPs (comma-separated) used as floating IPs for the SMB cluster. (Floating IPs are not supported for cloud installations.)

<figure><img src="https://content.gitbook.com/content/lGKb8DZItQx3Jy6unw5f/blobs/Vv1vc15yspjtRFfaHRaC/wmng_edit_smb_configuration.png" alt=""><figcaption><p>Edit SMB configuration</p></figcaption></figure>

3\. Select **Save**.

## Join the SMB cluster to Active Directory <a href="#join-the-smb-cluster-in-the-active-directory" id="join-the-smb-cluster-in-the-active-directory"></a>

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**

<details>

<summary>Resolve the AD domain controllers</summary>

Add the AD DNS configuration to every SMB protocol backend.&#x20;

Follow these steps:

1. Access the CLI.
2. Edit the `/etc/resolv.conf` file to include the DNS settings specific to your domain.

For example, your configuration might look like this:

```bash
nameserver 8.8.8.8
nameserver 8.8.4.4
search example.com
```

Replace `8.8.8.8` and `8.8.4.4` with the appropriate nameserver IP addresses for your domain and `example.com` with your actual domain name.

</details>

**Procedure**

1. In the SMB Cluster Configuration, select **Join**.

<figure><img src="https://2959395192-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlGKb8DZItQx3Jy6unw5f%2Fuploads%2FRH5ba2x3fo9q6imrR3s4%2Fwmng_smb_join_ad_button.png?alt=media&#x26;token=11602086-57e8-4e54-92ff-8dd41eb59898" alt="" width="338"><figcaption><p>Join the SMB cluster in the Active Directory</p></figcaption></figure>

2. 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.)

![Join Active Directory dialog](https://2959395192-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlGKb8DZItQx3Jy6unw5f%2Fuploads%2FVmMyy8Ukb3JOFM4ouwaS%2Fwmng_smb_join_ad_dialog.png?alt=media\&token=53f734fd-4a0c-47e0-a356-00d8e199317b)

Once the SMB cluster joins the Active Directory domain, the join status next to the domain changes to **Joined**.

{% hint style="info" %}
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.
{% endhint %}

### Post-configuration in the DNS Manager and Active Directory

{% hint style="info" %}
The following procedures are provided for reference purposes. For specific steps related to your environment, contact your IT administrator.
{% endhint %}

<details>

<summary>Add an <strong>A</strong> record for SMB protocol backends</summary>

1. **Open DNS Manager:** Navigate to **Start > Programs > Administrative Tools > DNS**.
2. **Access DNS zones:** In the DNS Manager console, double-click the DNS server name to display the list of zones.
3. Open **Forward Lookup Zones.**
4. **Create a new A record:** Right-click on the relevant domain and select **New Record**.
5. **Enter record details:**
   * Specify the name (for example, TAZ) and the IP address of the backend server.
   * Select the record type as **A**.
6. **Configure record options:**
   * Select the **Create Associated PTR record** option.
   * Select the **Allow any authenticated user to update DNS record with the same owner name** option.
7. **Finalize the Record:** Select **OK** to add the new A record.

</details>

<details>

<summary>Set UID and GID for SMB protocol backends</summary>

Repeat the following steps for every backend participating in the SMB protocol.

1. Navigate to **Start > Programs > Administrative Tools > Active Directory Users and Computers**.
2. In the **Computers** section, right-click on an SMB protocol backend and select **Properties**.
3. Go to the **Attribute Editor** tab and modify the following:
   * Locate the **uidNumber** attribute and set its value to **0**.
   * Locate the **gidNumber** attribute and set its value to **0**.
4. Select **OK** to save the changes.

</details>

<details>

<summary>Set UID and GID for SMB users</summary>

Repeat the following steps for every user consuming WEKA services over the SMB protocol.

1. Navigate to **Start > Programs > Administrative Tools > Active Directory Users and Computers**.
2. In the **Users** section, right-click on a user consuming WEKA services over the SMB protocol and select **Properties**.
3. Go to the **Attribute Editor** tab and modify the following:
   * Locate the **uidNumber** attribute and set its value to an appropriate number or, if unknown, any numeric value between 0 and 4290000000.
   * Locate the **gidNumber** attribute and set its value to an appropriate number or, if unknown, any numeric value between 0 and 4290000000.
4. Select **OK** to save the changes.

</details>

## Add servers to the SMB cluster <a href="#add-or-remove-smb-cluster-hosts" id="add-or-remove-smb-cluster-hosts"></a>

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-in-the-active-directory](#join-the-smb-cluster-in-the-active-directory "mention").

#### Procedure

1. On the Servers pane, select **Add**.
2. In the Add SMB Cluster Servers dialog, select one or more available servers (a maximum of eight servers) from the list.
3. Select **Save**.

<figure><img src="https://2959395192-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlGKb8DZItQx3Jy6unw5f%2Fuploads%2Fm2KN78clB0t6gmgwMIAW%2Fwmng_add_server_to_smb_cluser.png?alt=media&#x26;token=3a764236-fb26-4ad6-a710-b8938d7d79df" alt=""><figcaption><p>Add servers to the SMB cluster</p></figcaption></figure>

## Remove servers from the SMB cluster <a href="#delete-the-smb-cluster" id="delete-the-smb-cluster"></a>

&#x20;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.&#x20;

#### Procedure

1. To remove one server, select the three dots next to the server to remove and select **Remove**.

<figure><img src="https://2959395192-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlGKb8DZItQx3Jy6unw5f%2Fuploads%2FamFec0LucmTKAa6sbtTQ%2Fwmng_remove_one_server.png?alt=media&#x26;token=a317aec6-8b45-41d6-bbcd-15668b73eb32" alt=""><figcaption><p>Remove one server from the SMB cluster</p></figcaption></figure>

2. To remove more than one server, select the servers to remove from the Remove SMB Cluster Servers dialog (click the **X**), and select **Save**.

<figure><img src="https://2959395192-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlGKb8DZItQx3Jy6unw5f%2Fuploads%2FJk3Vhi1Ih54cdlOmtkhl%2Fwmng_remove_few_servers.png?alt=media&#x26;token=1bbdb964-0759-49fb-bb99-cd704637bd47" alt=""><figcaption><p>Remove more than one server from the SMB cluster</p></figcaption></figure>

## Delete the SMB cluster <a href="#delete-the-smb-cluster" id="delete-the-smb-cluster"></a>

Deleting the SMB cluster resets its configuration data. Deleting an SMB cluster only applies to SMB-W.

#### **Procedure**

1. In the SMB Cluster Configuration, select the **trash** icon.

![Delete the SMB cluster configuration](https://2959395192-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlGKb8DZItQx3Jy6unw5f%2Fuploads%2FyD83imYfnv4huxcQJhk4%2Fwmng_smb_cluster_remove.png?alt=media\&token=cc9f2539-fe53-4078-bc2f-c0cc7b2e504a)

2. In the SMB Configuration Reset message, select **Reset**.

## **Display the SMB shares list** <a href="#display-the-smb-shares-list" id="display-the-smb-shares-list"></a>

The Shares tab displays the SMB shares created in the system. You can also customize the table columns of the SMB shares.

**Procedure**

1. From the menu, select **Manage > Protocols**.
2. From the Protocols pane, select **SMB**.
3. Select the **Shares** tab.\
   You can filter the list using any column in the table.

![SMB shares list](https://content.gitbook.com/content/lGKb8DZItQx3Jy6unw5f/blobs/txb3z81H2RzBBQrV5uyo/wmng_smb_list_shares.png)

## Add an SMB share <a href="#add-an-smb-share" id="add-an-smb-share"></a>

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-in-the-active-directory](#join-the-smb-cluster-in-the-active-directory "mention").
* Ensure the filesystem is already mounted and the directory you want to share is created in the filesystem. For details, see [mounting-filesystems](https://docs.weka.io/4.3/weka-filesystems-and-object-stores/mounting-filesystems "mention"); &#x20;

**Procedure**

1. In the Shares tab, select **+Create**.
2. 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. Not supported in SMB-W.
   * **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**: Determines whether to enable the Windows Access-Control Lists (ACLs) on the share. Weka translates the ACLs to POSIX.
   * **Case Sensitivity**: Enables or disables case sensitivity for the specified SMB share. When enabled, the share distinguishes between files with the same name but different capitalization. This option applies exclusively to the SMB-W cluster.
3. Select **Save**.

<figure><img src="https://2959395192-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlGKb8DZItQx3Jy6unw5f%2Fuploads%2FeSqIuqjK84wfcJp2bBWW%2Fwmng_smb_share_add_dialog.png?alt=media&#x26;token=bfbce583-475a-42e3-9a5f-4d360f792f64" alt=""><figcaption></figcaption></figure>

<details>

<summary>Access the share from Windows</summary>

1. Right-click on **This PC**.
2. Select **Map network drive**.
3. In the **Folder** field, enter the path to the share, for example, `\\wekasmb\mynewshare`.
4. If prompted, enter the required credentials.

</details>

## Edit an SMB share <a href="#edit-an-smb-share" id="edit-an-smb-share"></a>

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**

1. In the Shares tab, select the three dots of the share and select **Edit**.

<figure><img src="https://content.gitbook.com/content/lGKb8DZItQx3Jy6unw5f/blobs/tCKzOgGzQ9nQE5EirFyv/wmng_edit_smb_share_button.png" alt=""><figcaption><p>Edit an SMB share</p></figcaption></figure>

2. In the Update Share Settings dialog, update the relevant properties and select **Save**.

<figure><img src="https://content.gitbook.com/content/lGKb8DZItQx3Jy6unw5f/blobs/Y6Pf0LMXZx2Nu7VWLfMi/wmng_update_share_settings.png" alt="" width="563"><figcaption><p>Update the SMB share settings</p></figcaption></figure>

## Remove an SMB share <a href="#remove-an-smb-share" id="remove-an-smb-share"></a>

**Procedure**

1. In the Shares tab, select the three dots of the share and select **Remove**.

![Remove an SMB share](https://content.gitbook.com/content/lGKb8DZItQx3Jy6unw5f/blobs/thYClUFHzhmGyTDT7mhY/wmng_smb_share_remove.png)

2. In the confirmation message that appears, select **Confirm**.\
   The removed share no longer appears in the SMB Shares list.