The Weka CLI is installed on each Weka host and is available through the
weka command. Running this command will display a list of all available top-level commands:
$ wekaUsage:weka [<args>...] [options]weka --agentDescription:Base command for all the weka related CLIsThe available subcommands are:status Weka cluster statusalerts List and manage active alertsevents Commands for reading events and managing events settingsstats Commands for reading system statisticscluster Commands that manage the clusterfs Commands that manage filesystems, snapshots and filesystem-groupsnfs Commands that manage client-groups, permissions and interface-groupscloud Cloud commandsuser Manage users and loginlocal Commands that control weka and its containers on the local machineversion Commands that manager the installed weka versions on the hostagent Commands that control the weka agent (outside the weka containers)smb Commands for setting up and managing smb shares and usersdiags Commands for collecting weka-related diagnostics for supportUse 'weka --legal' for information about open-source librariesUse 'weka <command> --help' for more help on a specific command
Most Weka system top-level commands are the default list command for their own collection. Additional sub-commands may be available under them.
$ weka fs| FileSystem | Name | Group | SSD Bu | Total | Is re | Is creat | Is remov| ID | | | dget | Budget | ady | ing | ing+------------+---------+---------+--------+--------+-------+----------+----------| FSId: 0 | default | default | 57 GiB | 57 GiB | True | False | False
$ weka fs -hDescription:Commands that manage filesystems, snapshots and filesystem-groups.weka fs: List the system's filesystemsUsage:weka fs [--name=<name>]weka fs info [--filesystem=<name>]...weka fs create <name> <group-name> <total-capacity> [--ssd-capacity=<ssd>] [--filesystem-id=<id>]weka fs update <name> [--new-name=<new-name>] [--total-capacity=<total>] [--ssd-capacity=<ssd>]weka fs delete <name>weka fs restore <file-system> <source-name>weka fs <command> [<args>...] [options]Available subcommands:group Commands that manage filesystem-groupssnapshot Commands that manage snapshotstier Commands that fs tieringcapacity-events Commands that define & manage events alerts capacitySee 'weka fs <command> --help' for more help on a specific command
Most Weka system commands deliver the same result on all cluster hosts. However, it is sometimes necessary to execute a command on a specific host. This is performed using the
--hostname option and specifying the host name or IP address of the target host.
bash you can use auto-completion for CLI commands and parameters.
To use CLI auto-completion on a host, first, run
weka agent autocomplete install to install the script and re-enter your shell session.
You can also use
weka agent autocomplete export to get the bash completions script and write it to any desired location.
weka status command displays the overall status of the Weka system.
$ weka statusWeka v3.1 (CLI build 17No144)status: OK (6 hosts healthy)protection: 3+2 (with 2 hot spares)ssd storage: 57 GiB total, 0 bytes freereads: 0 bytes/s (0 IO/s)writes: 0 bytes/s (0 IO/s)
$ weka statusWeka v3.1 (CLI build 17No144)status: DEGRADED (1 host down, 5 hosts healthy)Rebuild in progress (3%)protection: 3+2 (with 2 hot spares)ssd storage: 42.75 GiB total, 0 bytes freereads: 0 bytes/s (0 IO/s)writes: 0 bytes/s (0 IO/s)