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.

The base command for all weka related CLIs

weka [--color color] [--help] [--build] [--version] [--legal] [--opt-in]
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

--opt-in

Opt in to the new CLI experience

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 autocomplete

Bash autocompletion utilities

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

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

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

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

Parameter
Description

--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

--systemd-graceful-shutdown

Enable graceful shutdown via systemd

-h, --help

Show help message

weka agent restart

Stop and start Weka agent on the server the command is executed from. If the agent is not running yet, it will be started

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!

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 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.

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

Parameter
Description

--severity

Include event with equal and higher severity, default: WARNING (format: 'debug', 'warning', 'minor', 'major' or 'critical')

--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,severity,time,endTime,activeDuration,count,title,description,action,muteTimeRemaining,comment (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)

--filter-color...

Filter rows with specific colors (red/yellow/green) (may be repeated or comma-separated)

--muted

List muted alerts alongside the unmuted ones

--inactive

List alerts that became inactive recently

-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 describe

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

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,severity (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)

--filter-color...

Filter rows with specific colors (red/yellow/green) (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 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.

Parameter
Description

alert-type*

Specifies the alert type to mute. Run weka alerts types to list all possible types.

duration*

Sets the duration for the mute. Examples - 30m, 2h, 1d. (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--comment

Specifies a comment to provide context for the mute action.

--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

--process...

Mutes alerts for specific process IDs. This parameter applies only to process-specific alerts. If omitted or used on a non-process alert, all alerts of this type are muted. Provide a comma-separated list or repeat the parameter for multiple IDs. (may be repeated or comma-separated)

--container...

Mutes alerts for specific container IDs. This parameter applies only to container-specific alerts. If omitted or used on a non-container alert, all alerts of this type are muted. Provide a comma-separated list or repeat the parameter for multiple IDs. (may be repeated or comma-separated)

--hostname...

Mutes alerts for specific server IDs. This parameter applies only to server-specific alerts. If omitted or used on a non-server alert, all alerts of this type are muted. Provide a comma-separated list or repeat the parameter for multiple IDs. (may be repeated or comma-separated)

-h, --help

Show help message

weka alerts mute add

Add more items to the mute scope for an already muted alert-type. You can add more process/container/hostname items to the existing scope. Duration and comment remain unchanged.

Parameter
Description

alert-type*

Specifies the alert type to update mute scope for. Run weka alerts types to list all possible 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

--process...

Adds more process IDs to the mute scope. This parameter applies only to process-specific alerts. Provide a comma-separated list or repeat the parameter for multiple IDs. (may be repeated or comma-separated)

--container...

Adds more container IDs to the mute scope. This parameter applies only to container-specific alerts. Provide a comma-separated list or repeat the parameter for multiple IDs. (may be repeated or comma-separated)

--hostname...

Adds more hostnames to the mute scope. This parameter applies only to server-specific alerts. Provide a comma-separated list or repeat the parameter for multiple IDs. (may be repeated or comma-separated)

-h, --help

Show help message

weka alerts mute list

List all currently muted alert types with their mute configurations

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: alertType,muteTimeRemaining,description,comment (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)

--filter-color...

Filter rows with specific colors (red/yellow/green) (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 alerts mute remove

Remove specific items from the mute scope of an already muted alert-type. You can remove specific process/container/hostname items from the existing scope. If all items are removed, the alert will be completely unmuted.

Parameter
Description

alert-type*

Specifies the alert type to remove from mute scope. Run weka alerts types to list all possible 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

--process...

Removes specific process IDs from the mute scope. This parameter applies only to process-specific alerts. Provide a comma-separated list or repeat the parameter for multiple IDs. (may be repeated or comma-separated)

--container...

Removes specific container IDs from the mute scope. This parameter applies only to container-specific alerts. Provide a comma-separated list or repeat the parameter for multiple IDs. (may be repeated or comma-separated)

--hostname...

Removes specific hostnames from the mute scope. This parameter applies only to server-specific alerts. Provide a comma-separated list or repeat the parameter for multiple IDs. (may be repeated or comma-separated)

-h, --help

Show help message

weka alerts types

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

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 unmute

Unmute an alert-type which was previously muted.

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 audit

Commands used for audit in a weka cluster

Parameter
Description

--color

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

-h, --help

Show help message

weka audit cluster

Audit cluster CLI

Parameter
Description

--color

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

-h, --help

Show help message

weka audit cluster decrypt-filename

Decrypt filename in audit telemetry

Parameter
Description

--color

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

-h, --help

Show help message

weka audit cluster decrypt-filename disable

Disable decrypting filename in audit telemetry

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 audit cluster decrypt-filename enable

Enable decrypting filename in audit telemetry

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 audit cluster decrypt-fullpath

Decrypt full file paths in audit telemetry

Parameter
Description

--color

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

-h, --help

Show help message

weka audit cluster decrypt-fullpath disable

Disable decrypting full file paths in audit telemetry

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 audit cluster decrypt-fullpath enable

Enable decrypting full file paths in audit telemetry

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 audit cluster disable

Disable audit logging cluster-wide

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 audit cluster enable

Enable audit logging cluster-wide

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 audit cluster enhancer

Audit cluster enhancer CLI

Parameter
Description

--color

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

-h, --help

Show help message

weka audit cluster enhancer disable

Disable audit logging enhancement cluster-wide

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 audit cluster enhancer enable

Enable audit logging enhancement cluster-wide

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 audit cluster resolve-paths

Resolve full file paths in audit telemetry

Parameter
Description

--color

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

-h, --help

Show help message

weka audit cluster resolve-paths disable

Disable resolving full file paths in audit telemetry

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 audit cluster resolve-paths enable

Enable resolving full file paths in audit telemetry

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 audit cluster set-global-operations

Define which operations to audit globally (can be 'All' or any subset)

Parameter
Description

operations...

Audit operations to enable (e.g. 'All' or any from [Open, Create, Read, ...]), replaces any previously enabled operations (format: 'none', 'open', 'create', 'read', 'modify', 'delete', 'rename', 'close', 'sessionmanagement' or 'all')

--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 audit cluster stats

Audit logging cluster-wide stats

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: node,category,timestamp,stat,unit,value,containerId,container,hostname,roles (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)

--filter-color...

Filter rows with specific colors (red/yellow/green) (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 audit cluster status

Audit logging cluster-wide status

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 audit fs

Audit filesystems CLI

Parameter
Description

--color

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

-h, --help

Show help message

weka audit fs disable

Disable audit on a filesystem

Parameter
Description

name*

Filesystem name

--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 audit fs enable

Enable audit on a filesystem

Parameter
Description

name*

Filesystem name

--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 audit fs set-operations

Override audit operations for a specific filesystem

Parameter
Description

name*

Filesystem name

operations...

Audit operations to enable (e.g. 'All' or any subset of [Open, Create, Read, Modify, Delete, Rename, Close, SessionManagement], replaces any previously enabled operations) (format: 'none', 'open', 'create', 'read', 'modify', 'delete', 'rename', 'close', 'sessionmanagement' or 'all')

--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 audit fs status

List filesystems audit status

Parameter
Description

--name

Filesystem name

--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,name,audit,audit_string (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)

--filter-color...

Filter rows with specific colors (red/yellow/green) (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 catalog

Manage the Data Catalog service and indexed filesystem data

Parameter
Description

--color

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

-h, --help

Show help message

weka catalog cluster

Manage the catalog cluster infrastructure and status

Parameter
Description

--color

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

-h, --help

Show help message

weka catalog cluster add

Create a catalog cluster

Parameter
Description

indexfs*

Name of the filesystem to store the catalog metadata

--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

--containers...

The dataservice containers that will be used to form catalog cluster (may be repeated or comma-separated)

--all-servers

Use all dataservice containers to form catalog cluster

-h, --help

Show help message

-J, --json

Format output as JSON

weka catalog cluster remove

Destroy the catalog cluster

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

-f, --force

Force this action without further confirmation. This action will destroy the catalog cluster and cannot be undone.

-J, --json

Format output as JSON

weka catalog cluster status

Get catalog cluster status

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: servicename,id,hostname,container,ip,status,role (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)

--filter-color...

Filter rows with specific colors (red/yellow/green) (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 catalog cluster update

Update an existing catalog cluster

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

--add-containers...

Add specific dataservice containers to the catalog cluster (may be repeated or comma-separated)

--remove-containers...

Remove specific dataservice containers from the catalog cluster (may be repeated or comma-separated)

-h, --help

Show help message

-J, --json

Format output as JSON

weka catalog config

Manage the configuration settings for the Data Catalog service

Parameter
Description

--color

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

-h, --help

Show help message

weka catalog config show

View the current catalog cluster settings and indexing policies

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 catalog config update

Update catalog configuration including index policy

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

--index-enabled

Enable or disable catalog indexing (format: 'yes', 'no', 'true', 'false', 'on', 'off', 'y' or 'n')

--index-interval

Index task execution interval. Default: 1 day. Supports time units: s (seconds), m (minutes), h (hours) (format: 3s, 4m, 2h, 1d, 1d5h, 1w, infinite/unlimited)

--retention-period

Retention period for index snapshots. Default: 30 days. Supports time units: m (minutes), h (hours), d (days) (format: 3s, 4m, 2h, 1d, 1d5h, 1w, infinite/unlimited)

--max-ingest-tasks

Maximum number of ingest tasks that can run in parallel (default: 2)

-h, --help

Show help message

weka catalog fs

Manage filesystem catalog status and metadata

Parameter
Description

--color

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

-h, --help

Show help message

weka catalog fs status

Show which filesystems have catalog enabled, which have metadata, last ingested time, and last ingest task errors

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: name,indexing,metadata,snapshots,latest,oldest,last_ingest,error (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)

--filter-color...

Filter rows with specific colors (red/yellow/green) (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 catalog metadata

Manage catalog metadata on a per-filesystem basis

Parameter
Description

--color

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

-h, --help

Show help message

weka catalog metadata remove

Delete catalog metadata for a filesystem

Parameter
Description

fs-name*

Filesystem name

--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

-f, --force

Force this action without further confirmation. This action deletes all the catalog metadata for the filesystem and cannot be undone.

weka catalog metadata show

Show ingestion history for a filesystem

Parameter
Description

fs-name*

Filesystem name

--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

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

Parameter
Description

--color

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

-h, --help

Show help message

weka cloud disable

Turn cloud features off

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 enable

Turn cloud features on

Parameter
Description

--cloud-url

The base url of the cloud service

--cloud-stats

Enable or disable uploading stats to the cloud (format: 'yes', 'no', 'true', 'false', 'on', 'off', 'y' or 'n')

--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

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 status

Show cloud connectivity status

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)

--filter-color...

Filter rows with specific colors (red/yellow/green) (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 upload-rate

Get the cloud upload rate

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

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

Parameter
Description

--color

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

-h, --help

Show help message

weka cluster bucket

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

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,previousLeader,uptime,leaderVersionSig,electableMode,sourceMembers,nonSourceMembers,fillLevel,rebuildTodo,rebuildTotal,failReason,activityFlags (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)

--filter-color...

Filter rows with specific colors (red/yellow/green) (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 client-target-version

Commands that manage the clients target version

Parameter
Description

--color

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

-h, --help

Show help message

weka cluster client-target-version reset

Clear cluster's client target version value

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 client-target-version set

Determine clients target version to be used in case of upgrade or a new mount (stateless client).

Parameter
Description

version-name*

The version to set

--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 client-target-version show

Show clients target version to be used in case of upgrade or a new mount (stateless client).

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 container

List the cluster containers

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,hypervisorType,kernelName,kernelRelease,kernelVersion,platform,tlsStrictnessLevel,hardwareMonitoring (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)

--filter-color...

Filter rows with specific colors (red/yellow/green) (may be repeated or comma-separated)

--local

Get result from local weka host

--council

Get result from cluster leadership members

-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 activate

Activate the supplied containers, or all containers (if none supplied)

Parameter
Description

container-ids...

A list of container ids to activate

--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

--no-wait

--skip-resource-validation

Skip verifying that the cluster will still have enough RAM and SSD resources after deactivating the containers

--skip-activate-drives

Do not activate the drives of the container

-h, --help

Show help message

weka cluster container add

Add a container to the cluster

Parameter
Description

hostname*

Management network hostname

--ip

Management IP; If both FQDN and IP are empty, the hostname is resolved; If container is highly-available or mixed-networking, use IP set '++...+';

--host-fqdn

Management fully qualified domain name; If both FQDN and IP are empty, hostnames will be resolved;

--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

--no-wait

Skip waiting for the container to be added to the cluster

-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 apply

Apply the staged resources of the supplied containers, or all containers

Parameter
Description

container-ids...

A list of container ids for which to apply resources config

--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 will still have enough RAM and SSD resources after deactivating the containers

--all

Apply resources on all the containers in the cluster. This will cause all backend containers in the entire cluter to restart simultaneously!

-f, --force

Force this action without further confirmation.

-h, --help

Show help message

weka cluster container bandwidth

Limit weka's bandwidth for the container

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 clear-failure

Clear the last failure fields for all supplied containers

Parameter
Description

container-ids...

A list of container ids for which to clear the last failure

--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

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 deactivate

Deactivate the supplied container(s)

Parameter
Description

container-ids...

A list of container ids to deactivate

--allow-reduced-resilience-to

Allow deactivation even if cluster resilience would drop to this level (0 = no minimum)

--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

--no-wait

--skip-resource-validation

Skip verifying that the cluster will still have enough RAM and SSD resources after deactivating the containers

--allow-unavailable

Allow the container to be unavailable while it is deactivated which skips setting its local resources

-h, --help

Show help message

weka cluster container deactivation-check

Check if the provided containers can be deactivated

Parameter
Description

container-ids...

A list of container ids for which to set flow

--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 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

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: 'yes', 'no', 'true', 'false', 'on', 'off', 'y' or 'n')

--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 failure-domain

Set the container failure-domain

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 info-hw

Show hardware information about one or more containers

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 join-secret

Set secret this container will use when joining or validating other backends

Parameter
Description

container-id*

Container ID as shown in weka cluster container

secret*

Cluster join secret

--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

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 memory

Dedicate a set amount of RAM to weka

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 net

List Weka dedicated networking devices in a container

Parameter
Description

container-ids...

Container IDs to get the network devices of

--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,name,id,host,hostname,device,ips,netmask,gateway,cores,owner,vlan,netlabel (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)

--filter-color...

Filter rows with specific colors (red/yellow/green) (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 container net add

Allocate a dedicated networking device on a container (to the cluster).

Parameter
Description

container-id*

The container's id

device*

Network device pci-slot/mac-address/interface-name(s)

--ips-type

IPs type: POOL: IPs from the default data networking IP pool would be used, USER: configured by the user (format: 'pool' or 'user')

--gateway

Default gateway IP. In AWS this value is auto-detected, otherwise the default data networking gateway will be used.

--netmask

Netmask in bits number. In AWS this value is auto-detected, otherwise the default data networking netmask will be used.

--name

If empty, a name will be auto generated.

--label

The name of the switch or network group to which this network device is attached

--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

--ips...

IPs to be allocated to cores using the device. If not given - IPs may be set automatically according the interface's IPs, or taken from the default networking IPs pool (may be repeated or comma-separated)

--rdma-off

The device will not be used for RDMA data transfers

--rdma-only

The device will be explicitly configured for RDMA

--inet6

Use IPv6 for RoCE v2 RDMA. The default is IPv4, not required and ignored for Infiniband.

-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 net remove

Undedicate a networking device in a container.

Parameter
Description

container-id*

The container's id

name*

Net device name, e.g. container0net0

--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 remove

Remove a container from the cluster

Parameter
Description

container-id*

The container ID of the container to be removed

--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

--no-wait

Don't wait for the container removal to complete, return immediately

--no-unimprint

Don't remotely unimprint the container, just remove it from the cluster configuration

-h, --help

Show help message

weka cluster container requested-action

Set the requested action of the supplied containers to one of: STOP, RESTART, APPLY_RESOURCES to gracefully stop, restart or apply resources to the containers.

Parameter
Description

requested_action*

The requested action to set the containers to (format: 'none', 'stop', 'restart', 'apply_resources' or 'upgrade')

container-ids...

A list of container ids for which to set flow

--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

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

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 restore

Restore staged resources of the supplied containers, or all containers, to their stable state

Parameter
Description

container-ids...

A list of container ids for which to apply resources config

--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

--all

Apply resources on all the containers in the cluster. This will cause all backend containers in the entire cluter to restart simultaneously!

-h, --help

Show help message

weka cluster add

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

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

--join-secret

Initial join secret

--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 both FQDN and IPs are empty, the hostnames will be resolved; If hosts are highly-available or mixed-networking, use IP set '++...+'; (may be repeated or comma-separated)

--host-fqdn...

Management fully qualified domain name; If both FQDNs and IPs are empty, hostnames will be resolved; (may be repeated or comma-separated)

--overwrite_resource_ips

overwrite pre-set ips in host's resource file with --host-ips set up provided by user or resolved from DNS

-h, --help

Show help message

-J, --json

Format output as JSON

weka cluster default-net

List the default data networking configuration

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

-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 default-net reset

Reset the default data networking configuration

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 default-net set

Set the default data networking configuration

Parameter
Description

--range

IP range

--gateway

Default gateway IP

--netmask-bits

Subnet mask bits (0..32)

--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 default-net update

Update the default data networking configuration

Parameter
Description

--range

IP range

--gateway

Default gateway IP

--netmask-bits

Subnet mask bits (0..32)

--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 drive

List the cluster's drives

Parameter
Description

uuids...

A list of DriveIds 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,pool,drive_status_message,pci_vid,pci_id,pci_ssvid,pci_ssid,location,needsPhaseOut,hardDeactivate,autoEjectReason,lastFailure,lastFailureCode,lastFailureTime (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)

--filter-color...

Filter rows with specific colors (red/yellow/green) (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 activate

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

Parameter
Description

uuids...

A list of DriveIds 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 add

Add the given drive

Parameter
Description

container-id*

The container the drive attached to (given by ids)

device-paths...

Device paths of the drives to add, or UUIDs of partitions pre-signed by weka

--pool

Specify disk pool to add into (format: 'auto', 'iu4k', 'iubig' or 'legacy')

--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)

--filter-color...

Filter rows with specific colors (red/yellow/green) (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 deactivate

Deactivates one or more SSD drives, taking them offline.

Parameter
Description

driveIdentifiers...

Specifies the drive or space separated list of drives to deactivate.

--allow-reduced-resilience-to

Allow deactivation even if cluster resilience would drop to this protection level (0 = no minimum)

--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

--hard

Remove drive without phasing out

-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 identify

Turn a drive's identify LED on or off

Parameter
Description

uuid*

A DriveId or UUID to identify.

state*

Set the drive's identify LED as on or off (format: 'yes', 'no', 'true', 'false', 'on', 'off', 'y' or 'n')

--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 drive remove

Remove the supplied drive(s)

Parameter
Description

driveIdentifiers...

Specifies the drive or a space separated list of drives to remove, identified by the system-assigned DriveId or the persistent UUID. For example: '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 drive scan

Scan for provisioned drives on the cluster's containers

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 failure-domain

List the Weka cluster failure domains

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)

--filter-color...

Filter rows with specific colors (red/yellow/green) (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

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 license

Get information about the current license status, how much resources are being used in the cluster and whether or not your current license is valid.

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

-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 license reset

Removes existing license information, returning the cluster to an unlicensed mode

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 license set

Set the cluster license

Parameter
Description

license*

The new license to set to the system

--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

Commands for editing default mount options

Parameter
Description

--color

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

-h, --help

Show help message

weka cluster mount-defaults reset

Reset default mount options

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 mount-defaults set

Set default mount options.

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

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 network-space

List the cluster's network-spaces. Optionally filter by tenant.

Parameter
Description

--tenant

Filter by tenant name or ID

--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: nid,netspaceName,rangeFront,rangeEnd,vlan,gateway,netmaskBits (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)

--filter-color...

Filter rows with specific colors (red/yellow/green) (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 network-space add

Add new Network Space and corresponding VLAN and IP Pool for BE Cluster use

Parameter
Description

name*

network-space name

--vlan

Vlan Id (1..4094)

--range

IP range

--gateway

Default gateway IP for the network-space.

--netmask-bits

Subnet mask bits (1..32) - Defaults to 16 if unspecified

--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 network-space remove

Remove a Network Space

Parameter
Description

name*

network-space name

--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

--force

Force remove the netspace even when clients are present!

-h, --help

Show help message

weka cluster network-space show-usage

Show Network Space Usage

Parameter
Description

--name

network-space name

--id

network-space id

--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: hostId,ip,netspaceIpIdx,hostMode,proxy (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)

--filter-color...

Filter rows with specific colors (red/yellow/green) (may be repeated or comma-separated)

-b, --backends

Only return backend containers

-c, --clients

Only return client containers

-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 network-space update

Update new Network Space and corresponding VLAN and IP Pool for BE Cluster use

Parameter
Description

id*

network-space id

--name

network-space name

--vlan

Vlan Id (1..4094)

--range

IP range

--gateway

Default gateway IP for the network-space.

--netmask-bits

Subnet mask bits (1..32) - Defaults to 16 if unspecified

--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

--force

Force update the netspace even when clients are present!

-h, --help

Show help message

weka cluster process

List the cluster processes

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,blackListingReason,blackListingTime (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)

--filter-color...

Filter rows with specific colors (red/yellow/green) (may be repeated or comma-separated)

--local

Get result from local weka host

--council

Get result from cluster leadership members

-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 servers

Commands for physical servers

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

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,deployment_mode,status,up_since,cores,memory,drives,nodes,load,ready_for_maintenance,requested_action,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)

--filter-color...

Filter rows with specific colors (red/yellow/green) (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 servers requested-action

Set the requested action for all backend containers on the supplied servers to one of: STOP, RESTART, APPLY_RESOURCES to gracefully stop, restart or apply resources to the backend containers on the servers.

Parameter
Description

requested_action*

The requested action to set for all containers on the servers (format: 'none', 'stop', 'restart', 'apply_resources' or 'upgrade')

server-identifiers...

A list of server identifiers (hostnames or IPs) for which to set the requested action

--timeout

Timeout for the requested action (optional) (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 cluster servers show

Show a single server overview according to given server uid

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 start-io

Start IO services

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 cluster stop-io

Stop IO services

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

-J, --json

Format output as JSON

weka cluster task

List the currently running background tasks and their status

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,id,type,state,phase,progress,paused,desc,time,throttle (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)

--filter-color...

Filter rows with specific colors (red/yellow/green) (may be repeated or comma-separated)

--show-waiting

Show waiting tasks

--show-catalog

Show catalog tasks

-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 task abort

Abort a currently running background task

Parameter
Description

task-id*

Id of the task to abort

--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 task bucket

List the status of a background task on specific buckets

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')

--task...

Only return these task IDs. (may be repeated or comma-separated)

-b, --bucket...

Only return these bucket IDs. (may be repeated or comma-separated)

-o, --output...

Specify which columns to output. May include any of the following: bucket_id,task_id,type,phase,progress,lastProgress,stuck,pausedAtGeneration (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)

--filter-color...

Filter rows with specific colors (red/yellow/green) (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 task limits

List the current limits for background tasks

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 cluster task limits set

Set the limits for background tasks

Parameter
Description

--cpu-limit

Percent of the CPU resources to dedicate to background tasks (format: 0..100)

--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 task pause

Pause a currently running background task

Parameter
Description

task-id*

Id of the task to pause

--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 task resume

Resume a currently paused background task

Parameter
Description

task-id*

Id of the task to resume

--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 task throttle

Slow down the rate of progress of a currently running background task

Parameter
Description

task-id*

Id of the task to throttle

--throttle

Percentage by which to throttle the task (between 0 and 100) (format: 0..100)

--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 update

Update cluster configuration

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)

--bucket-raft-size

Number of members in the buckets raft group

--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 dataservice

Commands that manage dataservice

Parameter
Description

--color

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

-h, --help

Show help message

weka dataservice global-config

Dataservice Global Configuration

Parameter
Description

--color

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

-h, --help

Show help message

weka dataservice global-config set

Set Dataservice global configuration options

Parameter
Description

--config-fs

config filesystem name, use "" to invalidate

--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 dataservice global-config show

Show the Dataservice global configuration

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 dataservice s3-lifecycle-task

Commands to manage S3 lifecycle tasks

Parameter
Description

--color

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

-h, --help

Show help message

weka dataservice s3-lifecycle-task disable

Disable the S3 lifecycle task manager

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 dataservice s3-lifecycle-task enable

Enable the S3 lifecycle task manager

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 dataservice s3-lifecycle-task set

Set S3 lifecycle task manager settings

Parameter
Description

--max-tasks

Maximum number of concurrent tasks

--interval

Interval between lifecycle task manager runs (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 dataservice s3-lifecycle-task show

Show S3 lifecycle task manager status and settings

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 diags

Diagnostics commands to help understand the status of the cluster and its environment

Parameter
Description

--color

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

-h, --help

Show help message

weka diags collect

Collect diags from all cluster containers to a directory on the container running this command

Parameter
Description

-i, --id

Optional ID for this dump, if not specified a random ID is generated

-m, --timeout

How long to wait when downloading diags from all containers. Default is 10 minutes, 0 means indefinite (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

-d, --output-dir

Directory to save the diags dump to, default: /opt/weka/diags

-c, --core-limit

Limit to processing this number of core dumps, if found (default: 1)

-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

--color

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

--container-id...

Container IDs to collect diags from, can be used multiple times. This flag causes --clients to be ignored. (may be repeated or comma-separated)

--clients

Collect diags from client containers only (by default diags are only collected from backends)

--backends

Collect diags from backend containers (to be used in combination with --clients to collect from all containers)

-t, --tar

Create a TAR of all collected diags

-v, --verbose

Print results of all diags, including successful ones

-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.

-J, --json

Format output as JSON

weka diags list

Prints results of a previously collected diags report

Parameter
Description

id...

ID of the dump to show or a path to the diags dump. If not specified a list of all collected diags is shown.

--color

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

-v, --verbose

Print results of all diags, including successful ones

-h, --help

Show help message

weka diags rm

Stop a running instance of diags, and cancel its uploads.

Parameter
Description

id...

ID of the diags to cancel. Must be specified unless the all option is set.

-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

--color

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

--all

Delete all.

-h, --help

Show help message

weka diags upload

Collect and upload diags from all cluster containers to Weka's support cloud

Parameter
Description

-m, --timeout

How long to wait for diags to upload. Default is 10 minutes, 0 means indefinite (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

-c, --core-limit

Limit to processing this number of core dumps, if found (default: 1)

--dump-id

ID of an existing dump to upload. This dump ID has to exist on this local server. If an ID is not specified, a new dump is created.

-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

--color

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

--container-id...

Container IDs to collect diags from, can be used multiple times. This flag causes --clients to be ignored. (may be repeated or comma-separated)

--clients

Collect diags from client containers only (by default diags are only collected from backends)

--backends

Collect diags from backend containers (to be used in combination with --clients to collect from all containers)

--no-tar

Do not tar and compress local files

-h, --help

Show help message

-J, --json

Format output as JSON

weka driver

Manage Weka drivers

Parameter
Description

--color

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

-h, --help

Show help message

weka driver build

Compiles drivers for the machine where this command is executed.

Parameter
Description

--color

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

-V, --version

Weka version for drivers.

-h, --help

Show help message

weka driver download

Downloads drivers from a distribution server.

Parameter
Description

--color

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

-V, --version

Weka version for drivers.

-K, --kernel-signature

Kernel signature for drivers.

--from...

Download from this distribution server (can be given multiple times). Otherwise distribution servers are taken from the $WEKA_DIST_SERVERS environment variable, the /etc/wekaio/dist-servers file, or /etc/wekaio/service.conf in that order of precedence. (may be repeated or comma-separated)

-h, --help

Show help message

weka driver export

Exports drivers from this machine to an archive.

Parameter
Description

path*

Path of the output archive, will be in .zip format.

--color

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

-V, --version

Weka version for drivers.

-K, --kernel-signature

Kernel signature for drivers.

-h, --help

Show help message

weka driver import

Imports drivers from a previously exported archive to this machine.

Parameter
Description

path*

The path of the importing tar file

--color

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

--overwrite

Overwrite existing drivers

-h, --help

Show help message

weka driver install

Installs drivers on the machine where this command is executed.

Parameter
Description

--color

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

-V, --version

Weka version for drivers.

-h, --help

Show help message

weka driver kernel

Shows the kernel signature of the system. This signature is used to identify the specific kernel.

Parameter
Description

--color

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

-h, --help

Show help message

-J, --json

Format output as JSON

weka driver pack

Creates driver package.

Parameter
Description

--color

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

-V, --version

Weka version for drivers.

-K, --kernel-signature

Kernel signature for drivers.

-e, --environment...

Environment variable to add (may be repeated)

-h, --help

Show help message

weka driver ready

Checks if kernel drivers are loaded and ready for Weka.

Parameter
Description

--color

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

-V, --version

Weka version for drivers.

-h, --help

Show help message

-J, --json

Format output as JSON

-q, --quiet

Checks quietly (exit status 0 if drivers are ready, 1 otherwise).

weka driver sign

Signs drivers with a private key.

Parameter
Description

key*

Path to the private key file.

cert

Path to the certificate file.

passwd*

Password for private key file. (may also be supplied by $WEKA_SIGNING_KEY_PASSWORD, or in the file named by $WEKA_SIGNING_KEY_PASSWORD_FILE)

--hash

Hash algorithm used for signing modules. (format: 'sha256', 'sha384' or 'sha512')

--color

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

-V, --version

Weka version for drivers.

-K, --kernel-signature

Kernel signature for drivers.

--pack

Sign driver package.

-h, --help

Show help message

weka events

List all events that conform to the filter criteria

Parameter
Description

-n, --num-results

Get up to this number of events, default: 50

--start-time

Include events occurred in this time point and later (format: 5m, -5m, -1d, -1w, 1:00, 01:00, 18:30, 18:30:07, 2018-12-31 10:00, 2018/12/31 10:00, 2018-12-31T10:00, 2019-Nov-17 11:11:00.309, 9:15Z, 10:00+2:00)

--end-time

Include events occurred not later then this time point (format: 5m, -5m, -1d, -1w, 1:00, 01:00, 18:30, 18:30:07, 2018-12-31 10:00, 2018/12/31 10:00, 2018-12-31T10:00, 2019-Nov-17 11:11:00.309, 9:15Z, 10:00+2:00)

--severity

Include event with equal and higher severity, default: INFO (format: 'debug', 'info', 'warning', 'minor', 'major' or 'critical')

-d, --direction

Fetch events from the first available event (forward) or the latest created event (backward), default: backward (format: 'forward' or 'backward')

--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')

-t, --type-list...

Filter events by type, can be used multiple times (use 'weka events list-types' to see available types) (may be repeated or comma-separated)

-x, --exclude-type-list...

Remove events by type, can be used multiple times (use 'weka events list-types' to see available types) (may be repeated or comma-separated)

-c, --category-list...

Include only events matches to the category_list. Category can be Events, Node, Raid, Drive, ObjectStorage, System, Resources, Clustering, Network, Filesystem, Upgrade, NFS, Config, Cloud, InterfaceGroup, Tenant, User, Alerts, Licensing, Custom, Kms, Smb, Telemetry, Traces, S3, Security, Agent or Catalog (may be repeated or comma-separated)

-o, --output...

Specify which columns to output. May include any of the following: time,cloudTime,node,category,severity,type,entity,desc (may be repeated or comma-separated)

-i, --show-internal

Show internal events

-l, --cloud-time

Sort by cloud time instead of local timestamp

-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 events list-local

List recent events that happened on the machine running this command

Parameter
Description

--start-time

Include events occurred in this time point and later (format: 5m, -5m, -1d, -1w, 1:00, 01:00, 18:30, 18:30:07, 2018-12-31 10:00, 2018/12/31 10:00, 2018-12-31T10:00, 2019-Nov-17 11:11:00.309, 9:15Z, 10:00+2:00)

--end-time

Include events occurred not later then this time point (format: 5m, -5m, -1d, -1w, 1:00, 01:00, 18:30, 18:30:07, 2018-12-31 10:00, 2018/12/31 10:00, 2018-12-31T10:00, 2019-Nov-17 11:11:00.309, 9:15Z, 10:00+2:00)

--next

Token for the next page of events

--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: time,category,severity,permission,type,entity,node,hash (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)

--filter-color...

Filter rows with specific colors (red/yellow/green) (may be repeated or comma-separated)

--stem-mode

List stem mode events

--show-internal

Show internal events

-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 events list-types

Show the event type definition information

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')

-c, --category...

List only the events that fall under one of the following categories: Events, Node, Raid, Drive, ObjectStorage, System, Resources, Clustering, Network, Filesystem, Upgrade, NFS, Config, Cloud, InterfaceGroup, Tenant, User, Alerts, Licensing, Custom, Kms, Smb, Telemetry, Traces, S3, Security, Agent or Catalog (may be repeated or comma-separated)

-t, --type...

List only events of the specified types (may be repeated or comma-separated)

-o, --output...

Specify which columns to output. May include any of the following: type,category,severity,description,format,permission,parameters,dedup,dedupParams (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)

--filter-color...

Filter rows with specific colors (red/yellow/green) (may be repeated or comma-separated)

--show-internal

Show internal events

-h, --help

Show help message

--no-header

Don't show column headers when printing the output

-v, --verbose

Show all columns in output

weka events trigger-event

Trigger a custom event with a user defined parameter

Parameter
Description

message*

User defined text to trigger as the events parameter

--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 fs

List filesystems defined in this Weka cluster

Parameter
Description

--name

Filesystem name

--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,name,group,usedSSD,usedSSDD,usedSSDM,freeSSD,availableSSDM,availableSSD,usedTotal,usedTotalD,freeTotal,availableTotal,maxFiles,status,encrypted,stores,auth,thinProvisioned,thinProvisioningMinSSDBudget,thinProvisioningMaxSSDBudget,usedSSDWD,usedSSDRD,reductionRatio,pendingReduction,dataReduction,reducedProcessedSize,reducedSize,kmsKey,kmsNamespace,kmsRole,processedReductionRatio,dataReductionSavings,indexEnabled,permissions,ownerGuid (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)

--filter-color...

Filter rows with specific colors (red/yellow/green) (may be repeated or comma-separated)

--capacities

Display all capacity columns

--force-fresh

Refresh the capacities to make sure they are most updated

-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 fs add

Create a filesystem

Parameter
Description

name*

Filesystem name

group-name*

Group name

total-capacity*

Total capacity (format: capacity in decimal or binary units: 1B, 1KB, 1MB, 1GB, 1TB, 1PB, 1EB, 1KiB, 1MiB, 1GiB, 1TiB, 1PiB, 1EiB)

--obs-name

Object Store bucket name. Mandatory for tiered filesystems

--ssd-capacity

SSD capacity (format: capacity in decimal or binary units: 1B, 1KB, 1MB, 1GB, 1TB, 1PB, 1EB, 1KiB, 1MiB, 1GiB, 1TiB, 1PiB, 1EiB)

--thin-provision-min-ssd

Thin provisioned minimum SSD capacity (format: capacity in decimal or binary units: 1B, 1KB, 1MB, 1GB, 1TB, 1PB, 1EB, 1KiB, 1MiB, 1GiB, 1TiB, 1PiB, 1EiB)

--thin-provision-max-ssd

Thin provisioned maximum SSD capacity (format: capacity in decimal or binary units: 1B, 1KB, 1MB, 1GB, 1TB, 1PB, 1EB, 1KiB, 1MiB, 1GiB, 1TiB, 1PiB, 1EiB)

--audit-enabled

Enable audit logging for this filesystem. Takes effect only if audit is enabled cluster-wide (format: 'yes', 'no', 'true', 'false', 'on', 'off', 'y' or 'n')

--kms-key-identifier

Customize KMS key identifier for this filesystem (currently only for HashiCorp Vault)

--kms-namespace

Customize KMS namespace for this filesystem (currently only for HashiCorp Vault)

--kms-role-id

Customize KMS role-id for this filesystem (currently only for HashiCorp Vault)

--kms-secret-id

Customize KMS secret-id for this filesystem (currently only for HashiCorp Vault)

--index-enabled

Enable catalog indexing for this filesystem (format: 'yes', 'no', 'true', 'false', 'on', 'off', 'y' or 'n')

--max-throughput

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

--max-iops

Limit IOs/s

--auth-required

Require the mounting user to be authenticated for mounting this filesystem. This flag is only effective in the root tenant, users in non-root tenants must be authenticated to perform a mount operation. (format: 'yes', 'no', 'true', 'false', 'on', 'off', 'y' or 'n')

--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

--encrypted

Creates an encrypted filesystem

--allow-no-kms

Allow (insecurely) creating an encrypted filesystem without a KMS configured

--data-reduction

Enable data reduction

-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 fs remove

Delete a filesystem

Parameter
Description

name*

Filesystem name

--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

--purge-from-obs

Delete filesystem's objects from the local writable Object Store, making all locally uploaded snapshots unusable

-f, --force

Force this action without further confirmation. This action DELETES ALL DATA in the filesystem and cannot be undone.

-h, --help

Show help message

weka fs download

Download a filesystem from object store

Parameter
Description

name*

Filesystem name

group-name*

Group name

total-capacity*

Total capacity (format: capacity in decimal or binary units: 1B, 1KB, 1MB, 1GB, 1TB, 1PB, 1EB, 1KiB, 1MiB, 1GiB, 1TiB, 1PiB, 1EiB)

ssd-capacity*

SSD capacity (format: capacity in decimal or binary units: 1B, 1KB, 1MB, 1GB, 1TB, 1PB, 1EB, 1KiB, 1MiB, 1GiB, 1TiB, 1PiB, 1EiB)

obs-bucket*

Object Store bucket

locator*

Locator

--audit-enabled

Enable audit logging for this filesystem. Takes effect only if audit is enabled cluster-wide (format: 'yes', 'no', 'true', 'false', 'on', 'off', 'y' or 'n')

--auth-required

Require the mounting user to be authenticated for mounting this filesystem. This flag is only effective in the root tenant, users in non-root tenants must be authenticated to perform a mount operation. (format: 'yes', 'no', 'true', 'false', 'on', 'off', 'y' or 'n')

--additional-obs-bucket

Additional Object Store bucket

--snapshot-name

Downloaded snapshot name (default: uploaded name)

--access-point

Downloaded snapshot access point (default: uploaded access-point)

--kms-key-identifier

Customize KMS key name for this filesystem (currently only for HashiCorp Vault)

--kms-namespace

Customize KMS namespace for this filesystem (currently only for HashiCorp Vault)

--kms-role-id

Customize KMS role-id for this filesystem (currently only for HashiCorp Vault)

--kms-secret-id

Customize KMS secret-id for this filesystem (currently only for HashiCorp Vault)

--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 downloaded filesystem

-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 fs group

List filesystem groups

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,group,name,retention,demote (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)

--filter-color...

Filter rows with specific colors (red/yellow/green) (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 fs group add

Create a filesystem group

Parameter
Description

name*

The filesystem group name to be created

--target-ssd-retention

Period of time to keep an SSD copy of the data (format: 3s, 2h, 4m, 1d, 1d5h, 1w)

--start-demote

Period of time to wait before copying data to the Object Store (format: 3s, 2h, 4m, 1d, 1d5h, 1w)

--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

-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 fs group remove

Delete a filesystem group

Parameter
Description

name*

The name of the filesystem group to be deleted

--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 fs group update

Update a filesystem group

Parameter
Description

name*

The filesystem group name to be created

--new-name

Updated name of the specified filesystem group

--target-ssd-retention

Period of time to keep an SSD copy of the data (format: 3s, 2h, 4m, 1d, 1d5h, 1w)

--start-demote

Period of time to wait before copying data to the Object Store (format: 3s, 2h, 4m, 1d, 1d5h, 1w)

--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 fs kms-rewrap

Rewrap the key of Filesystem

Parameter
Description

name*

Filesystem name

--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 fs protection

Commands used to manage file system protection

Parameter
Description

--color

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

-h, --help

Show help message

weka fs protection snapshot-policy

Snapshot policy management commands

Parameter
Description

--color

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

-h, --help

Show help message

weka fs protection snapshot-policy attach

Attach existing filesystems to snapshot policy

Parameter
Description

name*

The snapshot policy name

filesystems...

A list of filesystems you want to attach to the policy

--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 fs protection snapshot-policy add

Create a new snapshot policy

Parameter
Description

name*

The snapshot policy name (up to 12 alphanumeric characters, hyphens (-), underscores (_), and periods (.))

path*

The path to the snapshot policy file, must be in JSON format

--description

Policy description (up to 128 characters)

--enabled

Set snapshot policy status, can be true/false , default is true (format: 'yes', 'no', 'true', 'false', 'on', 'off', 'y' or 'n')

--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

-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 fs protection snapshot-policy remove

Delete a snapshot policy

Parameter
Description

name*

Existing snapshot policy name

--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. This action deletes the snapshot policy and cannot be undone.

-h, --help

Show help message

weka fs protection snapshot-policy detach

Detach existing filesystems from the snapshot policy

Parameter
Description

name*

The snapshot policy name

filesystems...

A list of filesystems you want to detach from the policy

--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

--remove-waiting-tasks

Allow to delete all waiting tasks corresponding to the filesystems.

-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.

-f, --force

Force this action without further confirmation. This action detach existing filesystem from the snapshot policy and cannot be undone.

weka fs protection snapshot-policy duplicate

Duplicates an existing snapshot policy, creating a new one.

Parameter
Description

policyName*

Name of the snapshot policy to duplicate.

name*

Name of the new snapshot policy. (up to 12 alphanumeric characters, hyphens (-), underscores (_), and periods (.))

--description

Policy description (up to 128 characters)

--include-attached-filesystems

Define whether or not to include the attached filesystems (format: 'yes', 'no', 'true', 'false', 'on', 'off', 'y' or 'n')

--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 fs protection snapshot-policy export

Export snapshot policy configuration, use policy sys-default to export the cluster default configuration

Parameter
Description

name*

The snapshot policy you want to export

path*

The path where export policy file will be located

--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 fs protection snapshot-policy list

List snapshot policies

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,id,name,enable,description,filesystems (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)

--filter-color...

Filter rows with specific colors (red/yellow/green) (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 fs protection snapshot-policy run-once

Runs the snapshot policy schedule once immediately.

Parameter
Description

name*

Name of the snapshot policy

schedule-type*

Schedule type to be run once (format: 'periodic', 'hourly', 'daily', 'weekly' or 'monthly')

--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 fs protection snapshot-policy show

Show snapshot policy configuration

Parameter
Description

name*

Policy name

--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.

-J, --json

Format output as JSON

weka fs protection snapshot-policy update

Update a snapshot policy

Parameter
Description

name*

Existing snapshot policy name

--new-name

New policy name (up to 12 alphanumeric characters, hyphens (-), underscores (_), and periods (.))

--description

New policy description (up to 128 characters)

--path

The path to the new/modified snapshot policy file, must be in JSON format

--enabled

Set snapshot policy status, can be true/false (format: 'yes', 'no', 'true', 'false', 'on', 'off', 'y' or 'n')

--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 fs quota

Commands used to control directory quotas

Parameter
Description

--color

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

-h, --help

Show help message

weka fs quota disable-users

Disable user quota accounting for a filesystem

Parameter
Description

filesystem*

Filesystem name

--snap-name

Optional snapshot name

--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 fs quota enable-users

Enable user quota accounting for a filesystem

Parameter
Description

filesystem*

Filesystem name

--snap-name

Optional snapshot name

--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

--force

Skip version compatibility checks

-h, --help

Show help message

weka fs quota list

List filesystem quotas (directory, user, or group quotas, by default only exceeding directory quotas)

Parameter
Description

filesystem

Filesystem name

--snap-name

Optional snapshot name

--type

Quota type: 'directory', 'user', or 'group'

-p, --path

Show this path only

-u, --under

List under (and including) this path only

--over

Show only quotas over this percentage of usage (format: 0..100)

--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: quotaId,path,used,dblk,mblk,soft,hard,usage,owner,grace_seconds,time_over_soft_limit,status (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)

--filter-color...

Filter rows with specific colors (red/yellow/green) (may be repeated or comma-separated)

--all

Show all (not only exceeding) quotas

-q, --quick

Skip resolving inodes to paths

-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 fs quota list-default

List filesystem default quotas

Parameter
Description

filesystem

Filesystem name

--snap-name

Optional snapshot name

-p, --path

Show this path only

--type

Quota type: 'directory', 'user', or 'group'

--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: inodeId,fs,path,soft,hard,owner,grace (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)

--filter-color...

Filter rows with specific colors (red/yellow/green) (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 fs quota set

Set a directory quota in a filesystem

Parameter
Description

path

Path in the filesystem

--type

Quota type: 'directory', 'user', or 'group'

--id

user or group ID

--soft

Soft limit for the directory, or 0 for unlimited (format: capacity in decimal or binary units: 1B, 1KB, 1MB, 1GB, 1TB, 1PB, 1EB, 1KiB, 1MiB, 1GiB, 1TiB, 1PiB, 1EiB)

--hard

Hard limit for the directory, or 0 for unlimited (format: capacity in decimal or binary units: 1B, 1KB, 1MB, 1GB, 1TB, 1PB, 1EB, 1KiB, 1MiB, 1GiB, 1TiB, 1PiB, 1EiB)

--grace

Soft limit grace period (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--owner

Quota owner (e.g., email)

--filesystem

Filesystem name

--snap-name

Name of the writable snapshot

--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 fs quota set-default

Set a default quota in a filesystem

Parameter
Description

path

Path in the filesystem (required for directory type)

--type

Quota type: 'directory', 'user', or 'group'

--soft

Soft limit (format: capacity in decimal or binary units: 1B, 1KB, 1MB, 1GB, 1TB, 1PB, 1EB, 1KiB, 1MiB, 1GiB, 1TiB, 1PiB, 1EiB)

--hard

Hard limit (format: capacity in decimal or binary units: 1B, 1KB, 1MB, 1GB, 1TB, 1PB, 1EB, 1KiB, 1MiB, 1GiB, 1TiB, 1PiB, 1EiB)

--grace

Soft limit grace period (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)

--owner

Quota owner (e.g., email)

--filesystem

Filesystem name (required for user/group type)

--snap-name

Name of the writable snapshot

--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 fs quota reset

Unsets a directory quota in a filesystem

Parameter
Description

path

Path in the filesystem

--type

Quota type: 'directory', 'user', or 'group'

--id

user or group ID

--generation

Remove a specific generation of quota

--filesystem

Filesystem name

--snap-name

Name of the writable snapshot

--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 fs quota unset-default

Unsets a default quota in a filesystem

Parameter
Description

path

Path in the filesystem (required for directory type)

--type

Quota type: 'directory', 'user', or 'group'

--filesystem

Filesystem name (required for user/group type)

--snap-name

Name of the writable snapshot

--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 fs reserve

Thin provisioning reserve for tenants

Parameter
Description

--color

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

-h, --help

Show help message

weka fs reserve set

Set a tenant's thin provisioning SSD reserve

Parameter
Description

ssd-capacity*

SSD capacity to reserve (format: capacity in decimal or binary units: 1B, 1KB, 1MB, 1GB, 1TB, 1PB, 1EB, 1KiB, 1MiB, 1GiB, 1TiB, 1PiB, 1EiB)

--tenant

Tenant name or ID

--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

-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 fs reserve status

Thin provisioning reserve for tenants

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: id,name,ssdReserve (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)

--filter-color...

Filter rows with specific colors (red/yellow/green) (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 fs reserve reset

Unset a tenant's thin provisioning SSD's reserve

Parameter
Description

--tenant

Tenant name or ID

--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

-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 fs restore

Restore filesystem content from a snapshot

Parameter
Description

filesystem*

The name of the filesystem to be restored

source-name*

The name of the source snapshot

--preserved-overwritten-snapshot-name

Name of a snapshot to create with the old content of the filesystem

--preserved-overwritten-snapshot-access-point

Access point of the preserved overwritten snapshot

--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. This action replaces all data in the filesystem with the content of the snapshot and cannot be undone.

-h, --help

Show help message

-J, --json

Format output as JSON

weka fs security

Manage filesystem security

Parameter
Description

--color

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

-h, --help

Show help message

weka fs security policy

Manages filesystem security policies.

Parameter
Description

--color

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

-h, --help

Show help message

weka fs security policy attach

Attaches new security policies to a filesystem, adding them to the existing policies.

Parameter
Description

filesystem*

Filesystem name.

policies...

Security policies to add for filesystem.

--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 fs security policy detach

Removes security policies from a filesystem.

Parameter
Description

filesystem*

Filesystem name.

policies...

Security policies to remove from filesystem.

--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 fs security policy list

Lists filesystem security policies.

Parameter
Description

filesystem*

Filesystem name.

--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: position,uid,id,name (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)

--filter-color...

Filter rows with specific colors (red/yellow/green) (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 fs security policy reset

Removes all security policies from a filesystem.

Parameter
Description

filesystem*

Filesystem name.

--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 fs security policy set

Sets security policies for a filesystem, replacing the existing list of policies.

Parameter
Description

filesystem*

Filesystem name.

policies...

Security Policies to set for filesystem.

--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 fs snapshot

List snapshots

Parameter
Description

--filesystem

Filesystem name

--name

Snapshot name

--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,filesystem,name,access,writeable,created,local_upload_size,remote_upload_size,local_object_status,local_object_progress,local_object_locator,remote_object_status,remote_object_progress,remote_object_locator,removing,prefetched,est_reclaimable_size,metadata_size (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)

--filter-color...

Filter rows with specific colors (red/yellow/green) (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 fs snapshot access-point-naming-convention

Access point naming convention

Parameter
Description

--color

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

-h, --help

Show help message

weka fs snapshot access-point-naming-convention status

Show access point naming convention

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

-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 fs snapshot access-point-naming-convention update

Update access point naming convention

Parameter
Description

access-point-naming-convention*

access point naming configuration (format: 'date' or 'name')

--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 fs snapshot copy

Copy one snapshot over another

Parameter
Description

filesystem*

Source filesystem name

source-name*

Source snapshot name

destination-name*

Destination snapshot name

--preserved-overwritten-snapshot-name

Name of a snapshot to create with the old content of the destination

--preserved-overwritten-snapshot-access-point

Access point of the preserved overwritten snapshot

--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

-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 fs snapshot add

Create a snapshot

Parameter
Description

filesystem*

Source filesystem name

name*

Target snapshot name

--access-point

Access point

--source-snapshot

Source snapshot

--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,name,access,writeable,created (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)

--filter-color...

Filter rows with specific colors (red/yellow/green) (may be repeated or comma-separated)

--is-writable

Writable

-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 fs snapshot remove

Delete a snapshot

Parameter
Description

filesystem*

Source filesystem name

name*

Snapshot name

--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. This action deletes all data stored by the snapshot and cannot be undone.

-h, --help

Show help message

weka fs snapshot download

Download a snapshot into an existing filesystem

Parameter
Description

filesystem*

Filesystem name

locator*

Locator

--name

Snapshot name (default: uploaded name)

--access-point

Access point (default: uploaded access point)

--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

--allow-non-chronological

Allow downloading snapshots in non-chronological order. This is not recommended, as it will incur high data overhead.

--allow-divergence

Allow downloading snapshots which are not descendants of the last downloaded snapshot.

-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 fs snapshot update

Update snapshot parameters

Parameter
Description

filesystem*

Source filesystem name

name*

Snapshot name

--new-name

Updated snapshot name

--access-point

Access point

--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

-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 fs snapshot upload

Upload a snapshot to object store

Parameter
Description

filesystem*

Filesystem name

snapshot*

Snapshot name

--site

The site of the Object Store to upload to (format: 'local' or 'remote')

--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

--allow-non-chronological

Allow uploading snapshots to remote object-store in non-chronological order. This is not recommended, as it will incur high data overhead.

-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 fs tier

Show object store connectivity for each node in the cluster

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: obsBucket,statusUpload,statusDownload,statusRemove,nodesDown,errors (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)

--filter-color...

Filter rows with specific colors (red/yellow/green) (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 fs tier capacity

List capacities for object store buckets attached to filesystems

Parameter
Description

--filesystem

Filesystem name

--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: fsUid,fsName,bucketUid,bucketName,totalConsumedCapacity,UsedCapacity,reclaimable,reclaimableLowThreshold,reclaimableHighThreshold (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)

--filter-color...

Filter rows with specific colors (red/yellow/green) (may be repeated or comma-separated)

--force-fresh

Refresh the capacities to make sure they are most updated

-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 fs tier fetch

Fetch object-stored files to SSD storage

Parameter
Description

path...

A file path to fetch to SSD storage. Multiple paths can be passed, e.g. `find ...

--non-existing

Behavior for non-existing files (default: error) (format: 'error', 'warn' or 'ignore')

--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

-v, --verbose

Verbose output, showing fetch requests as they are submitted

-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 fs tier location

Show data storage location for a given path

Parameter
Description

path*

Path to get information about

paths...

Extra paths to get information about

--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,type,size,ssdWrite,ssdRead,obsBytes,remoteBytes (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)

--filter-color...

Filter rows with specific colors (red/yellow/green) (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 fs tier obs

List object stores configuration and status

Parameter
Description

--name

Name of the Object Store

--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,name,site,bucketsCount,uploadBucketsUp,downloadBucketsUp,removeBucketsUp,protocol,hostname,port,auth,region,access,secret,downloadBandwidth,uploadBandwidth,remove3Bandwidth,downloads,uploads,removals,maxUploadExtents,maxUploadSize,enableUploadTags,maxUploadRam,stsOperationType,stsRoleArn,stsRoleSessionName,stsDuration (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)

--filter-color...

Filter rows with specific colors (red/yellow/green) (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 fs tier obs update

Edit an existing object store

Parameter
Description

name*

Name of the Object Store

--new-name

New name

--hostname

Hostname (or IP) of the entrypoint to the bucket

--port

Port of the entrypoint to S3 (single Accesser or Load-Balancer)

--protocol

One of: HTTP (default), HTTPS, HTTPS_UNVERIFIED

--auth-method

Authentication method. S3AuthMethod can be None, AWSSignature2 or AWSSignature4

--region

Name of the region we are assigned to work with (usually empty)

--access-key-id

Access Key ID for AWS Signature authentications

--secret-key

Secret Key for AWS Signature authentications

--bandwidth

Bandwidth limitation per core (Mbps) (format: 1..4294967295)

--download-bandwidth

Download bandwidth limitation per core (Mbps) (format: 1..4294967295)

--upload-bandwidth

Upload bandwidth limitation per core (Mbps) (format: 1..4294967295)

--remove-bandwidth

Remove bandwidth limitation per core (Mbps) (format: 1..4294967295)

--max-concurrent-downloads

Maximum number of downloads we concurrently perform on this object store in a single IO node (format: 1..64)

--max-concurrent-uploads

Maximum number of uploads we concurrently perform on this object store in a single IO node (format: 1..64)

--max-concurrent-removals

Maximum number of removals we concurrently perform on this object store in a single IO node (format: 1..64)

--max-extents-in-data-blob

Maximum number of extents' data to upload to an object store data blob

--max-data-blob-size

Maximum size to upload to an object store data blob (format: capacity in decimal or binary units: 1B, 1KB, 1MB, 1GB, 1TB, 1PB, 1EB, 1KiB, 1MiB, 1GiB, 1TiB, 1PiB, 1EiB)

--upload-memory-limit

Maximum RAM to allocate for concurrent uploads to this object store (per node) (format: capacity in decimal or binary units: 1B, 1KB, 1MB, 1GB, 1TB, 1PB, 1EB, 1KiB, 1MiB, 1GiB, 1TiB, 1PiB, 1EiB)

--enable-upload-tags

Enable tagging of uploaded objects (format: 'yes', 'no', 'true', 'false', 'on', 'off', 'y' or 'n')

--sts-operation-type

AWS STS operation type to use. Default: none (format: 'assume_role' or 'none')

--sts-role-arn

The Amazon Resource Name (ARN) of the role to assume. Mandatory when setting sts-operation to ASSUME_ROLE

--sts-role-session-name

An identifier for the assumed role session. Length constraints: Minimum length of 2, maximum length of 64.

owed characters: upper and lo

wer-case alphanumeric characters with no spaces.

weka fs tier ops

List all the operations currently running on an object store from all the hosts in the cluster

Parameter
Description

name

Name of the Object Store bucket

--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: node,obsBucket,key,type,execution,phase,previous,start,size,results,errors,lastHTTP,concurrency,inode (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)

--filter-color...

Filter rows with specific colors (red/yellow/green) (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 fs tier release

Release object-stored files from SSD storage

Parameter
Description

path...

A file path to release from SSD storage. Multiple paths can be passed, e.g. `find ...

--non-existing

Behavior for non-existing files (default: error) (format: 'error', 'warn' or 'ignore')

--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

-v, --verbose

Verbose output, showing release requests as they are submitted

-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 fs tier s3

List S3 object store buckets configuration and status

Parameter
Description

--obs-name

Name of the Object Store

--name

Name of the Object Store bucket

--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,obsId,obsName,id,name,site,statusUpload,statusDownload,statusRemove,nodesUpForUpload,nodesUpForDownload,nodesUpForRemove,nodesDownForUpload,nodesDownForDownload,nodesDownForRemove,nodesUnknownForUpload,nodesUnknownForDownload,nodesUnknownForRemove,errors,protocol,hostname,port,bucket,auth,region,access,secret,status,up,downloadBandwidth,uploadBandwidth,removeBandwidth,errorsTimeout,prefetch,downloads,uploads,removals,maxUploadExtents,maxUploadSize,enableUploadTags,dataStorageClass,metadataStorageClass,stsOperationType,stsRoleArn,stsRoleSessionName,stsDuration (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)

--filter-color...

Filter rows with specific colors (red/yellow/green) (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 fs tier s3 add

Create a new S3 object store bucket connection

Parameter
Description

name*

Name of the Object Store bucket

--site

The site of the Object Store, default: local (format: 'local' or 'remote')

--obs-name

Name of the Object Store to associate this new bucket to

--hostname

Hostname (or IP) of the entrypoint to the storage

--port

Port of the entrypoint to S3 (single Accesser or Load-Balancer)

--bucket

Name of the bucket we are assigned to work with

--auth-method

Authentication method. S3AuthMethod can be None, AWSSignature2 or AWSSignature4

--region

Name of the region we are assigned to work with (usually empty)

--access-key-id

Access Key ID for AWS Signature authentications

--secret-key

Secret Key for AWS Signature authentications

--protocol

One of: HTTP (default), HTTPS, HTTPS_UNVERIFIED

--obs-type

One of: AWS (default), AZURE

--bandwidth

Bandwidth limitation per core (Mbps) (format: 1..4294967295)

--download-bandwidth

Download bandwidth limitation per core (Mbps) (format: 1..4294967295)

--upload-bandwidth

Upload bandwidth limitation per core (Mbps) (format: 1..4294967295)

--remove-bandwidth

Remove bandwidth limitation per core (Mbps) (format: 1..4294967295)

--errors-timeout

If the Object Store bucket link is down for longer than this, all IOs that need data return with an error (format: duration between 1 minute and 15 minutes)

--prefetch-mib

How many MiB of data to prefetch when reading a whole MiB on object store. Default Value is 128MiB (format: 0..600)

--max-concurrent-downloads

Maximum number of downloads we concurrently perform on this object store in a single IO node (format: 1..64)

--max-concurrent-uploads

Maximum number of uploads we concurrently perform on this object store in a single IO node (format: 1..64)

--max-concurrent-removals

Maximum number of removals we concurrently perform on this object store in a single IO node (format: 1..64)

--max-extents-in-data-blob

Maximum number of extents' data to upload to an object store data blob

--max-data-blob-size

Maximum size to upload to an object store data blob (format: capacity in decimal or binary units: 1B, 1KB, 1MB, 1GB, 1TB, 1PB, 1EB, 1KiB, 1MiB, 1GiB, 1TiB, 1PiB, 1EiB)

--enable-upload-tags

Enable tagging of uploaded objects (format: 'yes', 'no', 'true', 'false', 'on', 'off', 'y' or 'n')

--data-storage-class

The AWS storage class / Azure access tier to use for uploaded data blobs

--metadata-storage-class

The AWS storage class / Azure access tier to use for uploaded data blobs

--sts-operation-type

AWS STS operation type to use. Default: none (format: 'assume_role' or 'none')

--sts-role-arn

The Amazon Resource Name (ARN) of the role to assume. Mandatory when setting sts-operation to ASSUME_ROLE

--sts-role-session-name

An identifier for the assumed role session. Length constraints: Minimum length of 2, maximum length of 64.

owed characters: upper and lo

wer-case alphanumeric characters with no spaces.

weka fs tier s3 attach

Attach a filesystem to an existing Object Store

Parameter
Description

filesystem*

Name of the Filesystem

obs-name*

Name of the Object Store bucket to attach

--mode

The operation mode for the Object Store bucket (format: 'writable' or 'remote')

--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 fs tier s3 remove

Delete an existing S3 object store connection

Parameter
Description

name*

Name of the Object Store bucket

--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 fs tier s3 detach

Detach a filesystem from an attached object store

Parameter
Description

filesystem*

Name of the Filesystem

obs-name*

Name of the Object Store bucket to detach

--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

-f, --force

Force this action without further confirmation. This process might take a while to complete and it cannot be aborted. The data will remain intact on the object store, and you can still use the uploaded snapshots for recovery.

weka fs tier s3 snapshot

Commands used to display info about uploaded snapshots

Parameter
Description

--color

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

-h, --help

Show help message

####### weka fs tier s3 snapshot list

List and show info about snapshots uploaded to Object Storage

Parameter
Description

name*

Name of the Object Store bucket

--locator

Locator

--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: guid,fsId,snapId,origFsId,fsName,snapName,accessPoint,totalMetaData,totalSize,ssdCapacity,totalCapacity,maxFiles,numGuids,compatibleVersion (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)

--filter-color...

Filter rows with specific colors (red/yellow/green) (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 fs tier s3 update

Edit an existing S3 object store bucket connection

Parameter
Description

name*

Name of the Object Store bucket

--new-name

New name

--new-obs-name

New Object Store name

--hostname

Hostname (or IP) of the entrypoint to the storage

--port

Port of the entrypoint to S3 (single Accesser or Load-Balancer)

--protocol

One of: HTTP (default), HTTPS, HTTPS_UNVERIFIED

--bucket

Name of the bucket we are assigned to work with

--auth-method

Authentication method. S3AuthMethod can be None, AWSSignature2 or AWSSignature4

--region

Name of the region we are assigned to work with (usually empty)

--access-key-id

Access Key ID for AWS Signature authentications

--secret-key

Secret Key for AWS Signature authentications

--bandwidth

Bandwidth limitation per core (Mbps) (format: 1..4294967295)

--download-bandwidth

Download bandwidth limitation per core (Mbps) (format: 1..4294967295)

--upload-bandwidth

Upload bandwidth limitation per core (Mbps) (format: 1..4294967295)

--remove-bandwidth

Remove bandwidth limitation per core (Mbps) (format: 1..4294967295)

--prefetch-mib

How many MiB of data to prefetch when reading a whole MiB on object store. Default Value is 128MiB (format: 0..600)

--errors-timeout

If the Object Store bucket link is down for longer than this, all IOs that need data return with an error (format: duration between 1 minute and 15 minutes)

--max-concurrent-downloads

Maximum number of downloads we concurrently perform on this object store in a single IO node (format: 1..64)

--max-concurrent-uploads

Maximum number of uploads we concurrently perform on this object store in a single IO node (format: 1..64)

--max-concurrent-removals

Maximum number of removals we concurrently perform on this object store in a single IO node (format: 1..64)

--max-extents-in-data-blob

Maximum number of extents' data to upload to an object store data blob

--max-data-blob-size

Maximum size to upload to an object store data blob (format: capacity in decimal or binary units: 1B, 1KB, 1MB, 1GB, 1TB, 1PB, 1EB, 1KiB, 1MiB, 1GiB, 1TiB, 1PiB, 1EiB)

--enable-upload-tags

Enable tagging of uploaded objects (format: 'yes', 'no', 'true', 'false', 'on', 'off', 'y' or 'n')

--data-storage-class

The AWS storage class / Azure access tier to use for uploaded data blobs

--metadata-storage-class

The AWS storage class / Azure access tier to use for uploaded data blobs

--sts-operation-type

AWS STS operation type to use. Default: none (format: 'assume_role' or 'none')

--sts-role-arn

The Amazon Resource Name (ARN) of the role to assume. Mandatory when setting sts-operation to ASSUME_ROLE

--sts-role-session-name

An identifier for the assumed role session. Length constraints: Minimum length of 2, maximum length of 64.

owed characters: upper and lo

wer-case alphanumeric characters with no spaces.

weka fs update

Update a filesystem

Parameter
Description

name*

Filesystem name

--new-name

New name

--total-capacity

Total capacity (format: capacity in decimal or binary units: 1B, 1KB, 1MB, 1GB, 1TB, 1PB, 1EB, 1KiB, 1MiB, 1GiB, 1TiB, 1PiB, 1EiB)

--ssd-capacity

SSD capacity (format: capacity in decimal or binary units: 1B, 1KB, 1MB, 1GB, 1TB, 1PB, 1EB, 1KiB, 1MiB, 1GiB, 1TiB, 1PiB, 1EiB)

--thin-provision-min-ssd

Thin provision minimum SSD capacity (format: capacity in decimal or binary units: 1B, 1KB, 1MB, 1GB, 1TB, 1PB, 1EB, 1KiB, 1MiB, 1GiB, 1TiB, 1PiB, 1EiB)

--thin-provision-max-ssd

Thin provision maximum SSD capacity (format: capacity in decimal or binary units: 1B, 1KB, 1MB, 1GB, 1TB, 1PB, 1EB, 1KiB, 1MiB, 1GiB, 1TiB, 1PiB, 1EiB)

--audit-enabled

Enable audit logging for this filesystem. Takes effect only if audit is enabled cluster-wide (format: 'yes', 'no', 'true', 'false', 'on', 'off', 'y' or 'n')

--data-reduction

Enable data reduction (format: 'yes', 'no', 'true', 'false', 'on', 'off', 'y' or 'n')

--auth-required

Require the mounting user to be authenticated for mounting this filesystem. This flag is only effective in the root tenant, users in non-root tenants must be authenticated to perform a mount operation. (format: 'yes', 'no', 'true', 'false', 'on', 'off', 'y' or 'n')

--kms-key-identifier

Customize KMS key identifier for this filesystem (currently only for HashiCorp Vault)

--kms-namespace

Customize KMS namespace for this filesystem (currently only for HashiCorp Vault)

--kms-role-id

Customize KMS role-id for this filesystem (currently only for HashiCorp Vault)

--kms-secret-id

Customize KMS secret-id for this filesystem (currently only for HashiCorp Vault)

--index-enabled

Enable catalog indexing for this filesystem (format: 'yes', 'no', 'true', 'false', 'on', 'off', 'y' or 'n')

--max-throughput

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

--max-iops

Limit IOs/s

--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

--use-cluster-kms-key-identifier

Use cluster KMS configuration for this filesystem, removes the custom KMS configuration for this filesystem

-h, --help

Show help message

weka interface-group

List interface groups

Parameter
Description

--name

Group name

--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,name,mask,gateway,type,status,ips,ports,allowManageGids (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)

--filter-color...

Filter rows with specific colors (red/yellow/green) (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 interface-group add

Create an interface group

Parameter
Description

name*

Interface group name

type*

Group type

--subnet

subnet mask in the 255.255.0.0 format

--gateway

gateway ip

--allow-manage-gids

Allow to use manage-gids in exports. With manage-gids, the list of group ids received from the client will be replaced by a list of group ids determined by an appropriate lookup on the server (format: 'yes', 'no', 'true', 'false', 'on', 'off', 'y' or 'n')

--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: name,mask,gateway,type,status,ips,ports,allowManageGids (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)

--filter-color...

Filter rows with specific colors (red/yellow/green) (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 interface-group assignment

List the currently assigned interface for each floating-IP address in the given interface-group. If is not supplied, assignments for all floating-IP addresses will be listed

Parameter
Description

--name

Group name

--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: ip,host,port,group (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)

--filter-color...

Filter rows with specific colors (red/yellow/green) (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 interface-group remove

Delete an interface group

Parameter
Description

name*

Interface group name

--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. This action may disrupt IO service for connected clients and can be undone by re-creating the interface group.

-h, --help

Show help message

weka interface-group ip-range

Commands that manage interface-groups' ip-ranges

Parameter
Description

--color

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

-h, --help

Show help message

weka interface-group ip-range add

Add an ip range to an interface group

Parameter
Description

name*

Interface group name

ips*

IP range

--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 interface-group ip-range remove

Delete an ip range from an interface group

Parameter
Description

name*

Interface group name

ips*

IP range

--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. This action may disrupt IO service for connected clients and can be undone by re-creating the IP range.

-h, --help

Show help message

weka interface-group port

Commands that manage interface-groups' ports

Parameter
Description

--color

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

-h, --help

Show help message

weka interface-group port add

Add a server port to an interface group

Parameter
Description

name*

Interface group name

server-id*

Server ID on which the port resides

port*

Port's device. (e.g. eth1)

--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 interface-group port remove

Delete a server port from an interface group

Parameter
Description

name*

Interface group name

server-id*

Server ID on which the port resides

port*

Port's device. (e.g. eth1)

--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. This action may disrupt IO service for connected clients and can be undone by re-adding the port.

-h, --help

Show help message

weka interface-group update

Update an interface group

Parameter
Description

name*

Interface group name

--subnet

subnet mask in the 255.255.0.0 format

--gateway

gateway ip

--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 local

Commands that control weka and its containers on the local machine

Parameter
Description

--color

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

-h, --help

Show help message

weka local diags

Collect diagnostics from the local machine

Parameter
Description

-i, --id

A unique identifier for this dump

-d, --output-dir

Directory to save the diags dump to, default: /opt/weka/diags

-c, --core-dump-limit

Limit to processing this number of core dumps, if found (default: 1)

--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, --collect-cluster-info

Collect cluster-related information. Warning: Use this flag on one container at a time to avoid straining the cluster.

-t, --tar

Create a TAR of all collected diags

-v, --verbose

Print results of all diags, including successful ones

-h, --help

Show help message

weka local disable

Disable containers by not launching them on machine boot. This does not affect the current running status of the container. In order to change the current status, use the "weka local start/stop" commands. If no container names are specified, this command runs on all containers.

Parameter
Description

container...

The container to disable

--color

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

-t, --type...

The container types to disable (may be repeated or comma-separated)

-h, --help

Show help message

weka local drive

Manage local drives

Parameter
Description

--color

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

-h, --help

Show help message

weka local drive identify

Turn a drive's identify LED on or off

Parameter
Description

serialNumber*

The serial number of the drive

state*

Set the drive's identify LED on or off (format: 'yes', 'no', 'true', 'false', 'on', 'off', 'y' or 'n')

--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 local drive list

List local drives

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: name,serial,capacity,status,manufacturer,model,location,refresh,component (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)

--filter-color...

Filter rows with specific colors (red/yellow/green) (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 local enable

Enable monitoring for the requested containers so they automaticlly start on machine boot. This does not affect the current running status of the container. In order to change the current status, use the "weka local start/stop" commands. If no container names are specified, this command runs on all containers.

Parameter
Description

container...

The container to enable

--color

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

-t, --type...

The container types to enable (may be repeated or comma-separated)

-h, --help

Show help message

weka local events

List the events saved to the local drive. This command does not require authentication and can be used when Weka is turned off.

Parameter
Description

--path

Path to where local events are stored

--container-name

Name of the container whose events will be collected (default default)

--color

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

-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: time,uuid,category,severity,permission,type,entity,node,parameters,hash (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)

--filter-color...

Filter rows with specific colors (red/yellow/green) (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 local extract-hostside

Extrat a hostside app from contaier to host

Parameter
Description

app*

The app to extract

--color

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

-h, --help

Show help message

weka local install-agent

Installs Weka agent on the machine the command is executed from

Parameter
Description

--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

--systemd-graceful-shutdown

Enable graceful shutdown via systemd

-h, --help

Show help message

weka local monitoring

Turn monitoring on/off for the given containers, or all containers if none are specified. When a container is started, it's always monitored. When a container is monitored, it will be restarted if it exits without being stopped through the CLI.

Parameter
Description

enabled*

Whether monitoring should be on or off (format: 'yes', 'no', 'true', 'false', 'on', 'off', 'y' or 'n')

container...

The container to disable

--color

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

-t, --type...

The container types to disable (may be repeated or comma-separated)

-h, --help

Show help message

weka local ps

List the Weka containers running on the machine this command is executed from

Parameter
Description

--color

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

-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: name,containerId,state,status,uptime,unjoinedProcesses,pid,port,versionName,validLease,failure,failureText,failureTime,running,disabled,monitoring,persistent,managementIps,upgradeState (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)

--filter-color...

Filter rows with specific colors (red/yellow/green) (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 local reset-data

Resets the data directory for a given container, making the host no longer aware of the rest of the cluster

Parameter
Description

version-name...

The versions to remove

-C, --container

The container to run in

--color

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

--clean-unused

Delete all container data directories for versions which aren't the current set version

-f, --force

Force this action without further confirmation. This action is destructive and can potentially lose all data in the cluster.

-h, --help

Show help message

weka local resources

List and control container resources

Parameter
Description

-C, --container

The container name

--color

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

--stable

List the resources from the last successful container boot

-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.