All Products
Search

This Product

    Cloud Storage Gateway:Manage SMB shares

    Document Center

    Cloud Storage Gateway:Manage SMB shares

    Last Updated:Jun 15, 2026

    Create, modify, disable, and delete Server Message Block (SMB) shares in the on-premises file gateway console. You can also configure Active Directory (AD) integration and manage SMB users.

    Prerequisites

    1. You have added a cache. For more information, see Add a cache.

    2. You have bound cloud resources. For more information, see Manage cloud resources.

    Background information

    Server Message Block (SMB) is a network file sharing protocol that enables communication between clients and servers. It operates on a client-server model.

    Cloud Storage Gateway (CSG) acts as an SMB server to provide file sharing services. When you access the gateway from a Windows client, CSG receives and responds to client requests.

    To use the CSG SMB service, first configure a shared directory in the CSG console and specify the users and permissions for it.

    Create an SMB share

    1. In a web browser, enter https://<IP address of your file gateway> to access the on-premises console for the file gateway.

    2. Enter your username and password, and then click OK.

    3. Select SMB and click Create.

    4. In the Create SMB dialog box, configure the following parameters.

      Parameter

      Description

      Share name

      The name of the SMB share.

      Read-only Users

      Users with read-only access to the SMB share.

      Read/write Users

      Users with read and write access to the SMB share.

      Enabled

      Whether the SMB share is enabled.

      If you want to disable this SMB share temporarily, select No.

      Browsable

      Whether the SMB share is discoverable in Network Neighborhood.

      Mode

      The mode in which the SMB share runs.

      • Replication Mode: All data is stored in two copies: one in the local cache and the other in Object Storage Service (OSS).

      • Cache Mode: The local cache stores all metadata and frequently accessed user data. OSS stores the full dataset.

      Remote Sync

      Synchronizes metadata from OSS to the local gateway. Use this feature for disaster recovery, data recovery, and data sharing.

      Note

      Remote Sync scans all objects in the bucket. If the bucket contains a large number of objects, OSS API request fees may apply. For more information, see the request fees in Object Storage Service Pricing.

      Bucket name

      Select an existing bucket.

      Subdirectory

      A subdirectory in the bucket.

      The subdirectory name can contain only letters and digits.

      Note

      Starting from version 1.0.38, you can map the root directory of the file system to a specific subdirectory in an OSS bucket to isolate access.

      The subdirectory can be an existing path or a new path in the OSS bucket. After the share is created, this subdirectory acts as the root directory. The system creates all subsequent files and directories under it.

      Use metadata disk

      When enabled, the data disk and metadata disk are separated. The metadata disk stores the metadata of the shared folder.

      • If you select Yes, you must specify the Metadata Disk and Data Disk.

      • If you select No, you must specify the Cache Path.

      Note

      This feature is available only to allowlisted users.

      Ignore Deletions

      Prevents file deletions from synchronizing to OSS, avoiding accidental data loss. OSS retains the full dataset.

      Sync delay

      The time the system waits before uploading a closed file. This prevents frequent local modifications from creating fragments in OSS. The default value is 5s, and the maximum value is 120s.

      Max write speed

      Maximum write speed. Up to 1,280 MB/s. The default value 0 indicates no limit.

      Max upload speed

      Maximum upload speed. Up to 1,280 MB/s. The default value 0 indicates no limit.

      Note

      If a speed limit is set, Max Upload Speed cannot be less than Max Write Speed.

      Fragmentation Optimization

      Improves performance for applications with frequent, random, small I/O operations. Enable with caution based on your use case.

      Upload Optimization

      Enables real-time cache reclamation. Suitable for backup-only scenarios.

    AD

    Active Directory (AD) is a directory service protocol for accessing and managing directory data over IP networks.

    • You must configure a DNS server before you can join an AD domain.

    • Only AD domain users or local users can be active at a time. When you join or leave an AD domain, the gateway automatically deletes the configured user permissions for the SMB share.

    • AD is supported only on 64-bit versions of Windows Server 2016 Datacenter and Windows Server 2012 R2 Datacenter.

    Configure AD

    1. Set the DNS server.

      1. In the on-premises file gateway console, click About.

      2. In the Network Configuration section, click Switch DNS Server.

      3. In the Switch DNS Server dialog box, add a DNS server and click Confirm.

        In the DNS Server field, enter the IP address of your AD server to resolve the AD domain name.

    2. Join the AD domain.

      1. Navigate to .

      2. In the Windows Active Directory (AD) section, click Add to AD.

      3. In the Add to Windows AD dialog box, configure the following settings and click Confirm.

        • Server IP Address: Enter the IP address of the AD server.

        • Username: Enter the administrator username.

        • Password: Enter the administrator password.

        After the gateway connects successfully, the Connected status in the Windows Active Directory (AD) section changes to Yes.

        Note

        • Joining an AD domain removes all local user permissions for the current SMB share.

        • CSG does not support joining a gateway to multiple domain controllers, such as both a parent domain and a child domain.

        • After the gateway joins an AD domain, user information can be queried only through the domain controller.

    Add SMB users

    If your gateway has not joined an AD domain, you can create local SMB users to access the file gateway. If the gateway is joined to an AD domain, the SMB Users page does not display user information. Query domain user information from the AD domain server instead.

    1. In the on-premises file gateway console, navigate to .

    2. Click Create.

    3. In the Add SMB User dialog box, enter a username and password.

    4. Click Confirm to create the user.

    Actions

    You can perform the following operations on the SMB page:

    Actions

    Description

    Disable an SMB share

    On the SMB page, click the switch in the upper-left corner to disable all SMB shares.

    To disable a single SMB share:

    On the SMB List tab, find the target SMB share, click Settings, and set the Start option to No.

    Delete an SMB share

    On the SMB List tab, find the target SMB share and click Delete.

    Warning

    • After an SMB share is deleted, its corresponding Windows mount point or mapped network drive becomes inaccessible immediately.

    • Deleting a share interrupts your services and data synchronization. Proceed with caution.

    Modify an SMB share

    On the SMB List tab, find the target SMB share, and then click Settings or Advanced Settings to modify the share.

    Refresh the cache

    On the SMB List tab, find the target SMB share and click Refresh Cache.

    Delete an SMB user

    On the SMB Users tab, find the target user and click Delete.

    Disconnect from AD

    On the AD tab, click End Connection to close the AD connection.

    Next steps

    Access an SMB share