Manage SMB using the CLI
This page provides procedures for setting up an SMB cluster over WEKA filesystems and managing the cluster itself, using the CLI.
Using the CLI, you can manage both SMB-W and legacy SMB:
Show the SMB cluster
Command: weka smb cluster
Use this command to view information about the SMB cluster managed by the WEKA system.
Show the SMB domain configuration
Command: weka smb domain
Use this command to view information about the SMB domain configuration.
Create the SMB cluster
Command: weka smb cluster create
Use the following command line to create a new SMB cluster to be managed by the WEKA system:
weka smb cluster create <netbios-name> <domain> <config-fs-name> [--domain-netbios-name domain-netbios-name] [--idmap-backend idmap-backend] [--default-domain-mapping-from-id default-domain-mapping-from-id] [--default-domain-mapping-to-id default-domain-mapping-to-id] [--joined-domain-mapping-from-id joined-domain-mapping-from-id] [--joined-domain-mapping-to-id joined-domain-mapping-to-id] [--encryption encryption] [--smb-conf-extra smb-conf-extra] [--container-ids container-ids]... [--smb-ips-pool smb-ips-pool]... [--smb-ips-range smb-ips-range]...[--symlink symlink]
The weka smb cluster create
command creates an SMB-W cluster. To create a legacy SMB cluster, contact the Customer Success Team.
Parameters
To enable HA through IP takeover, all IPs must reside on the same subnet.
The floating IPs configured but MUST NOT be in use by any other application/server in the subnet, including WEKA system management nodes, WEKA system IO nodes, or WEKA system NFS floating IPs. Setting a list of SMB floating IPs in all-cloud installations is impossible due to cloud provider network limitations. In this case, the SMB service must be accessed by using the primary addresses of the cluster nodes.
The --smb-ips
parameter must accept the virtual IPs that the SMB cluster exposes. To mount the SMB cluster in an high-availability manner, clients must be connected through one of the exposed virtual IPs, thereby ensuring that they automatically reconnect if one of the SMB containers fail.
If setting the global options to the SMB library is required, contact the Customer Success Team.
Example:
weka smb cluster create wekaSMB mydomain --container-ids 0,1,2,3,4 --smb-ips-pool 1.1.1.1,1.1.1.2 --smb-ips-range 1.1.1.3-5
In this example of a full command, an SMB cluster is configured over the WEKA system containers 0-4. The SMB cluster is called wekaSMB,
the domain name is called mydomain
, and is directed to use virtual IPs 1.1.1.1
to 1.1.1.5
.
Update the SMB cluster
Command: weka smb cluster update
Use the following command line to update an existing SMB cluster:
weka smb cluster update [--encryption encryption] [--smb-ips-pool smb-ips-pool]... [--smb-ips-range smb-ips-range]...[--symlink symlink]
Parameters
Check the status of SMB cluster readiness
Command: weka smb cluster status
The SMB cluster is comprised of three to eight SMB containers. Use this command to check the status of the SMB containers that are part of the SMB cluster. Once all the SMB containers are prepared and ready, it is possible to join an SMB cluster to an Active Directory domain.
Join an SMB cluster in Active Directory
Command: weka smb domain join
Use the following command line to join the SMB cluster to an Active Directory domain:
weka smb domain join <username> <password> [--server server] [--create-computer create-computer]
Ensure the AD servers are resolvable to all WEKA servers. This resolution enables the WEKA servers to join the AD domain.
Parameters
To join an existing SMB cluster to another Active Directory domain, leave the current Active Directory using the following command line:
weka smb domain leave <username> <password>
On completion of this operation, it is possible to join the SMB cluster to another Active Directory domain.
Delete an SMB cluster
Command: weka smb cluster destroy
Use this command to destroy an SMB cluster managed by the Weka system.
Deleting an existing SMB cluster managed by the WEKA system does not delete the backend WEKA filesystems but removes the SMB share exposures of these filesystems.
Add or remove SMB cluster containers
Command: weka smb cluster containers add
Command: weka smb cluster containers remove
Use these commands to add or remove containers from the SMB cluster.
weka smb cluster containers add [--containers-id containers-id]...
weka smb cluster containers remove [--containers-id containers-id]...
This operation might take some time to complete. During that time, SMB IOs are stalled.
Parameters
Configure trusted domains
List trusted domains
Command: weka smb cluster trusted-domains
Use this command to list all the configured trusted domains and their ID ranges.
Add trusted domains
Command: weka smb cluster trusted-domains add
Use the following command line to add an SMB trusted domain:
weka smb cluster trusted-domains add <domain-name> <from-id> <to-id>
Parameters
Remove trusted domains
Command: weka smb cluster trusted-domains remove
Use the following command line to remove an SMB-trusted domain:
weka smb cluster trusted-domains remove <domain-id>
Parameters
List SMB shares
Command: weka smb share
Use this command to list all existing SMB shares.
Add an SMB share
Command: weka smb share add
Use the following command line to add a new share to be exposed by SMB. Ensure the SMB cluster is joined to the Active Directory. For details, see Join an SMB cluster in Active Directory.
weka smb share add <share-name> <fs-name> [--description description] [--internal-path internal-path] [--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] [enable-ADS enable-ADS] [--hidden hidden] [--case-sensitivity case-sensitivity]
The mount mode for the SMB share is readcache
and cannot be modified.
Parameters
If it is necessary to set a share with specific options to the SMB library, contact the Customer Success Team.
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 WEKA system share for default. The second SMB share has internal for default.
Update SMB shares
Command: weka smb share update
Use the following command line to update an existing share:
weka smb share update <share-id> [--encryption encryption] [--read-only read-only] [--allow-guest-access allow-guest-access] [--hidden hidden]
Parameters
Control SMB share user-lists
Command: weka smb share lists show
Use this command to view the various user-list settings.
Command: weka smb share lists add
Use the following command line to add users to a share user-list:
weka smb share lists add <share-id> <user-list-type> <--users users>...
Parameters
Command: weka smb share lists remove
Use the following command line to remove users from a share user-list:
weka smb share lists remove <share-id> <user-list-type> <--users users>...
Parameters
Command: weka smb share lists reset
Use the following command line to remove all users from a share user-list:
weka smb share lists reset <share-id> <user-list-type>
Parameters
Remove SMB shares
Command: weka smb share remove
Use the following command line to remove a share exposed to SMB:
weka smb share remove <share-id>
Parameters
Example: The following is an example of removing an SMB share defined as ID 1:
weka smb share remove 1
Control SMB access based on hosts' IP/name
You can control which hosts are permitted to access the SMB share. The maximum number of share host access definitions across all shares is 1024.
SMB-W supports access based on the host IP addresses (but not host names).
Command: weka smb share host-access list
Use this command to view the various host access settings.
Command: weka smb share host-access add
Use the following command line to add a host to the allow/deny list:
weka smb share host-access add <share-id> <mode> <--ips ips> <--hosts hosts>
Parameters
Command: weka smb share host-access remove
Use the following command line to remove hosts from the allow or deny list.
weka smb share host-access remove <share-id> <hosts>
Parameters
Command: weka smb share host-access reset
Use the following command line to remove all hosts from the allow or deny list:
weka smb share host-access reset <share-id> <mode>
Parameters
Last updated