CLI reference guide

This CLI reference guide is generated from the output of running the weka command with the help option. It provides detailed descriptions of available commands, arguments, and options.

weka

The base command for all weka related CLIs

weka [--color color] [--help] [--build] [--version] [--legal]
Parameter
Description

--agent

Start the agent service

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-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

weka access-group

Commands that manage the cluster access-groups

weka access-group [--color color] [--help]
Parameter
Description

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-h, --help

Show help message

weka access-group status

Show the status of the access-groups

weka access-group status [--color color]
                         [--HOST HOST]
                         [--PORT PORT]
                         [--CONNECT-TIMEOUT CONNECT-TIMEOUT]
                         [--TIMEOUT TIMEOUT]
                         [--profile profile]
                         [--help]
                         [--json]
Parameter
Description

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-H, --HOST

Specify the host. Alternatively, use the WEKA_HOST env variable

-P, --PORT

Specify the port. Alternatively, use the WEKA_PORT env variable

-C, --CONNECT-TIMEOUT

Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

-T, --TIMEOUT

Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--profile

Name of the connection and authentication profile to use

-h, --help

Show help message

-J, --json

Format output as JSON

weka access-group enable

Enable access-groups

weka access-group enable [--color color]
                         [--HOST HOST]
                         [--PORT PORT]
                         [--CONNECT-TIMEOUT CONNECT-TIMEOUT]
                         [--TIMEOUT TIMEOUT]
                         [--profile profile]
                         [--help]
                         [--json]
Parameter
Description

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-H, --HOST

Specify the host. Alternatively, use the WEKA_HOST env variable

-P, --PORT

Specify the port. Alternatively, use the WEKA_PORT env variable

-C, --CONNECT-TIMEOUT

Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

-T, --TIMEOUT

Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--profile

Name of the connection and authentication profile to use

-h, --help

Show help message

-J, --json

Format output as JSON

weka access-group disable

Disable access-groups

weka access-group disable [--color color]
                          [--HOST HOST]
                          [--PORT PORT]
                          [--CONNECT-TIMEOUT CONNECT-TIMEOUT]
                          [--TIMEOUT TIMEOUT]
                          [--profile profile]
                          [--help]
                          [--json]
Parameter
Description

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-H, --HOST

Specify the host. Alternatively, use the WEKA_HOST env variable

-P, --PORT

Specify the port. Alternatively, use the WEKA_PORT env variable

-C, --CONNECT-TIMEOUT

Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

-T, --TIMEOUT

Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--profile

Name of the connection and authentication profile to use

-h, --help

Show help message

-J, --json

Format output as JSON

weka agent

Commands that control the weka agent (outside the weka containers)

weka agent [--color color] [--help]
Parameter
Description

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-h, --help

Show help message

weka agent install-agent

Installs Weka agent on the machine the command is executed from

weka agent install-agent [--agent-port agent-port] [--color color] [--no-update] [--no-start] [--help]
Parameter
Description

--agent-port

The port to listen on for incoming requests

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

--no-update

Don't update the locally installed containers

--no-start

Do not register the weka-agent service and start it after its creation

-h, --help

Show help message

weka agent update-containers

Update the currently available containers and version specs to the current agent version. This command does not update weka, only the container's representation on the local machine.

weka agent update-containers [--color color] [--help]
Parameter
Description

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-h, --help

Show help message

weka agent uninstall

Deletes all Weka files, drivers, shared memory and any other remainder from the machine this command is executed from. WARNING - This action is destructive and might cause a loss of data!

weka agent uninstall [--color color] [--force] [--ignore-wekafs-mounts] [--keep-files] [--help]
Parameter
Description

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

--force

Force the action to actually happen

--ignore-wekafs-mounts

Proceed even with active wekafs mounts

--keep-files

Do not remove Weka version images and keep in installation directory

-h, --help

Show help message

weka agent autocomplete

Bash autocompletion utilities

weka agent autocomplete [--color color] [--help]
Parameter
Description

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-h, --help

Show help message

weka agent autocomplete install

Locally install bash autocompletion utility

weka agent autocomplete install [--color color] [--help]
Parameter
Description

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-h, --help

Show help message

weka agent autocomplete uninstall

Locally uninstall bash autocompletion utility

weka agent autocomplete uninstall [--color color] [--help]
Parameter
Description

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-h, --help

Show help message

weka agent autocomplete export

Export bash autocompletion script

weka agent autocomplete export [--color color] [--help]
Parameter
Description

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-h, --help

Show help message

weka alerts

List alerts in the Weka cluster

weka alerts [--color color]
            [--HOST HOST]
            [--PORT PORT]
            [--CONNECT-TIMEOUT CONNECT-TIMEOUT]
            [--TIMEOUT TIMEOUT]
            [--profile profile]
            [--format format]
            [--output output]...
            [--sort sort]...
            [--filter filter]...
            [--muted]
            [--help]
            [--no-header]
            [--verbose]
Parameter
Description

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-H, --HOST

Specify the host. Alternatively, use the WEKA_HOST env variable

-P, --PORT

Specify the port. Alternatively, use the WEKA_PORT env variable

-C, --CONNECT-TIMEOUT

Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

-T, --TIMEOUT

Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--profile

Name of the connection and authentication profile to use

-f, --format

Specify in what format to output the result (format: 'view', 'csv', 'markdown', 'json' or 'oldview')

-o, --output...

Specify which columns to output. May include any of the following: muted,type,count,title,description,action (may be repeated or comma-separated)

-s, --sort...

