# 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.2/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**.

![SMB cluster configuration tab](https://1970823310-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNqDzxyFrTFrLD641p0iH%2Fuploads%2FLRWKmmAyQcrnCGv5myfF%2Fwmng_smb_configure_button.png?alt=media\&token=e0b1ae41-ddeb-4274-b040-23d6cb612b59)

4\. In the SMB Cluster Configuration dialog, set the following properties:

* **Name**: A name for the SMB cluster. 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 sharing connections.
  * **desired**: Enables encryption negotiation and turns on data encryption for supported sessions and sharing connections.
  * **required**: Enforces data encryption on sessions and sharing 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.

{% 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://1970823310-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNqDzxyFrTFrLD641p0iH%2Fuploads%2FO4uur8vl7Rx8UbqoDWgz%2Fwmng_smb_configure_dialog_4.2.6.gif?alt=media&#x26;token=85429ef3-f1f4-43b4-9d5c-5748e637027f" 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://1970823310-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNqDzxyFrTFrLD641p0iH%2Fuploads%2Fg5gLJuQygdp2d6qmXypS%2Fwmng_smb_configure_result.png?alt=media\&token=212c44dd-25e5-46f2-8102-cb4c9124c4aa)

## 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://1970823310-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNqDzxyFrTFrLD641p0iH%2Fuploads%2F6S5d11begCBgt5gA8BVV%2Fwmng_smb_cluster_edit.png?alt=media&#x26;token=618b3874-b12c-42ee-8101-3300465cb3c4" alt=""><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://1970823310-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNqDzxyFrTFrLD641p0iH%2Fuploads%2FJI5x5xwDaWIfTY5hwDo8%2Fwmng_edit_smb_configuration.png?alt=media&#x26;token=a2fd3d95-3212-48a9-9c07-3309057a4d5e" 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**

Ensure the AD Domain Controllers are reachable by all WEKA servers participating in the SMB cluster. This resolution enables the WEKA servers to join the AD domain.

**Procedure**

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

<figure><img src="https://1970823310-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNqDzxyFrTFrLD641p0iH%2Fuploads%2FOL30YuebWJvFY7rZwsw0%2Fwmng_smb_join_ad_button.png?alt=media&#x26;token=dce7505b-80e1-40d7-a07c-8172176fdade" alt=""><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, a computer account is created for use by the SMB cluster.
   * **Server**: (Optional) WEKA automatically identifies an AD Domain Controller server based on the domain name. You do not need to set the server name. In some cases, specify the AD server if required.
   * **Computers Org. Unit**: The default AD organizational unit (OU) for the computer account is the Computers directory. You can define any OU in which to create the computer account that the joining account has permissions, such as SMB Servers or Corporate Computers.

![Join Active Directory dialog](https://1970823310-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNqDzxyFrTFrLD641p0iH%2Fuploads%2FtaOOuzYSI7A4XwHGAbfF%2Fwmng_smb_join_ad_dialog.png?alt=media\&token=cb7f0d09-4e14-4b44-9778-76b9cf4121a4)

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 to join the Active Directory domain.
{% endhint %}

## 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.

You can add servers to an SMB cluster already joined to an Active Directory domain.

#### 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://1970823310-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNqDzxyFrTFrLD641p0iH%2Fuploads%2FcUwl9fyncUY43VvFKOQr%2Fwmng_add_server_to_smb_cluser.gif?alt=media&#x26;token=f7e97446-53d1-488f-bd70-8e9df3f88ce0" 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. On the Servers pane, select Remove.
2. To remove one server, select the three dots next to the server to remove and select **Remove**.

<figure><img src="https://1970823310-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNqDzxyFrTFrLD641p0iH%2Fuploads%2F3GzZeYikVDvFFoQK062p%2Fwmng_remove_one_server.png?alt=media&#x26;token=040656bf-a3a7-4cc8-b963-0baaf245dd35" alt=""><figcaption><p>Remove one server from the SMB cluster</p></figcaption></figure>

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

<figure><img src="https://1970823310-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNqDzxyFrTFrLD641p0iH%2Fuploads%2FlnQjNO0utQmEHVGphh8r%2Fwmng_remove_few_servers.png?alt=media&#x26;token=21e289ba-f7ff-42eb-8d48-ce41b67e8ca7" 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://1970823310-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNqDzxyFrTFrLD641p0iH%2Fuploads%2F3sKAvrujcRFwuzVkZ8dl%2Fwmng_smb_cluster_remove.png?alt=media\&token=f4e74c4b-1bb9-4dab-a54b-529a49734954)

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://1970823310-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNqDzxyFrTFrLD641p0iH%2Fuploads%2FOMegbC70Pm5xdtBXYx2b%2Fwmng_smb_list_shares.png?alt=media\&token=74e68f5e-d6f6-4da3-b9c8-3ddd3c95f318)

## 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 1024). Each share must have a name and a shared path to the filesystem. It can be the root of the filesystem or a sub-directory.

**Procedure**

1. In the Shares tab, select **+Create**.
2. In the Add SMB Share dialog, set the following properties:
   * **Name**: A meaningful and valid name for the SMB share.&#x20;

     The name must meet the following requirements:

     * The share name must be no more than 80 characters in length.
     * The share name must not include the following characters: backslash (\\), slash (/), colon (:), and semicolon (;).
     * Control characters in the range 0x00 through 0x1F (inclusive) are prohibited.
   * **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).
   * **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.
3. Select **Save**.

![Add SMB Share dialog](https://1970823310-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNqDzxyFrTFrLD641p0iH%2Fuploads%2FRY3c8McMPVnnlIU1dKxr%2Fwmng_smb_share_add_dialog.png?alt=media\&token=ba86d5fd-50a5-4c9c-bcb9-60fdac3f48ca)

## 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 or not.

{% hint style="info" %}
SMB-W does not yet support share updates.
{% endhint %}

**Procedure**

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

<figure><img src="https://1970823310-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNqDzxyFrTFrLD641p0iH%2Fuploads%2FhZgyU9u0BMNxj0PeDKJS%2Fwmng_edit_smb_share_button.png?alt=media&#x26;token=2a7c78a7-e3b3-4623-b22d-a48e12068c7a" 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://1970823310-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNqDzxyFrTFrLD641p0iH%2Fuploads%2FUrmzbQW8OsKltGPJNC9E%2Fwmng_update_share_settings.png?alt=media&#x26;token=68027f7e-b165-403f-8e33-034b256b8e19" 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://1970823310-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNqDzxyFrTFrLD641p0iH%2Fuploads%2FDeP6GxnIWSQAwJgPVAkC%2Fwmng_smb_share_remove.png?alt=media\&token=7c27e704-6ce5-4ce0-9019-3c135374f930)

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