SMB Management Using CLIs
This page details SMB management - setting up an SMB cluster over Weka filesystems and managing the cluster itself - using CLIs.
Overview
The Weka system has a number of CLI commands for setting up an SMB cluster over Weka filesystems. Used for managing the cluster itself, they are all located under theweka smb cluster
command. They define what Weka hosts will participate in the SMB cluster, and what (if any) public IPs will be exposed by the SMB cluster.
Showing an SMB Cluster
Command: weka smb cluster
Use this command to view information about the SMB cluster managed by the Weka system.
Showing an SMB Domain Configuration
Command: weka smb domain
Use this command to view information about the SMB domain configuration.
Creating an 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 <name> <domain> [--samba-hosts samba-hosts]... [--smb-ips-pool smb-ips-pool]... [--smb-ips-range smb-ips-range] [--domain-netbios-name domain-netbios-name] [--idmap-backend idmap-backend] [--joined-domain-mapping-from-id joined-domain-mapping-from-id] [--joined-domain-mapping-to-id joined-domain-mapping-to-id] [--default-domain-mapping-from-id default-domain-mapping-from-id] [--default-domain-mapping-to-id default-domain-mapping-to-id] [--encryption encryption]
Parameters in Command Line
Note: All IPs must reside on the same subnet, in order to enable HA through IP takeover.
Note: The IPs must be configured but MUST NOT be in use by any other application/host in the subnet, including Weka system management nodes, Weka system IO nodes, or Weka system NFS floating IPs. In AWS environments, this is not supported and these IPs should not be provided.
Note: The --smb-ips
parameter is supposed to accept the public IPs that the SMB cluster will expose. To mount the SMB cluster in an HA manner, clients should be mounted via one of the exposed public IPs, thereby ensuring that they will automatically reconnect if one of the SMB hosts fails.
Note: If it is necessary to set global options to the SMB library, contact the Weka Support Team.
For Example:
weka smb cluster create wekaSMB mydomain --samba-hosts 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 hosts 0-4. The SMB cluster is called wekaSMB,
the domain name is called mydomain
and is directed to use public IPs 1.1.1.1 to 1.1.1.5.
Checking Status of SMB Host Readiness
Command: weka smb cluster status
Use this command to check the status of the hosts which are part of the SMB cluster. Once all hosts are prepared and ready, it is possible to join an SMB cluster to an Active Directory.
Joining an SMB Cluster to an Active Directory
Command: weka smb domain join
Use the following command line to join an SMB domain to an Active Directory:
weka smb domain join <username> <password>
Parameters in Command Line
In order to join another Active Directory to the current SMB cluster configuration, it is necessary to leave the current Active Directory. This is performed using the following command line:
weka smb domain leave <username> <password>
On completion of this operation, it is possible to join another Active Directory to the SMB cluster.
Deleting 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/Remove Hosts from an SMB Cluster
Command: weka smb cluster hosts add/remove
Use these commands to add or remove hosts from the SMB cluster.
Note: This operation might take some time to complete. During that time, SMB IOs will be stalled.
Configuring Trusted Domains
Listing Trusted Domains
Command: weka smb cluster trusted-domains
Use this command to list all the configured trusted domains and their ID ranges.
Adding 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 in Command Line
Removing 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 in Command Line
Listing SMB Shares
Command: weka smb share
Use this command to list all existing SMB shares.
Adding SMB Shares
Command: weka smb share add
Use the following command line to add a new share to be exposed to SMB:
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] [--hidden hidden]
The mount mode for the SMB share is readcache
and cannot be modified.
Parameters in Command Line
Note: If it is necessary to set share specific options to the SMB library, contact the Weka Support Team.
For 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.
Updating 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]
Parameters in Command Line
Controlling SMB Shares Users 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 in Command Line
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 in Command Line
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 in Command Line
Removing 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 in Command Line
For Example: The following is an example for removing an SMB share defined as ID 1:
weka smb share remove 1
Controlling SMB Access Based on Hosts IP/Name
It is possible to control which hosts are permitted to access the SMB service or share.
Command: weka smb cluster host-access show
/ weka smb share host-access show
Use this command to view the various host-access settings.
Command: weka smb cluster host-access add
/ weka smb share host-access add
Use the following command line to add hosts to the allow/deny list (in either cluster-level or share-level):
weka smb cluster host-access add <mode> <--ips ips> <--hosts hosts>
weka smb share host-access add <share-id> <mode> <--ips ips> <--hosts hosts>
Parameters in Command Line
Command: weka smb cluster host-access remove
/ weka smb share host-access remove
Use the following command line to remove hosts from the allow/deny list (in either cluster-level or share-level):
weka smb cluster host-access remove <hosts>
weka smb share host-access remove <share-id> <hosts>
Parameters in Command Line
Command: weka smb cluster host-access reset
/ weka smb share host-access reset
Use the following command line to remove all hosts from the allow/deny list (in either cluster-level or share-level):
weka smb cluster host-access reset <mode>
weka smb share host-access reset <share-id> <mode>
Parameters in Command Line
Last updated