Specify which column(s) to take into account when sorting the output. May include a '+' or '-' before the column name to sort in ascending or descending order respectively. Usage: [+

-F, --filter...

Specify what values to filter by in a specific column. Usage: column1=val1[,column2=val2[,..]] (may be repeated or comma-separated)

--muted

List muted alerts alongside the unmuted ones

-h, --help

Show help message

--no-header

Don't show column headers when printing the output

-v, --verbose

Show all columns in output

weka alerts types

List all alert types that can be returned from the Weka cluster

weka alerts types [--color color]
                  [--HOST HOST]
                  [--PORT PORT]
                  [--CONNECT-TIMEOUT CONNECT-TIMEOUT]
                  [--TIMEOUT TIMEOUT]
                  [--profile profile]
                  [--help]
                  [--json]
Parameter
Description

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-H, --HOST

Specify the host. Alternatively, use the WEKA_HOST env variable

-P, --PORT

Specify the port. Alternatively, use the WEKA_PORT env variable

-C, --CONNECT-TIMEOUT

Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

-T, --TIMEOUT

Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--profile

Name of the connection and authentication profile to use

-h, --help

Show help message

-J, --json

Format output as JSON

weka alerts mute

Mute an alert-type. Muted alerts will not appear in the list of active alerts. It is required to specify a duration for the mute. Once the set duration concludes, the alert-type will automatically be unmuted.

weka alerts mute <alert-type>
                 <duration>
                 [--color color]
                 [--HOST HOST]
                 [--PORT PORT]
                 [--CONNECT-TIMEOUT CONNECT-TIMEOUT]
                 [--TIMEOUT TIMEOUT]
                 [--profile profile]
                 [--help]
Parameter
Description

alert-type*

An alert-type to mute, use weka alerts types to list types

duration*

How long to mute this alert type for (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-H, --HOST

Specify the host. Alternatively, use the WEKA_HOST env variable

-P, --PORT

Specify the port. Alternatively, use the WEKA_PORT env variable

-C, --CONNECT-TIMEOUT

Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

-T, --TIMEOUT

Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--profile

Name of the connection and authentication profile to use

-h, --help

Show help message

weka alerts unmute

Unmute an alert-type which was previously muted.

weka alerts unmute <alert-type>
                   [--color color]
                   [--HOST HOST]
                   [--PORT PORT]
                   [--CONNECT-TIMEOUT CONNECT-TIMEOUT]
                   [--TIMEOUT TIMEOUT]
                   [--profile profile]
                   [--help]
Parameter
Description

alert-type*

An alert-type to unmute, use weka alerts types to list types

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-H, --HOST

Specify the host. Alternatively, use the WEKA_HOST env variable

-P, --PORT

Specify the port. Alternatively, use the WEKA_PORT env variable

-C, --CONNECT-TIMEOUT

Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

-T, --TIMEOUT

Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--profile

Name of the connection and authentication profile to use

-h, --help

Show help message

weka alerts describe

Describe all the alert types that might be returned from the weka cluster (including explanations and how to handle them)

weka alerts describe [--color color]
                     [--HOST HOST]
                     [--PORT PORT]
                     [--CONNECT-TIMEOUT CONNECT-TIMEOUT]
                     [--TIMEOUT TIMEOUT]
                     [--profile profile]
                     [--format format]
                     [--output output]...
                     [--sort sort]...
                     [--filter filter]...
                     [--help]
                     [--no-header]
                     [--verbose]
Parameter
Description

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-H, --HOST

Specify the host. Alternatively, use the WEKA_HOST env variable

-P, --PORT

Specify the port. Alternatively, use the WEKA_PORT env variable

-C, --CONNECT-TIMEOUT

Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

-T, --TIMEOUT

Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--profile

Name of the connection and authentication profile to use

-f, --format

Specify in what format to output the result (format: 'view', 'csv', 'markdown', 'json' or 'oldview')

-o, --output...

Specify which columns to output. May include any of the following: type,title,action (may be repeated or comma-separated)

-s, --sort...

Specify which column(s) to take into account when sorting the output. May include a '+' or '-' before the column name to sort in ascending or descending order respectively. Usage: [+

-F, --filter...

Specify what values to filter by in a specific column. Usage: column1=val1[,column2=val2[,..]] (may be repeated or comma-separated)

-h, --help

Show help message

--no-header

Don't show column headers when printing the output

-v, --verbose

Show all columns in output

weka cloud

Cloud commands. List the cluster's cloud status, if no subcommand supplied.

weka cloud [--color color] [--help]
Parameter
Description

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-h, --help

Show help message

weka cloud status

Show cloud connectivity status

weka cloud status [--color color]
                  [--HOST HOST]
                  [--PORT PORT]
                  [--CONNECT-TIMEOUT CONNECT-TIMEOUT]
                  [--TIMEOUT TIMEOUT]
                  [--profile profile]
                  [--format format]
                  [--output output]...
                  [--sort sort]...
                  [--filter filter]...
                  [--help]
                  [--no-header]
                  [--verbose]
Parameter
Description

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-H, --HOST

Specify the host. Alternatively, use the WEKA_HOST env variable

-P, --PORT

Specify the port. Alternatively, use the WEKA_PORT env variable

-C, --CONNECT-TIMEOUT

Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

-T, --TIMEOUT

Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--profile

Name of the connection and authentication profile to use

-f, --format

Specify in what format to output the result (format: 'view', 'csv', 'markdown', 'json' or 'oldview')

-o, --output...

Specify which columns to output. May include any of the following: host,health (may be repeated or comma-separated)

-s, --sort...

Specify which column(s) to take into account when sorting the output. May include a '+' or '-' before the column name to sort in ascending or descending order respectively. Usage: [+

-F, --filter...

Specify what values to filter by in a specific column. Usage: column1=val1[,column2=val2[,..]] (may be repeated or comma-separated)

-h, --help

Show help message

--no-header

Don't show column headers when printing the output

-v, --verbose

Show all columns in output

weka cloud enable

Turn cloud features on

weka cloud enable [--cloud-url cloud]
                  [--cloud-stats on/off]
                  [--color color]
                  [--HOST HOST]
                  [--PORT PORT]
                  [--CONNECT-TIMEOUT CONNECT-TIMEOUT]
                  [--TIMEOUT TIMEOUT]
                  [--profile profile]
                  [--help]
Parameter
Description

--cloud-url

The base url of the cloud service

--cloud-stats

Enable or disable uploading stats to the cloud (format: 'on' or 'off')

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-H, --HOST

Specify the host. Alternatively, use the WEKA_HOST env variable

-P, --PORT

Specify the port. Alternatively, use the WEKA_PORT env variable

-C, --CONNECT-TIMEOUT

Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

-T, --TIMEOUT

Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--profile

Name of the connection and authentication profile to use

-h, --help

Show help message

weka cloud disable

Turn cloud features off

weka cloud disable [--color color]
                   [--HOST HOST]
                   [--PORT PORT]
                   [--CONNECT-TIMEOUT CONNECT-TIMEOUT]
                   [--TIMEOUT TIMEOUT]
                   [--profile profile]
                   [--help]
Parameter
Description

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-H, --HOST

Specify the host. Alternatively, use the WEKA_HOST env variable

-P, --PORT

Specify the port. Alternatively, use the WEKA_PORT env variable

-C, --CONNECT-TIMEOUT

Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

-T, --TIMEOUT

Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--profile

Name of the connection and authentication profile to use

-h, --help

Show help message

weka cloud proxy

Get or set the HTTP proxy used to connect to cloud services

weka cloud proxy [--color color]
                 [--HOST HOST]
                 [--PORT PORT]
                 [--CONNECT-TIMEOUT CONNECT-TIMEOUT]
                 [--TIMEOUT TIMEOUT]
                 [--profile profile]
                 [--set url]
                 [--help]
                 [--json]
                 [--unset]
Parameter
Description

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-H, --HOST

Specify the host. Alternatively, use the WEKA_HOST env variable

-P, --PORT

Specify the port. Alternatively, use the WEKA_PORT env variable

-C, --CONNECT-TIMEOUT

Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

-T, --TIMEOUT

Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--profile

Name of the connection and authentication profile to use

-s, --set

Set a new proxy setting

-h, --help

Show help message

-J, --json

Format output as JSON

-u, --unset

Remove the HTTP proxy setting

weka cloud update

Update cloud settings

weka cloud update <bucket-name>
                  <region>
                  <access-key-id>
                  <secret-key>
                  [--session-token token]
                  [--bucket-prefix prefix]
                  [--proxy proxy]
                  [--bytes-per-second bytes-per-second]
                  [--color color]
                  [--HOST HOST]
                  [--PORT PORT]
                  [--CONNECT-TIMEOUT CONNECT-TIMEOUT]
                  [--TIMEOUT TIMEOUT]
                  [--profile profile]
                  [--help]
Parameter
Description

bucket-name*

AWS bucket name

region*

AWS region

access-key-id*

AWS access key

secret-key*

AWS secret

--session-token

S3 session token

--bucket-prefix

S3 bucket prefix

--proxy

HTTP(S) proxy to connect to the cloud through

--bytes-per-second

Maximum uploaded bytes per second

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-H, --HOST

Specify the host. Alternatively, use the WEKA_HOST env variable

-P, --PORT

Specify the port. Alternatively, use the WEKA_PORT env variable

-C, --CONNECT-TIMEOUT

Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

-T, --TIMEOUT

Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--profile

Name of the connection and authentication profile to use

-h, --help

Show help message

weka cloud upload-rate

Get the cloud upload rate

weka cloud upload-rate [--color color]
                       [--HOST HOST]
                       [--PORT PORT]
                       [--CONNECT-TIMEOUT CONNECT-TIMEOUT]
                       [--TIMEOUT TIMEOUT]
                       [--profile profile]
                       [--help]
                       [--json]
Parameter
Description

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-H, --HOST

Specify the host. Alternatively, use the WEKA_HOST env variable

-P, --PORT

Specify the port. Alternatively, use the WEKA_PORT env variable

-C, --CONNECT-TIMEOUT

Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

-T, --TIMEOUT

Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--profile

Name of the connection and authentication profile to use

-h, --help

Show help message

-J, --json

Format output as JSON

weka cloud upload-rate set

Set the cloud upload rate

weka cloud upload-rate set [--bytes-per-second bps]
                           [--color color]
                           [--HOST HOST]
                           [--PORT PORT]
                           [--CONNECT-TIMEOUT CONNECT-TIMEOUT]
                           [--TIMEOUT TIMEOUT]
                           [--profile profile]
                           [--help]
Parameter
Description

--bytes-per-second

Maximum uploaded bytes per second

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-H, --HOST

Specify the host. Alternatively, use the WEKA_HOST env variable

-P, --PORT

Specify the port. Alternatively, use the WEKA_PORT env variable

-C, --CONNECT-TIMEOUT

Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

-T, --TIMEOUT

Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--profile

Name of the connection and authentication profile to use

-h, --help

Show help message

weka cluster

Commands that manage the cluster

weka cluster [--color color] [--help]
Parameter
Description

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-h, --help

Show help message

weka cluster create

Form a Weka cluster from hosts that just had Weka installed on them

weka cluster create [--admin-password admin-password]
                    [--color color]
                    [--HOST HOST]
                    [--PORT PORT]
                    [--CONNECT-TIMEOUT CONNECT-TIMEOUT]
                    [--TIMEOUT TIMEOUT]
                    [--profile profile]
                    [--host-ips host-ips]...
                    [--help]
                    [--json]
                    [<host-hostnames>]...
Parameter
Description

host-hostnames...

A list of hostnames to be included in the new cluster

--admin-password

The password for the cluster admin user; will be set to the default password if not provided

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-H, --HOST

Specify the host. Alternatively, use the WEKA_HOST env variable

-P, --PORT

Specify the port. Alternatively, use the WEKA_PORT env variable

-C, --CONNECT-TIMEOUT

Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

-T, --TIMEOUT

Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--profile

Name of the connection and authentication profile to use

--host-ips...

Management IP addresses; If empty, the hostnames will be resolved; If hosts are highly-available or mixed-networking, use IP set '++...+'; (may be repeated or comma-separated)

-h, --help

Show help message

-J, --json

Format output as JSON

weka cluster update

Update cluster configuration

weka cluster update [--cluster-name cluster-name]
                    [--data-drives data-drives]
                    [--parity-drives parity-drives]
                    [--scrubber-bytes-per-sec scrubber-bytes-per-sec]
                    [--color color]
                    [--HOST HOST]
                    [--PORT PORT]
                    [--CONNECT-TIMEOUT CONNECT-TIMEOUT]
                    [--TIMEOUT TIMEOUT]
                    [--profile profile]
                    [--help]
Parameter
Description

--cluster-name

Cluster name

--data-drives

Number of RAID data drives

--parity-drives

Number of RAID protection parity drives

--scrubber-bytes-per-sec

Rate of RAID scrubbing in units per second (format: capacity in decimal or binary units: 1B, 1KB, 1MB, 1GB, 1TB, 1PB, 1EB, 1KiB, 1MiB, 1GiB, 1TiB, 1PiB, 1EiB)

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-H, --HOST

Specify the host. Alternatively, use the WEKA_HOST env variable

-P, --PORT

Specify the port. Alternatively, use the WEKA_PORT env variable

-C, --CONNECT-TIMEOUT

Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

-T, --TIMEOUT

Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--profile

Name of the connection and authentication profile to use

-h, --help

Show help message

weka cluster process

List the cluster processes

weka cluster process [--color color]
                     [--HOST HOST]
                     [--PORT PORT]
                     [--CONNECT-TIMEOUT CONNECT-TIMEOUT]
                     [--TIMEOUT TIMEOUT]
                     [--profile profile]
                     [--format format]
                     [--container container]...
                     [--role role]...
                     [--output output]...
                     [--sort sort]...
                     [--filter filter]...
                     [--local]
                     [--backends]
                     [--clients]
                     [--leadership]
                     [--leader]
                     [--help]
                     [--raw-units]
                     [--UTC]
                     [--no-header]
                     [--verbose]
                     [<process-ids>]...
Parameter
Description

process-ids...

Only return these processes IDs.

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-H, --HOST

Specify the host. Alternatively, use the WEKA_HOST env variable

-P, --PORT

Specify the port. Alternatively, use the WEKA_PORT env variable

-C, --CONNECT-TIMEOUT

Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

-T, --TIMEOUT

Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--profile

Name of the connection and authentication profile to use

-f, --format

Specify in what format to output the result (format: 'view', 'csv', 'markdown', 'json' or 'oldview')

--container...

Only return the processes of these container IDs, if not specified the weka-processes for all the containers will be returned (may be repeated or comma-separated)

--role...

Only return processes with these roles (format: 'management', 'frontend', 'compute', 'drives' or 'dataserv', may be repeated or comma-separated)

-o, --output...

Specify which columns to output. May include any of the following: uid,id,containerId,slot,hostname,container,ips,status,software,release,role,mode,netmode,cpuId,core,socket,numa,cpuModel,memory,uptime,fdName,fdId,traceHistory,fencingReason,joinRejectReason,failureText,failure,failureTime,failureCode (may be repeated or comma-separated)

-s, --sort...

Specify which column(s) to take into account when sorting the output. May include a '+' or '-' before the column name to sort in ascending or descending order respectively. Usage: [+

-F, --filter...

Specify what values to filter by in a specific column. Usage: column1=val1[,column2=val2[,..]] (may be repeated or comma-separated)

--local

Get result from local weka host

-b, --backends

Only return backend containers

-c, --clients

Only return client containers

-l, --leadership

Only return containers that are part of the cluster leadership

-L, --leader

Only return the cluster leader

-h, --help

Show help message

-R, --raw-units

Print values in raw units (bytes, seconds, etc.). When not set, sizes are printed in human-readable format, e.g 1KiB 234MiB 2GiB.

-U, --UTC

Print times in UTC. When not set, times are converted to the local time of this host.

--no-header

Don't show column headers when printing the output

-v, --verbose

Show all columns in output

weka cluster bucket

List the cluster buckets, logical compute units used to divide the workload in the cluster

weka cluster bucket [--color color]
                    [--HOST HOST]
                    [--PORT PORT]
                    [--CONNECT-TIMEOUT CONNECT-TIMEOUT]
                    [--TIMEOUT TIMEOUT]
                    [--profile profile]
                    [--format format]
                    [--output output]...
                    [--sort sort]...
                    [--filter filter]...
                    [--help]
                    [--raw-units]
                    [--UTC]
                    [--no-header]
                    [--verbose]
                    [<bucket-ids>]...
Parameter
Description

bucket-ids...

Only return these bucket IDs.

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-H, --HOST

Specify the host. Alternatively, use the WEKA_HOST env variable

-P, --PORT

Specify the port. Alternatively, use the WEKA_PORT env variable

-C, --CONNECT-TIMEOUT

Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

-T, --TIMEOUT

Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--profile

Name of the connection and authentication profile to use

-f, --format

Specify in what format to output the result (format: 'view', 'csv', 'markdown', 'json' or 'oldview')

-o, --output...

Specify which columns to output. May include any of the following: id,leader,term,lastActiveTerm,state,council,uptime,leaderVersionSig,electableMode,sourceMembers,nonSourceMembers,fillLevel (may be repeated or comma-separated)

-s, --sort...

Specify which column(s) to take into account when sorting the output. May include a '+' or '-' before the column name to sort in ascending or descending order respectively. Usage: [+

-F, --filter...

Specify what values to filter by in a specific column. Usage: column1=val1[,column2=val2[,..]] (may be repeated or comma-separated)

-h, --help

Show help message

-R, --raw-units

Print values in raw units (bytes, seconds, etc.). When not set, sizes are printed in human-readable format, e.g 1KiB 234MiB 2GiB.

-U, --UTC

Print times in UTC. When not set, times are converted to the local time of this host.

--no-header

Don't show column headers when printing the output

-v, --verbose

Show all columns in output

weka cluster failure-domain

List the Weka cluster failure domains

weka cluster failure-domain [--color color]
                            [--HOST HOST]
                            [--PORT PORT]
                            [--CONNECT-TIMEOUT CONNECT-TIMEOUT]
                            [--TIMEOUT TIMEOUT]
                            [--profile profile]
                            [--format format]
                            [--output output]...
                            [--sort sort]...
                            [--filter filter]...
                            [--show-removed]
                            [--help]
                            [--raw-units]
                            [--UTC]
                            [--no-header]
                            [--verbose]
Parameter
Description

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-H, --HOST

Specify the host. Alternatively, use the WEKA_HOST env variable

-P, --PORT

Specify the port. Alternatively, use the WEKA_PORT env variable

-C, --CONNECT-TIMEOUT

Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

-T, --TIMEOUT

Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--profile

Name of the connection and authentication profile to use

-f, --format

Specify in what format to output the result (format: 'view', 'csv', 'markdown', 'json' or 'oldview')

-o, --output...

Specify which columns to output. May include any of the following: uid,fd,active_drives,failed_drives,total_drives,removed_drives,containers,total_containers,drive_proces,total_drive_proces,compute_proces,total_compute_proces,capacity (may be repeated or comma-separated)

-s, --sort...

Specify which column(s) to take into account when sorting the output. May include a '+' or '-' before the column name to sort in ascending or descending order respectively. Usage: [+

-F, --filter...

Specify what values to filter by in a specific column. Usage: column1=val1[,column2=val2[,..]] (may be repeated or comma-separated)

--show-removed

Show drives that were removed from the cluster

-h, --help

Show help message

-R, --raw-units

Print values in raw units (bytes, seconds, etc.). When not set, sizes are printed in human-readable format, e.g 1KiB 234MiB 2GiB.

-U, --UTC

Print times in UTC. When not set, times are converted to the local time of this host.

--no-header

Don't show column headers when printing the output

-v, --verbose

Show all columns in output

weka cluster hot-spare

Get or set the number of hot-spare failure-domains in the cluster. If param is not given, the current number of hot-spare FDs will be listed

weka cluster hot-spare [--color color]
                       [--HOST HOST]
                       [--PORT PORT]
                       [--CONNECT-TIMEOUT CONNECT-TIMEOUT]
                       [--TIMEOUT TIMEOUT]
                       [--profile profile]
                       [--skip-resource-validation]
                       [--help]
                       [--json]
                       [--raw-units]
                       [--UTC]
                       [<count>]...
Parameter
Description

count...

The number of failure-domains

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-H, --HOST

Specify the host. Alternatively, use the WEKA_HOST env variable

-P, --PORT

Specify the port. Alternatively, use the WEKA_PORT env variable

-C, --CONNECT-TIMEOUT

Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

-T, --TIMEOUT

Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--profile

Name of the connection and authentication profile to use

--skip-resource-validation

Skip verifying that the cluster has enough RAM and SSD resources allocated for the hot-spare

-h, --help

Show help message

-J, --json

Format output as JSON

-R, --raw-units

Print values in raw units (bytes, seconds, etc.). When not set, sizes are printed in human-readable format, e.g 1KiB 234MiB 2GiB.

-U, --UTC

Print times in UTC. When not set, times are converted to the local time of this host.

weka cluster start-io

Start IO services

weka cluster start-io [--color color]
                      [--HOST HOST]
                      [--PORT PORT]
                      [--CONNECT-TIMEOUT CONNECT-TIMEOUT]
                      [--TIMEOUT TIMEOUT]
                      [--profile profile]
                      [--help]
Parameter
Description

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-H, --HOST

Specify the host. Alternatively, use the WEKA_HOST env variable

-P, --PORT

Specify the port. Alternatively, use the WEKA_PORT env variable

-C, --CONNECT-TIMEOUT

Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

-T, --TIMEOUT

Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--profile

Name of the connection and authentication profile to use

-h, --help

Show help message

weka cluster stop-io

Stop IO services

weka cluster stop-io [--color color]
                     [--HOST HOST]
                     [--PORT PORT]
                     [--CONNECT-TIMEOUT CONNECT-TIMEOUT]
                     [--TIMEOUT TIMEOUT]
                     [--profile profile]
                     [--brutal-no-flush]
                     [--keep-external-containers]
                     [--force]
                     [--help]
Parameter
Description

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-H, --HOST

Specify the host. Alternatively, use the WEKA_HOST env variable

-P, --PORT

Specify the port. Alternatively, use the WEKA_PORT env variable

-C, --CONNECT-TIMEOUT

Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

-T, --TIMEOUT

Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--profile

Name of the connection and authentication profile to use

--brutal-no-flush

Force stopping IO services immediately without graceful flushing of ongoing operations. Using this flag may cause data-loss if used without explicit guidance from WekaIO customer support.

--keep-external-containers

Keep external containers(S3, SMB, NFS) running

-f, --force

Force this action without further confirmation. This action will disrupt operation of all connected clients. To restore IO service run 'weka cluster start-io'.

-h, --help

Show help message

weka cluster drive

List the cluster's drives

weka cluster drive [--color color]
                   [--HOST HOST]
                   [--PORT PORT]
                   [--CONNECT-TIMEOUT CONNECT-TIMEOUT]
                   [--TIMEOUT TIMEOUT]
                   [--profile profile]
                   [--format format]
                   [--container container]...
                   [--output output]...
                   [--sort sort]...
                   [--filter filter]...
                   [--show-removed]
                   [--help]
                   [--raw-units]
                   [--UTC]
                   [--no-header]
                   [--verbose]
                   [<uuids>]...
Parameter
Description

uuids...

A list of drive IDs or UUIDs to list. If no ID is specified, all drives are listed.

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-H, --HOST

Specify the host. Alternatively, use the WEKA_HOST env variable

-P, --PORT

Specify the port. Alternatively, use the WEKA_PORT env variable

-C, --CONNECT-TIMEOUT

Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

-T, --TIMEOUT

Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--profile

Name of the connection and authentication profile to use

-f, --format

Specify in what format to output the result (format: 'view', 'csv', 'markdown', 'json' or 'oldview')

--container...

Only return the drives of these container IDs, if not specified, all drives are listed (may be repeated or comma-separated)

-o, --output...

Specify which columns to output. May include any of the following: uid,id,uuid,host,hostname,node,path,size,status,stime,fdName,fdId,writable,used,nvkvused,attachment,vendor,firmware,serial,model,added,removed,block,remain,threshold,drive_status_message,pci_vid,pci_id,pci_ssvid,pci_ssid (may be repeated or comma-separated)

-s, --sort...

Specify which column(s) to take into account when sorting the output. May include a '+' or '-' before the column name to sort in ascending or descending order respectively. Usage: [+

-F, --filter...

Specify what values to filter by in a specific column. Usage: column1=val1[,column2=val2[,..]] (may be repeated or comma-separated)

--show-removed

Show drives that were removed from the cluster

-h, --help

Show help message

-R, --raw-units

Print values in raw units (bytes, seconds, etc.). When not set, sizes are printed in human-readable format, e.g 1KiB 234MiB 2GiB.

-U, --UTC

Print times in UTC. When not set, times are converted to the local time of this host.

--no-header

Don't show column headers when printing the output

-v, --verbose

Show all columns in output

weka cluster drive scan

Scan for provisioned drives on the cluster's containers

weka cluster drive scan [--color color]
                        [--HOST HOST]
                        [--PORT PORT]
                        [--CONNECT-TIMEOUT CONNECT-TIMEOUT]
                        [--TIMEOUT TIMEOUT]
                        [--profile profile]
                        [--help]
                        [--raw-units]
                        [--UTC]
                        [<container-ids>]...
Parameter
Description

container-ids...

A list of container ids to scan for drives

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-H, --HOST

Specify the host. Alternatively, use the WEKA_HOST env variable

-P, --PORT

Specify the port. Alternatively, use the WEKA_PORT env variable

-C, --CONNECT-TIMEOUT

Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

-T, --TIMEOUT

Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--profile

Name of the connection and authentication profile to use

-h, --help

Show help message

-R, --raw-units

Print values in raw units (bytes, seconds, etc.). When not set, sizes are printed in human-readable format, e.g 1KiB 234MiB 2GiB.

-U, --UTC

Print times in UTC. When not set, times are converted to the local time of this host.

weka cluster drive activate

Activate the supplied drive, or all drives (if none supplied)

weka cluster drive activate [--color color]
                            [--HOST HOST]
                            [--PORT PORT]
                            [--CONNECT-TIMEOUT CONNECT-TIMEOUT]
                            [--TIMEOUT TIMEOUT]
                            [--profile profile]
                            [--help]
                            [--raw-units]
                            [--UTC]
                            [<uuids>]...
Parameter
Description

uuids...

A list of drive IDs or UUIDs to activate. If no ID is supplied, all inactive drives will be activated.

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-H, --HOST

Specify the host. Alternatively, use the WEKA_HOST env variable

-P, --PORT

Specify the port. Alternatively, use the WEKA_PORT env variable

-C, --CONNECT-TIMEOUT

Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

-T, --TIMEOUT

Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--profile

Name of the connection and authentication profile to use

-h, --help

Show help message

-R, --raw-units

Print values in raw units (bytes, seconds, etc.). When not set, sizes are printed in human-readable format, e.g 1KiB 234MiB 2GiB.

-U, --UTC

Print times in UTC. When not set, times are converted to the local time of this host.

weka cluster drive deactivate

Deactivate the supplied drive(s)

weka cluster drive deactivate [--color color]
                              [--HOST HOST]
                              [--PORT PORT]
                              [--CONNECT-TIMEOUT CONNECT-TIMEOUT]
                              [--TIMEOUT TIMEOUT]
                              [--profile profile]
                              [--skip-resource-validation]
                              [--force]
                              [--help]
                              [<uuids>]...
Parameter
Description

uuids...

A list of drive IDs or UUIDs to deactivate.

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-H, --HOST

Specify the host. Alternatively, use the WEKA_HOST env variable

-P, --PORT

Specify the port. Alternatively, use the WEKA_PORT env variable

-C, --CONNECT-TIMEOUT

Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

-T, --TIMEOUT

Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--profile

Name of the connection and authentication profile to use

--skip-resource-validation

Skip verifying that the configured hot spare capacity will remain available after deactivating the drives

-f, --force

Force this action without further confirmation. This action may impact performance while the drive is phasing out.

-h, --help

Show help message

weka cluster drive add

Add the given drive

weka cluster drive add <container-id>
                       [--color color]
                       [--HOST HOST]
                       [--PORT PORT]
                       [--CONNECT-TIMEOUT CONNECT-TIMEOUT]
                       [--TIMEOUT TIMEOUT]
                       [--profile profile]
                       [--format format]
                       [--output output]...
                       [--sort sort]...
                       [--filter filter]...
                       [--force]
                       [--allow-format-non-wekafs-drives]
                       [--help]
                       [--raw-units]
                       [--UTC]
                       [--no-header]
                       [--verbose]
                       [<device-paths>]...
Parameter
Description

container-id*

The container the drive attached to (given by ids)

device-paths...

Device paths of the drives to add

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-H, --HOST

Specify the host. Alternatively, use the WEKA_HOST env variable

-P, --PORT

Specify the port. Alternatively, use the WEKA_PORT env variable

-C, --CONNECT-TIMEOUT

Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

-T, --TIMEOUT

Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--profile

Name of the connection and authentication profile to use

-f, --format

Specify in what format to output the result (format: 'view', 'csv', 'markdown', 'json' or 'oldview')

-o, --output...

Specify which columns to output. May include any of the following: path,uuid (may be repeated or comma-separated)

-s, --sort...

Specify which column(s) to take into account when sorting the output. May include a '+' or '-' before the column name to sort in ascending or descending order respectively. Usage: [+

-F, --filter...

Specify what values to filter by in a specific column. Usage: column1=val1[,column2=val2[,..]] (may be repeated or comma-separated)

--force

Force formatting the drive for weka, avoiding all safety checks!

--allow-format-non-wekafs-drives

Allow reuse of drives formatted by another versions

-h, --help

Show help message

-R, --raw-units

Print values in raw units (bytes, seconds, etc.). When not set, sizes are printed in human-readable format, e.g 1KiB 234MiB 2GiB.

-U, --UTC

Print times in UTC. When not set, times are converted to the local time of this host.

--no-header

Don't show column headers when printing the output

-v, --verbose

Show all columns in output

weka cluster drive remove

Remove the supplied drive(s)

weka cluster drive remove [--color color]
                          [--HOST HOST]
                          [--PORT PORT]
                          [--CONNECT-TIMEOUT CONNECT-TIMEOUT]
                          [--TIMEOUT TIMEOUT]
                          [--profile profile]
                          [--force]
                          [--help]
                          [<uuids>]...
Parameter
Description

uuids...

A list of drive UUIDs to remove. A UUID is a hex string formatted as 8-4-4-4-12 e.g. 'abcdef12-1234-abcd-1234-1234567890ab'

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-H, --HOST

Specify the host. Alternatively, use the WEKA_HOST env variable

-P, --PORT

Specify the port. Alternatively, use the WEKA_PORT env variable

-C, --CONNECT-TIMEOUT

Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

-T, --TIMEOUT

Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--profile

Name of the connection and authentication profile to use

-f, --force

Force this action without further confirmation. To undo the removal, add the drive back and re-scan the drives on the host local to the drive.

-h, --help

Show help message

weka cluster mount-defaults

Commands for editing default mount options

weka cluster mount-defaults [--color color] [--help]
Parameter
Description

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-h, --help

Show help message

weka cluster mount-defaults set

Set default mount options.

weka cluster mount-defaults set [--qos-max-throughput qos-max-throughput]
                                [--qos-preferred-throughput qos-preferred-throughput]
                                [--qos-max-ops qos-max-ops]
                                [--color color]
                                [--HOST HOST]
                                [--PORT PORT]
                                [--CONNECT-TIMEOUT CONNECT-TIMEOUT]
                                [--TIMEOUT TIMEOUT]
                                [--profile profile]
                                [--help]
Parameter
Description

--qos-max-throughput

qos-max-throughput is the maximum throughput allowed for the client for either receive or transmit traffic.

--qos-preferred-throughput

qos-preferred-throughput is the throughput that gets preferred state (NORMAL instead of LOW) in QoS.

--qos-max-ops

qos-max-ops is the maximum number of operations of any kind for the client

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-H, --HOST

Specify the host. Alternatively, use the WEKA_HOST env variable

-P, --PORT

Specify the port. Alternatively, use the WEKA_PORT env variable

-C, --CONNECT-TIMEOUT

Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

-T, --TIMEOUT

Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--profile

Name of the connection and authentication profile to use

-h, --help

Show help message

weka cluster mount-defaults show

View default mount options

weka cluster mount-defaults show [--color color]
                                 [--HOST HOST]
                                 [--PORT PORT]
                                 [--CONNECT-TIMEOUT CONNECT-TIMEOUT]
                                 [--TIMEOUT TIMEOUT]
                                 [--profile profile]
                                 [--json]
                                 [--help]
Parameter
Description

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-H, --HOST

Specify the host. Alternatively, use the WEKA_HOST env variable

-P, --PORT

Specify the port. Alternatively, use the WEKA_PORT env variable

-C, --CONNECT-TIMEOUT

Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

-T, --TIMEOUT

Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--profile

Name of the connection and authentication profile to use

-J, --json

Format output as JSON

-h, --help

Show help message

weka cluster mount-defaults reset

Reset default mount options

weka cluster mount-defaults reset [--color color]
                                  [--HOST HOST]
                                  [--PORT PORT]
                                  [--CONNECT-TIMEOUT CONNECT-TIMEOUT]
                                  [--TIMEOUT TIMEOUT]
                                  [--profile profile]
                                  [--qos-max-throughput]
                                  [--qos-preferred-throughput]
                                  [--qos-max-ops]
                                  [--help]
Parameter
Description

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-H, --HOST

Specify the host. Alternatively, use the WEKA_HOST env variable

-P, --PORT

Specify the port. Alternatively, use the WEKA_PORT env variable

-C, --CONNECT-TIMEOUT

Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

-T, --TIMEOUT

Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--profile

Name of the connection and authentication profile to use

--qos-max-throughput

qos-max-throughput is the maximum throughput allowed for the client for either receive or transmit traffic.

--qos-preferred-throughput

qos-preferred-throughput is the throughput that gets preferred state (NORMAL instead of LOW) in QoS.

--qos-max-ops

qos-max-ops is the maximum number of operations of any kind for the client

-h, --help

Show help message

weka cluster servers

Commands for physical servers

weka cluster servers [--color color] [--help]
Parameter
Description

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-h, --help

Show help message

weka cluster servers list

List the cluster servers

weka cluster servers list [--color color]
                          [--HOST HOST]
                          [--PORT PORT]
                          [--CONNECT-TIMEOUT CONNECT-TIMEOUT]
                          [--TIMEOUT TIMEOUT]
                          [--profile profile]
                          [--format format]
                          [--role role]...
                          [--output output]...
                          [--sort sort]...
                          [--filter filter]...
                          [--help]
                          [--no-header]
                          [--verbose]
Parameter
Description

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-H, --HOST

Specify the host. Alternatively, use the WEKA_HOST env variable

-P, --PORT

Specify the port. Alternatively, use the WEKA_PORT env variable

-C, --CONNECT-TIMEOUT

Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

-T, --TIMEOUT

Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--profile

Name of the connection and authentication profile to use

-f, --format

Specify in what format to output the result (format: 'view', 'csv', 'markdown', 'json' or 'oldview')

--role...

Only list machines with specified roles. Possible roles: (format: 'backend', 'client', 'nfs', 'smb' or 's3', may be repeated or comma-separated)

-o, --output...

Specify which columns to output. May include any of the following: hostname,uid,ip,roles,status,up_since,cores,memory,drives,nodes,load,versions,architecture (may be repeated or comma-separated)

-s, --sort...

Specify which column(s) to take into account when sorting the output. May include a '+' or '-' before the column name to sort in ascending or descending order respectively. Usage: [+

-F, --filter...

Specify what values to filter by in a specific column. Usage: column1=val1[,column2=val2[,..]] (may be repeated or comma-separated)

-h, --help

Show help message

--no-header

Don't show column headers when printing the output

-v, --verbose

Show all columns in output

weka cluster servers show

Show a single server overview according to given server uid

weka cluster servers show <uid>
                          [--color color]
                          [--HOST HOST]
                          [--PORT PORT]
                          [--CONNECT-TIMEOUT CONNECT-TIMEOUT]
                          [--TIMEOUT TIMEOUT]
                          [--profile profile]
                          [--json]
                          [--help]
Parameter
Description

uid*

The Server UID

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-H, --HOST

Specify the host. Alternatively, use the WEKA_HOST env variable

-P, --PORT

Specify the port. Alternatively, use the WEKA_PORT env variable

-C, --CONNECT-TIMEOUT

Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

-T, --TIMEOUT

Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--profile

Name of the connection and authentication profile to use

-J, --json

Format output as JSON

-h, --help

Show help message

weka cluster container

List the cluster containers

weka cluster container [--color color]
                       [--HOST HOST]
                       [--PORT PORT]
                       [--CONNECT-TIMEOUT CONNECT-TIMEOUT]
                       [--TIMEOUT TIMEOUT]
                       [--profile profile]
                       [--format format]
                       [--output output]...
                       [--sort sort]...
                       [--filter filter]...
                       [--local]
                       [--backends]
                       [--clients]
                       [--leadership]
                       [--leader]
                       [--help]
                       [--raw-units]
                       [--UTC]
                       [--no-header]
                       [--verbose]
                       [<container-ids>]...
Parameter
Description

container-ids...

Only return these container IDs.

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-H, --HOST

Specify the host. Alternatively, use the WEKA_HOST env variable

-P, --PORT

Specify the port. Alternatively, use the WEKA_PORT env variable

-C, --CONNECT-TIMEOUT

Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

-T, --TIMEOUT

Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--profile

Name of the connection and authentication profile to use

-f, --format

Specify in what format to output the result (format: 'view', 'csv', 'markdown', 'json' or 'oldview')

-o, --output...

Specify which columns to output. May include any of the following: uid,id,hostname,container,machineIdentifier,ips,status,requestedAction,software,release,mode,fd,fdName,fdType,fdId,cores,feCores,driveCores,coreIds,memory,bw,scrubberLimit,dedicated,autoRemove,leadership,uptime,failureText,failure,failureTime,failureCode,requestedActionFailureText,requestedActionFailure,requestedActionFailureTime,requestedActionFailureCode,added,cloudProvider,availabilityZone,instanceType,instanceId,kernelName,kernelRelease,kernelVersion,platform,tlsStrictnessLevel (may be repeated or comma-separated)

-s, --sort...

Specify which column(s) to take into account when sorting the output. May include a '+' or '-' before the column name to sort in ascending or descending order respectively. Usage: [+

-F, --filter...

Specify what values to filter by in a specific column. Usage: column1=val1[,column2=val2[,..]] (may be repeated or comma-separated)

--local

Get result from local weka host

-b, --backends

Only return backend containers

-c, --clients

Only return client containers

-l, --leadership

Only return containers that are part of the cluster leadership

-L, --leader

Only return the cluster leader

-h, --help

Show help message

-R, --raw-units

Print values in raw units (bytes, seconds, etc.). When not set, sizes are printed in human-readable format, e.g 1KiB 234MiB 2GiB.

-U, --UTC

Print times in UTC. When not set, times are converted to the local time of this host.

--no-header

Don't show column headers when printing the output

-v, --verbose

Show all columns in output

weka cluster container info-hw

Show hardware information about one or more containers

weka cluster container info-hw [--color color]
                               [--HOST HOST]
                               [--PORT PORT]
                               [--CONNECT-TIMEOUT CONNECT-TIMEOUT]
                               [--TIMEOUT TIMEOUT]
                               [--profile profile]
                               [--info-type info-type]...
                               [--help]
                               [--json]
                               [--raw-units]
                               [--UTC]
                               [<hostnames>]...
Parameter
Description

hostnames...

A list of containers to query (by hostnames or IPs). If no container is supplied, all of the cluster containers will be queried

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-H, --HOST

Specify the host. Alternatively, use the WEKA_HOST env variable

-P, --PORT

Specify the port. Alternatively, use the WEKA_PORT env variable

-C, --CONNECT-TIMEOUT

Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

-T, --TIMEOUT

Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--profile

Name of the connection and authentication profile to use

--info-type...

Specify what information to query: version

-h, --help

Show help message

-J, --json

Format output as JSON

-R, --raw-units

Print values in raw units (bytes, seconds, etc.). When not set, sizes are printed in human-readable format, e.g 1KiB 234MiB 2GiB.

-U, --UTC

Print times in UTC. When not set, times are converted to the local time of this host.

weka cluster container failure-domain

Set the container failure-domain

weka cluster container failure-domain <container-id>
                                      [--name name]
                                      [--color color]
                                      [--HOST HOST]
                                      [--PORT PORT]
                                      [--CONNECT-TIMEOUT CONNECT-TIMEOUT]
                                      [--TIMEOUT TIMEOUT]
                                      [--profile profile]
                                      [--auto]
                                      [--help]
Parameter
Description

container-id*

Container ID as shown in weka cluster container

--name

Add this container to a named failure-domain. A failure-domain will be created if it doesn't exist yet.

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-H, --HOST

Specify the host. Alternatively, use the WEKA_HOST env variable

-P, --PORT

Specify the port. Alternatively, use the WEKA_PORT env variable

-C, --CONNECT-TIMEOUT

Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

-T, --TIMEOUT

Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--profile

Name of the connection and authentication profile to use

--auto

Set this container to be a failure-domain of its own

-h, --help

Show help message

weka cluster container dedicate

Set the container as dedicated to weka. For example it can be rebooted whenever needed, and configured by weka for optimal performance and stability

weka cluster container dedicate <container-id>
                                <on>
                                [--color color]
                                [--HOST HOST]
                                [--PORT PORT]
                                [--CONNECT-TIMEOUT CONNECT-TIMEOUT]
                                [--TIMEOUT TIMEOUT]
                                [--profile profile]
                                [--help]
Parameter
Description

container-id*

Container ID as shown in weka cluster container

on*

Set the container as weka dedicated, off unsets container as weka dedicated (format: 'on' or 'off')

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-H, --HOST

Specify the host. Alternatively, use the WEKA_HOST env variable

-P, --PORT

Specify the port. Alternatively, use the WEKA_PORT env variable

-C, --CONNECT-TIMEOUT

Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

-T, --TIMEOUT

Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--profile

Name of the connection and authentication profile to use

-h, --help

Show help message

weka cluster container bandwidth

Limit weka's bandwidth for the container

weka cluster container bandwidth <container-id>
                                 <bandwidth>
                                 [--color color]
                                 [--HOST HOST]
                                 [--PORT PORT]
                                 [--CONNECT-TIMEOUT CONNECT-TIMEOUT]
                                 [--TIMEOUT TIMEOUT]
                                 [--profile profile]
                                 [--help]
Parameter
Description

container-id*

Container ID as shown in weka cluster container

bandwidth*

New bandwidth limitation per second (format: either "unlimited" or bandwidth per second in binary or decimal values: 1B, 1KB, 1MB, 1GB, 1TB, 1PB, 1EB, 1KiB, 1MiB, 1GiB, 1TiB, 1PiB, 1EiB)

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-H, --HOST

Specify the host. Alternatively, use the WEKA_HOST env variable

-P, --PORT

Specify the port. Alternatively, use the WEKA_PORT env variable

-C, --CONNECT-TIMEOUT

Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

-T, --TIMEOUT

Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--profile

Name of the connection and authentication profile to use

-h, --help

Show help message

weka cluster container cores

Dedicate container's cores to weka

weka cluster container cores <container-id>
                             <cores>
                             [--frontend-dedicated-cores frontend-dedicated-cores]
                             [--drives-dedicated-cores drives-dedicated-cores]
                             [--compute-dedicated-cores compute-dedicated-cores]
                             [--color color]
                             [--HOST HOST]
                             [--PORT PORT]
                             [--CONNECT-TIMEOUT CONNECT-TIMEOUT]
                             [--TIMEOUT TIMEOUT]
                             [--profile profile]
                             [--core-ids core-ids]...
                             [--no-frontends]
                             [--only-drives-cores]
                             [--only-compute-cores]
                             [--only-frontend-cores]
                             [--allow-mix-setting]
                             [--help]
Parameter
Description

container-id*

Container ID as shown in weka cluster container

cores*

Number of CPU cores dedicated to weka - If set to 0 - no drive could be added to this container

--frontend-dedicated-cores

Number of cores dedicated to weka frontend (out of the total )

--drives-dedicated-cores

Number of cores dedicated to weka drives (out of the total )

--compute-dedicated-cores

Number of cores dedicated to weka compute (out of the total )

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-H, --HOST

Specify the host. Alternatively, use the WEKA_HOST env variable

-P, --PORT

Specify the port. Alternatively, use the WEKA_PORT env variable

-C, --CONNECT-TIMEOUT

Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

-T, --TIMEOUT

Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--profile

Name of the connection and authentication profile to use

--core-ids...

Specify the ids of weka dedicated cores. (may be repeated or comma-separated)

--no-frontends

Do not create any processes with a frontend role

--only-drives-cores

Create only processes with a drives role

--only-compute-cores

Create only processes with a compute role

--only-frontend-cores

Create only processes with a frontend role

--allow-mix-setting

Allow specified core-ids even if there are running containers with AUTO core-ids allocation on the same server.

-h, --help

Show help message

weka cluster container memory

Dedicate a set amount of RAM to weka

weka cluster container memory <container-id>
                              <memory>
                              [--color color]
                              [--HOST HOST]
                              [--PORT PORT]
                              [--CONNECT-TIMEOUT CONNECT-TIMEOUT]
                              [--TIMEOUT TIMEOUT]
                              [--profile profile]
                              [--help]
Parameter
Description

container-id*

Container ID as shown in weka cluster container

memory*

Memory dedicated to weka in bytes, set to 0 to let the system decide (format: capacity in decimal or binary units: 1B, 1KB, 1MB, 1GB, 1TB, 1PB, 1EB, 1KiB, 1MiB, 1GiB, 1TiB, 1PiB, 1EiB)

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-H, --HOST

Specify the host. Alternatively, use the WEKA_HOST env variable

-P, --PORT

Specify the port. Alternatively, use the WEKA_PORT env variable

-C, --CONNECT-TIMEOUT

Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

-T, --TIMEOUT

Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--profile

Name of the connection and authentication profile to use

-h, --help

Show help message

weka cluster container auto-remove-timeout

Set how long to wait before removing this container if it disconnects from the cluster (for clients only)

weka cluster container auto-remove-timeout <container-id>
                                           <auto-remove-timeout>
                                           [--color color]
                                           [--HOST HOST]
                                           [--PORT PORT]
                                           [--CONNECT-TIMEOUT CONNECT-TIMEOUT]
                                           [--TIMEOUT TIMEOUT]
                                           [--profile profile]
                                           [--help]
Parameter
Description

container-id*

Container ID as shown in weka cluster container

auto-remove-timeout*

Minimum value is 60, use 0 to disable automatic removal

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-H, --HOST

Specify the host. Alternatively, use the WEKA_HOST env variable

-P, --PORT

Specify the port. Alternatively, use the WEKA_PORT env variable

-C, --CONNECT-TIMEOUT

Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

-T, --TIMEOUT

Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--profile

Name of the connection and authentication profile to use

-h, --help

Show help message

weka cluster container management-ips

Set the container's management process IPs. Setting 2 IPs will turn this containers networking into highly-available mode

weka cluster container management-ips <container-id>
                                      [--color color]
                                      [--HOST HOST]
                                      [--PORT PORT]
                                      [--CONNECT-TIMEOUT CONNECT-TIMEOUT]
                                      [--TIMEOUT TIMEOUT]
                                      [--profile profile]
                                      [--help]
                                      [<management-ips>]...
Parameter
Description

container-id*

Container ID as shown in weka cluster container

management-ips...

New IPs for the management processes

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-H, --HOST

Specify the host. Alternatively, use the WEKA_HOST env variable

-P, --PORT

Specify the port. Alternatively, use the WEKA_PORT env variable

-C, --CONNECT-TIMEOUT

Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

-T, --TIMEOUT

Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--profile

Name of the connection and authentication profile to use

-h, --help

Show help message

weka cluster container resources

Get the resources of the supplied container

weka cluster container resources <container-id>
                                 [--color color]
                                 [--HOST HOST]
                                 [--PORT PORT]
                                 [--CONNECT-TIMEOUT CONNECT-TIMEOUT]
                                 [--TIMEOUT TIMEOUT]
                                 [--profile profile]
                                 [--stable]
                                 [--help]
                                 [--json]
                                 [--raw-units]
                                 [--UTC]
Parameter
Description

container-id*

Container ID as shown in weka cluster container

--color

Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')

-H, --HOST

Specify the host. Alternatively, use the WEKA_HOST env variable

-P, --PORT

Specify the port. Alternatively, use the WEKA_PORT env variable

-C, --CONNECT-TIMEOUT

Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

-T, --TIMEOUT

Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--profile

Name of the connection and authentication profile to use

--stable

List the resources from the last successfull container boot

-h, --help

Show help message

-J, --json