Managing the system using the Content Software for File CLI

Content Software for File CLI Reference

Part Number

The Content Software for File CLI is installed on each Content Software for File host and is available through the weka command. It's possible to connect to any of the hosts using ssh and running the weka command. The weka command displays a list of all top-level commands.

$ weka -h
    weka [--help] [--build] [--version] [--legal]

    The base command for all weka-related CLIs

   agent      Commands that control the weka agent (outside the weka containers)
   alerts     List alerts in the Weka cluster
   cloud      Cloud commands. List the cluster's cloud status, if no subcommand supplied.
   cluster    Commands that manage the cluster
   diags      Diagnostics commands to help understand the status of the cluster and its environment
   events     List all events that conform to the filter criteria
   fs         List filesystems defined in this Weka cluster
   local      Commands that control weka and its containers on the local machine
   mount      Mounts a wekafs filesystem. This is the helper utility installed at /sbin/mount.wekafs.
   nfs        Commands that manage client-groups, permissions and interface-groups
   org        List organizations defined in the Weka cluster
   security   Security commands.
   smb        Commands that manage Weka's SMB container
   stats      List all statistics that conform to the filter criteria
   status     Get an overall status of the Weka cluster
   umount     Unmounts wekafs filesystems. This is the helper utility installed at /sbin/umount.wekafs.
   user       List users defined in the Weka cluster
   version    When run without arguments, lists the versions available on this machine. Subcommands allow for
              downloading of versions, setting the current version and other actions to manage versions.
   s3         Commands that manage Weka's S3 container

   --agent         Start the agent service
   -h, --help      Show help message
   --build         Prints the CLI build number and exits
   -v, --version   Prints the CLI version and exits
   --legal         Prints software license information and exits

The options that are common to many commands include:

Option Flag description
-J |--json Prints the raw JSON value returned by the cluster.
-H |--hostname Directs the CLI to communicate with the cluster through the specified hostname or IP.
-raw-units Sets the units such as capacity and bytes to be printed in their raw format, as returned by the cluster.
--UTC Sets the timestamps to be printed in UTC timezone, instead of the local time of the server running the CLI command.
-f |--format Specifies the format to output the result (view, csv, markdown, or JSON).
-o |--output Specifies the columns to include in the output.
-s |--sort Specifies the order to sort the output. May include a '+' or '-' before the column name to sort by ascending or descending order.
-F | --filter Specifies the filter values for a member (without forcing it to be in the output).
--no-header Indicates that the column header should not be shown when printing the output.
C |--CONNECT-TIMEOUT Modifies the default timeout used for connecting to the system via the JRPC protocol.
T |--TIMEOUT Modifies the default timeout for which the commands wait for a response before giving up.