WEKA, now documented as NeuralMesh by WEKA, is run from the weka command-line tool on every cluster server. The rows follow the WEKA 5.1 documentation and CLI reference: health, alerts, drives, filesystems, snapshots, mounts, quotas, NFS, users and diagnostics. Most top-level commands also list their collection, so weka fs lists filesystems; weka -h, or -h after any command, shows the options. Capitalised words are placeholders; S3 and SMB setup and Kubernetes are left out.
Copy over a snapshotReplaces the destination snapshot with the contents of the source snapshot.
weka fs snapshot update FILE-SYSTEM NAME --new-name NEW-NAME
Rename a snapshotThe --access-point option of the same command renames the directory it is reached under.
weka fs snapshot upload FILE-SYSTEM SNAPSHOT
Upload a snapshotSnap-To-Object step; --site chooses local or remote when both kinds of bucket are attached.
weka fs snapshot download FILE-SYSTEM LOCATOR
Download a snapshotFor synchronous snapshots uploaded from version 4.3 or later; download them in chronological order.
weka fs download NAME GROUP-NAME TOTAL-CAPACITY SSD-CAPACITY OBS-BUCKET LOCATOR
Filesystem from an uploaded snapshotRecreates a filesystem from a snapshot in a local bucket, including a remote bucket mapped as local for recovery.
cd .snapshots
Open the snapshots directoryHidden from ls -la; inside a subdirectory it lists only snapshots taken after that directory was made.
Mounting 9
Between the backend list and the filesystem name, either / or :/ may be used.
Command
What it does
mount -t wekafs FS-NAME MOUNT-POINT
Mount on a persistent clientFor a client that has already joined the cluster; run as root and pass options with -o.
mount -t wekafs -o net=eth0 backend-1/my_fs /mnt/weka
Mount filesystemOn a stateless client the first mount installs the WEKA software and joins the cluster through the named backend.
mount -t wekafs -o num_cores=2 backend1,backend2,backend3/my_fs /mnt/weka
Mount through several backendsThe client can rejoin through any of the three backends and gets two frontend cores.
mount -t wekafs -o net=udp backend-server-0/my_fs /mnt/weka
Mount in UDP modeUses kernel UDP networking for hosts where DPDK is not available.
mount -o remount
Remount with new optionsChanging num_cores, memory_mb or the QoS options this way restarts the client container and pauses IO briefly.
mount /mnt/weka/my_fs
Test the fstab entryMounts through the wekafs line in /etc/fstab, the same entry that remounts the filesystem after a reboot.
mount | grep new_fs
Check that it is mountedShows the mount point, the wekafs type and the mount options in effect.
umount /mnt/weka
Unmount filesystemOn a stateless client the last unmount also disconnects it from the cluster and the agent removes the client software.
weka cluster mount-defaults show
Default mount optionsShows the QoS defaults that new mounts receive; existing mounts keep the values they started with.
Quotas 4
Command
What it does
weka fs quota set PATH --soft SOFT --hard HARD
Set a directory quotaThe filesystem has to be mounted, and a Data Services container runs the quota background task.
weka fs quota set --type user --id 1001 --soft 90GB --hard 100GB --filesystem default
Set a user quotaLimits UID 1001 on the default filesystem; group quotas use --type group with a GID.
weka fs quota list
List quotasShows only exceeded quotas unless --all is added.
weka fs quota enable-users FILESYSTEM
Enable user quota accountingA one-time step, run by a Data Services container, for filesystems made before release 5.1.20.
NFS, SMB and S3 14
Command
What it does
weka nfs interface-group
List NFS interface groups
weka nfs interface-group add NAME TYPE --subnet SUBNET --gateway GATEWAY
Create an interface groupThe type is NFS; the subnet is given as a mask such as 255.255.0.0.
weka nfs interface-group port add NAME CONTAINER-ID PORT
Add a port to a groupThe port is a network device of the given container, such as enp2s0.
weka nfs interface-group ip-range add NAME IPS
Add floating IPsTakes a range written like 10.0.1.101-118.
weka nfs client-group add NAME
Create a client group
weka nfs rules add ip NAME IP
Add an IP ruleMatches clients by subnet, e.g. 192.168.114.0/8; a dns rule matches a hostname instead.
weka nfs permission add FILESYSTEM GROUP
Grant a client group accessOptions set the path, permission type, root squashing and the anonymous UID and GID.
weka nfs permission
List NFS permissionsAdd --filesystem to show the permissions of one filesystem only.
weka nfs clients show
Connected NFS clientsPrints JSON per client, filtered by interface group, container or floating IP if wanted.
weka nfs global-config show
NFS global settings
weka smb cluster status
SMB container readiness
weka smb share
List SMB shares
weka s3 cluster status
S3 container readiness
weka s3 bucket list
List S3 buckets
Statistics 6
Command
What it does
weka stats
List statisticsValues are one-minute averages over the chosen period; only the real-time view is finer.
weka stats --category CATEGORY
Statistics of one categoryCategories are CPU, Object Store, Operations, Operations (NFS), Operations (Driver) and SSD.
weka stats --per-process
Statistics per processReports every process separately instead of adding them up.
weka stats realtime
Real-time statisticsRefreshes the performance figures of the processes every second.
weka stats list-types
List statistic typesAccepts a name or category such as api; --show-internal adds the internal ones.
weka stats retention set --days DAYS
Set statistics retentionWith --dry-run it only checks the disk capacity the retention period would need.
Users and login 10
Command
What it does
weka user
List usersShows each user with the source, such as Internal, and the role.
weka user login USERNAME PASSWORD
Log inSaves the credentials in the home directory, or in the token file named by --path or WEKA_TOKEN.
weka user logout
Log outDeletes the saved credentials from the WEKA_TOKEN file if one is set, otherwise from the home directory.
weka user whoami
Show the current userWEKA_USERNAME and WEKA_PASSWORD set in front of it check another account without logging in.
weka user add USERNAME ROLE
Create a local userRole is clusteradmin, tenantadmin, regular, readonly, s3 or csi; without a password argument the command asks for one.
weka user change-role USERNAME ROLE
Change a user's role
weka user passwd --username USERNAME
Set a passwordAn admin can set the password of any other user in the same tenant.
weka user revoke-tokens USERNAME
Revoke login tokens
weka user remove USERNAME
Delete a user
weka user ldap
Show LDAP settings
Diagnostics and versions 6
Command
What it does
weka diags collect
Collect diagnosticsKeeps the data on the cluster instead of uploading it, for sites without a WEKA Home connection.
weka diags upload
Upload diagnosticsReturns a Diags collection ID to pass to the Customer Success Team.
weka diags list
List diagnostics filesShows the collected dumps with their IDs, the first step of a disk cleanup.
weka local diags
Diagnostics of this serverAdd --collect-cluster-info for cluster data too, on one container at a time to spare the cluster.
weka version
Installed versionsWithout arguments it lists the versions on this machine; subcommands download and switch them.
weka version current
Current versionExits with a failure status when no version has been set.
CLI help and options 6
Command
What it does
weka -h
List top-level commandsMost of them double as the list command of their collection, as weka fs does.
weka fs -h
Help for one commandAny command accepts -h or --help and prints its options and subcommands.
weka --version
CLI version
weka status --HOST HOST
Run on a specific serverSends the command to the named server; setting WEKA_HOST has the same effect.
weka agent autocomplete install
Install bash completionRe-enter the shell afterwards; normally the script is already installed.
weka agent autocomplete uninstall
Disable bash completion
No row on this page matches that filter.
Notes
Reading cluster state
weka status is the first command on any server and reports whether the cluster is healthy, partially protected, rebuilding or unavailable; weka status rebuild shows how far a rebuild has come and the protection per fault level. weka alerts lists the current alerts, by default those of warning severity and above, and weka alerts describe explains every alert type with its corrective action. weka events is the event log, filterable by time, severity and type. weka cluster holds the commands for servers, containers, processes and drives, while weka local ps and weka local status report the containers on the server you are logged in to, which separates a problem on one host from one in the cluster.
Filesystems and mounts
weka fs lists filesystems with their group, SSD budget and total budget, and weka fs add NAME GROUP-NAME TOTAL-CAPACITY creates one inside a filesystem group; thin provisioning, tiering to an object store and QoS limits are options of the same command (the older action name create is still accepted). A client that has joined the cluster mounts with mount -t wekafs FS-NAME MOUNT-POINT; a stateless client names a backend, as in mount -t wekafs -o net=eth0 backend-1/my_fs /mnt/weka, and its first mount installs the client software and joins the cluster. umount /mnt/weka unmounts, and on a stateless client the last unmount also disconnects and removes the client. weka fs snapshot add FILE-SYSTEM NAME takes a snapshot, which weka fs snapshot upload FILE-SYSTEM SNAPSHOT copies to an object store bucket (Snap-To-Object). weka nfs interface-group lists the interface groups through which NFS clients reach the cluster when they do not run the WEKA client.
Statistics, users and support
weka stats reads performance statistics averaged over one-minute intervals for a chosen period and category, such as CPU, SSD or Operations; weka stats realtime shows the current values once per second. weka user lists users with their source and role, and weka user login USERNAME PASSWORD saves a login token that later commands use. For a support case, weka diags upload collects diagnostics from the cluster, uploads them to WEKA Home and prints a collection ID for the Customer Success Team; weka diags collect saves the same data on the cluster when WEKA Home cannot be reached.
Questions
Is it weka fs add or weka fs create?
Both run. The CLI documents weka fs add NAME GROUP-NAME TOTAL-CAPACITY, and create and new remain aliases of add so that older scripts keep working; remove likewise still answers to delete and destroy.
How is a failed drive replaced from the CLI?
Find it with weka cluster drive -F node=invalid -o id,uuid,host,hostname,node,status, run weka cluster drive deactivate DRIVE-UUID and weka cluster drive remove DRIVE-UUID, swap the device, add it with weka cluster drive add HOST-ID DEVICE-PATH using the old host ID, and follow the rebuild in weka status until the new drive is ACTIVE.
Where does weka user login keep the credentials?
In the home directory of the user who ran it, unless --path names a token file; pointing the WEKA_TOKEN environment variable at that file makes later commands use it. weka user logout removes the saved credentials again.
What does WEKA support need with a new case?
The output of weka diags upload: it collects diagnostics from the servers, uploads them to WEKA Home and prints a Diags collection ID to send to the Customer Success Team. Without a WEKA Home connection, weka diags collect saves the data locally so it can be shared another way.