CLI reference guide
This CLI reference guide is generated from the output of running the weka command with the help option. It provides detailed descriptions of available commands, arguments, and options.
weka
The base command for all weka related CLIs
weka [--color color] [--help] [--build] [--version] [--legal]
--agent
Start the agent service
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
--build
Prints the CLI build number and exits
-v, --version
Prints the CLI version and exits
--legal
Prints software license information and exits
weka access-group
Commands that manage the cluster access-groups
weka access-group [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka access-group disable
Disable access-groups
weka access-group disable [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-H, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T, --TIMEOUT
Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--profile
Name of the connection and authentication profile to use
-h, --help
Show help message
-J, --json
Format output as JSON
weka access-group enable
Enable access-groups
weka access-group enable [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-H, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T, --TIMEOUT
Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--profile
Name of the connection and authentication profile to use
-h, --help
Show help message
-J, --json
Format output as JSON
weka access-group status
Show the status of the access-groups
weka access-group status [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-H, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T, --TIMEOUT
Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--profile
Name of the connection and authentication profile to use
-h, --help
Show help message
-J, --json
Format output as JSON
weka agent
Commands that control the weka agent (outside the weka containers)
weka agent [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka agent autocomplete
Bash autocompletion utilities
weka agent autocomplete [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka agent autocomplete export
Export bash autocompletion script
weka agent autocomplete export [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka agent autocomplete install
Locally install bash autocompletion utility
weka agent autocomplete install [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka agent autocomplete uninstall
Locally uninstall bash autocompletion utility
weka agent autocomplete uninstall [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka agent install-agent
Installs Weka agent on the machine the command is executed from
weka agent install-agent [--color color] [--no-update] [--no-start] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
--no-update
Don't update the locally installed containers
--no-start
Do not register the weka-agent service and start it after its creation
-h, --help
Show help message
weka agent uninstall
Deletes all Weka files, drivers, shared memory and any other remainder from the machine this command is executed from. WARNING - This action is destructive and might cause a loss of data!
weka agent uninstall [--color color] [--force] [--ignore-wekafs-mounts] [--keep-files] [--help]
--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.
weka agent update-containers [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka alerts
List alerts in the Weka cluster
weka alerts [--severity severity]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--muted]
[--inactive]
[--help]
[--no-header]
[--verbose]
--severity
Include event with equal and higher severity, default: INFO (format: 'debug', 'info', '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 (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)
weka alerts describe [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--no-header]
[--verbose]
--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.
weka alerts mute <alert-type>
<duration>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
alert-type*
An alert-type to mute, use weka alerts types to list types
duration*
How long to mute this alert type for (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-H, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T, --TIMEOUT
Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--profile
Name of the connection and authentication profile to use
-h, --help
Show help message
weka alerts types
List all alert types that can be returned from the Weka cluster
weka alerts types [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
--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.
weka alerts unmute <alert-type>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
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 cloud
Cloud commands. List the cluster's cloud status, if no subcommand supplied.
weka cloud [--color color] [--help]
--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
weka cloud disable [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
--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
weka cloud enable [--cloud-url cloud]
[--cloud-stats on/off]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
--cloud-url
The base url of the cloud service
--cloud-stats
Enable or disable uploading stats to the cloud (format: 'on' or 'off')
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-H, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T, --TIMEOUT
Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--profile
Name of the connection and authentication profile to use
-h, --help
Show help message
weka cloud proxy
Get or set the HTTP proxy used to connect to cloud services
weka cloud proxy [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--set url]
[--help]
[--json]
[--unset]
--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
weka cloud status [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--no-header]
[--verbose]
--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 update
Update cloud settings
weka cloud update <bucket-name>
<region>
<access-key-id>
<secret-key>
[--session-token token]
[--bucket-prefix prefix]
[--proxy proxy]
[--bytes-per-second bytes-per-second]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
bucket-name*
AWS bucket name
region*
AWS region
access-key-id*
AWS access key
secret-key*
AWS secret
--session-token
S3 session token
--bucket-prefix
S3 bucket prefix
--proxy
HTTP(S) proxy to connect to the cloud through
--bytes-per-second
Maximum uploaded bytes per second
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-H, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T, --TIMEOUT
Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--profile
Name of the connection and authentication profile to use
-h, --help
Show help message
weka cloud upload-rate
Get the cloud upload rate
weka cloud upload-rate [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-H, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T, --TIMEOUT
Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--profile
Name of the connection and authentication profile to use
-h, --help
Show help message
-J, --json
Format output as JSON
weka cloud upload-rate set
Set the cloud upload rate
weka cloud upload-rate set [--bytes-per-second bps]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
--bytes-per-second
Maximum uploaded bytes per second
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-H, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T, --TIMEOUT
Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--profile
Name of the connection and authentication profile to use
-h, --help
Show help message
weka cluster
Commands that manage the cluster
weka cluster [--color color] [--help]
--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
weka cluster bucket [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--raw-units]
[--UTC]
[--no-header]
[--verbose]
[<bucket-ids>]...
bucket-ids...
Only return these bucket IDs.
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-H, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T, --TIMEOUT
Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--profile
Name of the connection and authentication profile to use
-f, --format
Specify in what format to output the result (format: 'view', 'csv', 'markdown', 'json' or 'oldview')
-o, --output...
Specify which columns to output. May include any of the following: id,leader,term,lastActiveTerm,state,council,uptime,leaderVersionSig,electableMode,sourceMembers,nonSourceMembers,fillLevel (may be repeated or comma-separated)
-s, --sort...
Specify which column(s) to take into account when sorting the output. May include a '+' or '-' before the column name to sort in ascending or descending order respectively. Usage: [+
-F, --filter...
Specify what values to filter by in a specific column. Usage: column1=val1[,column2=val2[,..]] (may be repeated or comma-separated)
--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
weka cluster client-target-version [--color color] [--help]
--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
weka cluster client-target-version reset [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
--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).
weka cluster client-target-version set <version-name>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
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).
weka cluster client-target-version show [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
--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
weka cluster container [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--local]
[--backends]
[--clients]
[--leadership]
[--leader]
[--help]
[--raw-units]
[--UTC]
[--no-header]
[--verbose]
[<container-ids>]...
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 (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
-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)
weka cluster container activate [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--no-wait]
[--skip-resource-validation]
[--skip-activate-drives]
[--help]
[<container-ids>]...
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
weka cluster container add <hostname>
[--ip ip]
[--host-fqdn host-fqdn]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--no-wait]
[--help]
[--json]
[--raw-units]
[--UTC]
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
weka cluster container apply [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--skip-resource-validation]
[--all]
[--force]
[--help]
[<container-ids>]...
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 auto-remove-timeout
Set how long to wait before removing this container if it disconnects from the cluster (for clients only)
weka cluster container auto-remove-timeout <container-id>
<auto-remove-timeout>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
container-id*
Container ID as shown in weka cluster container
auto-remove-timeout*
Minimum value is 60, use 0 to disable automatic removal
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-H, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T, --TIMEOUT
Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--profile
Name of the connection and authentication profile to use
-h, --help
Show help message
weka cluster container bandwidth
Limit weka's bandwidth for the container
weka cluster container bandwidth <container-id>
<bandwidth>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
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
weka cluster container clear-failure [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[<container-ids>]...
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
weka cluster container cores <container-id>
<cores>
[--frontend-dedicated-cores frontend-dedicated-cores]
[--drives-dedicated-cores drives-dedicated-cores]
[--compute-dedicated-cores compute-dedicated-cores]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--core-ids core-ids]...
[--no-frontends]
[--only-drives-cores]
[--only-compute-cores]
[--only-frontend-cores]
[--allow-mix-setting]
[--help]
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)
weka cluster container deactivate [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--no-wait]
[--skip-resource-validation]
[--allow-unavailable]
[--help]
[<container-ids>]...
container-ids...
A list of container ids to deactivate
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-H, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T, --TIMEOUT
Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--profile
Name of the connection and authentication profile to use
--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
weka cluster container deactivation-check [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
[<container-ids>]...
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
weka cluster container dedicate <container-id>
<on>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
container-id*
Container ID as shown in weka cluster container
on*
Set the container as weka dedicated, off unsets container as weka dedicated (format: 'on' or 'off')
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-H, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T, --TIMEOUT
Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--profile
Name of the connection and authentication profile to use
-h, --help
Show help message
weka cluster container failure-domain
Set the container failure-domain
weka cluster container failure-domain <container-id>
[--name name]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--auto]
[--help]
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
weka cluster container info-hw [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--info-type info-type]...
[--help]
[--json]
[--raw-units]
[--UTC]
[<hostnames>]...
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
weka cluster container join-secret <container-id>
<secret>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
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
weka cluster container management-ips <container-id>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[<management-ips>]...
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
weka cluster container memory <container-id>
<memory>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
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
weka cluster container net [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--raw-units]
[--UTC]
[--no-header]
[--verbose]
[<container-ids>]...
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).
weka cluster container net add <container-id>
<device>
[--ips-type ips-type]
[--gateway gateway]
[--netmask netmask]
[--name name]
[--label label]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--ips ips]...
[--help]
[--json]
[--raw-units]
[--UTC]
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)
-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.
weka cluster container net remove <container-id>
<name>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
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
weka cluster container remove <container-id>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--no-wait]
[--no-unimprint]
[--help]
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 resources
Get the resources of the supplied container
weka cluster container resources <container-id>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--stable]
[--help]
[--json]
[--raw-units]
[--UTC]
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
weka cluster container restore [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--all]
[--help]
[<container-ids>]...
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
weka cluster add [--admin-password admin-password]
[--join-secret join-secret]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--host-ips host-ips]...
[--host-fqdn host-fqdn]...
[--overwrite_resource_ips]
[--help]
[--json]
[<host-hostnames>]...
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
weka cluster default-net [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
[--raw-units]
[--UTC]
--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
weka cluster default-net reset [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
--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
weka cluster default-net set [--range range]
[--gateway gateway]
[--netmask-bits netmask-bits]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
--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
weka cluster default-net update [--range range]
[--gateway gateway]
[--netmask-bits netmask-bits]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
--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
weka cluster drive [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--container container]...
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--show-removed]
[--help]
[--raw-units]
[--UTC]
[--no-header]
[--verbose]
[<uuids>]...
uuids...
A list of drive IDs or UUIDs to list. If no ID is specified, all drives are listed.
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-H, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T, --TIMEOUT
Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--profile
Name of the connection and authentication profile to use
-f, --format
Specify in what format to output the result (format: 'view', 'csv', 'markdown', 'json' or 'oldview')
--container...
Only return the drives of these container IDs, if not specified, all drives are listed (may be repeated or comma-separated)
-o, --output...
Specify which columns to output. May include any of the following: uid,id,uuid,host,hostname,node,path,size,status,stime,fdName,fdId,writable,used,nvkvused,attachment,vendor,firmware,serial,model,added,removed,block,remain,threshold,drive_status_message,pci_vid,pci_id,pci_ssvid,pci_ssid (may be repeated or comma-separated)
-s, --sort...
Specify which column(s) to take into account when sorting the output. May include a '+' or '-' before the column name to sort in ascending or descending order respectively. Usage: [+
-F, --filter...
Specify what values to filter by in a specific column. Usage: column1=val1[,column2=val2[,..]] (may be repeated or comma-separated)
--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)
weka cluster drive activate [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--raw-units]
[--UTC]
[<uuids>]...
uuids...
A list of drive IDs or UUIDs to activate. If no ID is supplied, all inactive drives will be activated.
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-H, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T, --TIMEOUT
Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--profile
Name of the connection and authentication profile to use
-h, --help
Show help message
-R, --raw-units
Print values in raw units (bytes, seconds, etc.). When not set, sizes are printed in human-readable format, e.g 1KiB 234MiB 2GiB.
-U, --UTC
Print times in UTC. When not set, times are converted to the local time of this host.
weka cluster drive add
Add the given drive
weka cluster drive add <container-id>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--force]
[--allow-format-non-wekafs-drives]
[--help]
[--raw-units]
[--UTC]
[--no-header]
[--verbose]
[<device-paths>]...
container-id*
The container the drive attached to (given by ids)
device-paths...
Device paths of the drives to add
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-H, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T, --TIMEOUT
Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--profile
Name of the connection and authentication profile to use
-f, --format
Specify in what format to output the result (format: 'view', 'csv', 'markdown', 'json' or 'oldview')
-o, --output...
Specify which columns to output. May include any of the following: path,uuid (may be repeated or comma-separated)
-s, --sort...
Specify which column(s) to take into account when sorting the output. May include a '+' or '-' before the column name to sort in ascending or descending order respectively. Usage: [+
-F, --filter...
Specify what values to filter by in a specific column. Usage: column1=val1[,column2=val2[,..]] (may be repeated or comma-separated)
--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
Deactivate the supplied drive(s)
weka cluster drive deactivate [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--skip-resource-validation]
[--force]
[--help]
[<uuids>]...
uuids...
A list of drive IDs or UUIDs to deactivate.
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-H, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T, --TIMEOUT
Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--profile
Name of the connection and authentication profile to use
--skip-resource-validation
Skip verifying that the configured hot spare capacity will remain available after deactivating the drives
-f, --force
Force this action without further confirmation. This action may impact performance while the drive is phasing out.
-h, --help
Show help message
weka cluster drive remove
Remove the supplied drive(s)
weka cluster drive remove [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--force]
[--help]
[<uuids>]...
uuids...
A list of drive UUIDs to remove. A UUID is a hex string formatted as 8-4-4-4-12 e.g. 'abcdef12-1234-abcd-1234-1234567890ab'
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-H, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T, --TIMEOUT
Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--profile
Name of the connection and authentication profile to use
-f, --force
Force this action without further confirmation. To undo the removal, add the drive back and re-scan the drives on the host local to the drive.
-h, --help
Show help message
weka cluster drive scan
Scan for provisioned drives on the cluster's containers
weka cluster drive scan [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--raw-units]
[--UTC]
[<container-ids>]...
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
weka cluster failure-domain [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--show-removed]
[--help]
[--raw-units]
[--UTC]
[--no-header]
[--verbose]
--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
weka cluster hot-spare [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--skip-resource-validation]
[--help]
[--json]
[--raw-units]
[--UTC]
[<count>]...
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.
weka cluster license [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
[--raw-units]
[--UTC]
--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
weka cluster license reset [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
--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
weka cluster license set <license>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
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
weka cluster mount-defaults [--color color] [--help]
--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
weka cluster mount-defaults reset [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--qos-max-throughput]
[--qos-preferred-throughput]
[--qos-max-ops]
[--help]
--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.
weka cluster mount-defaults set [--qos-max-throughput qos-max-throughput]
[--qos-preferred-throughput qos-preferred-throughput]
[--qos-max-ops qos-max-ops]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
--qos-max-throughput
qos-max-throughput is the maximum throughput allowed for the client for either receive or transmit traffic.
--qos-preferred-throughput
qos-preferred-throughput is the throughput that gets preferred state (NORMAL instead of LOW) in QoS.
--qos-max-ops
qos-max-ops is the maximum number of operations of any kind for the client
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-H, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T, --TIMEOUT
Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--profile
Name of the connection and authentication profile to use
-h, --help
Show help message
weka cluster mount-defaults show
View default mount options
weka cluster mount-defaults show [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--json]
[--help]
--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 process
List the cluster processes
weka cluster process [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--container container]...
[--role role]...
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--local]
[--backends]
[--clients]
[--leadership]
[--leader]
[--help]
[--raw-units]
[--UTC]
[--no-header]
[--verbose]
[<process-ids>]...
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
-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 requested-action
Manage requested actions
weka cluster requested-action [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka cluster requested-action set
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.
weka cluster requested-action set <requested_action>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[<container-ids>]...
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 servers
Commands for physical servers
weka cluster servers [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka cluster servers list
List the cluster servers
weka cluster servers list [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--role role]...
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--raw-units]
[--UTC]
[--no-header]
[--verbose]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-H, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T, --TIMEOUT
Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--profile
Name of the connection and authentication profile to use
-f, --format
Specify in what format to output the result (format: 'view', 'csv', 'markdown', 'json' or 'oldview')
--role...
Only list machines with specified roles. Possible roles: (format: 'backend', 'client', 'nfs', 'smb' or 's3', may be repeated or comma-separated)
-o, --output...
Specify which columns to output. May include any of the following: hostname,uid,ip,roles,status,up_since,cores,memory,drives,nodes,load,versions,architecture (may be repeated or comma-separated)
-s, --sort...
Specify which column(s) to take into account when sorting the output. May include a '+' or '-' before the column name to sort in ascending or descending order respectively. Usage: [+
-F, --filter...
Specify what values to filter by in a specific column. Usage: column1=val1[,column2=val2[,..]] (may be repeated or comma-separated)
--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 show
Show a single server overview according to given server uid
weka cluster servers show <uid>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--json]
[--help]
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
weka cluster start-io [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
--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
weka cluster stop-io [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--brutal-no-flush]
[--keep-external-containers]
[--force]
[--help]
[--json]
--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
weka cluster task [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--show-waiting]
[--help]
[--raw-units]
[--UTC]
[--no-header]
[--verbose]
--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
-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
weka cluster task abort <task-id>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
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
weka cluster task bucket [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--task task]...
[--bucket bucket]...
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--raw-units]
[--UTC]
[--no-header]
[--verbose]
--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,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
weka cluster task limits [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
--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
weka cluster task limits set [--cpu-limit cpu-limit]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
--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
weka cluster task pause <task-id>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
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
weka cluster task resume <task-id>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
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
weka cluster task throttle <task-id>
[--throttle throttle]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
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
weka cluster update [--cluster-name cluster-name]
[--data-drives data-drives]
[--parity-drives parity-drives]
[--scrubber-bytes-per-sec scrubber-bytes-per-sec]
[--bucket-raft-size bucket-raft-size]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
--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
weka dataservice [--color color] [--help]
--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
weka dataservice global-config [--color color] [--help]
--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
weka dataservice global-config set [--config-fs config-fs]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
--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
weka dataservice global-config show [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
--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
weka diags [--color color] [--help]
--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 hosts to a directory on the host running this command
weka diags collect [--id id]
[--timeout timeout]
[--output-dir output-dir]
[--core-limit core-limit]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--color color]
[--container-id container-id]...
[--clients]
[--backends]
[--tar]
[--verbose]
[--help]
[--raw-units]
[--UTC]
[--json]
-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 hosts. 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 hosts only (by default diags are only collected from backends)
--backends
Collect diags from backend hosts (to be used in combination with --clients to collect from all hosts)
-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
weka diags list [--color color] [--verbose] [--help] [<id>]...
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.
weka diags rm [--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--color color]
[--all]
[--help]
[<id>]...
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 hosts to Weka's support cloud
weka diags upload [--timeout timeout]
[--core-limit core-limit]
[--dump-id dump-id]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--color color]
[--container-id container-id]...
[--clients]
[--backends]
[--tar]
[--help]
[--json]
-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 hosts only (by default diags are only collected from backends)
--backends
Collect diags from backend hosts (to be used in combination with --clients to collect from all hosts)
--tar
Tar and compress local files
-h, --help
Show help message
-J, --json
Format output as JSON
weka driver
Manage Weka drivers
weka driver [--color color] [--help]
--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.
weka driver build [--color color] [--version version] [--help]
--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.
weka driver download [--color color] [--version version] [--kernel-signature kernel-signature] [--from from]... [--help]
--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.
weka driver export <path> [--color color] [--version version] [--kernel-signature kernel-signature] [--help]
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.
weka driver import <path> [--color color] [--overwrite] [--help]
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.
weka driver install [--color color] [--version version] [--help]
--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.
weka driver kernel [--color color] [--help] [--json]
--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.
weka driver pack [--color color] [--version version] [--kernel-signature kernel-signature] [--help]
--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 ready
Checks if kernel drivers are loaded and ready for Weka.
weka driver ready [--color color] [--version version] [--help] [--json] [--quiet]
--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.
weka driver sign <key>
[cert]
[--hash hash]
[--color color]
[--version version]
[--kernel-signature kernel-signature]
[--pack]
[--help]
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
weka events [--num-results num-results]
[--start-time <start>]
[--end-time <end>]
[--severity severity]
[--direction direction]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--type-list type-list]...
[--exclude-type-list exclude-type-list]...
[--category-list category-list]...
[--output output]...
[--show-internal]
[--cloud-time]
[--help]
[--raw-units]
[--UTC]
[--no-header]
[--verbose]
-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, Org, User, Alerts, Licensing, Custom, Kms, Smb, Telemetry, Traces, S3, Security, Agent or KDriver (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
weka events list-local [--start-time <start>]
[--end-time <end>]
[--next next]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--stem-mode]
[--show-internal]
[--help]
[--raw-units]
[--UTC]
[--no-header]
[--verbose]
--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
weka events list-types [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--category category]...
[--type type]...
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--show-internal]
[--help]
[--no-header]
[--verbose]
--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, Org, User, Alerts, Licensing, Custom, Kms, Smb, Telemetry, Traces, S3, Security, Agent or KDriver (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
weka events trigger-event <message>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
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
weka fs [--name name]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--capacities]
[--force-fresh]
[--help]
[--raw-units]
[--UTC]
[--no-header]
[--verbose]
--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 (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
weka fs add <name>
<group-name>
<total-capacity>
[--obs-name obs-name]
[--ssd-capacity ssd-capacity]
[--thin-provision-min-ssd thin-provision-min-ssd]
[--thin-provision-max-ssd thin-provision-max-ssd]
[--kms-key-identifier kms-key-identifier]
[--kms-namespace kms-namespace]
[--kms-role-id kms-role-id]
[--kms-secret-id kms-secret-id]
[--auth-required auth-required]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--encrypted]
[--allow-no-kms]
[--data-reduction]
[--help]
[--json]
[--raw-units]
[--UTC]
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)
--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)
--auth-required
Require the mounting user to be authenticated for mounting this filesystem. This flag is only effective in the root organization, users in non-root organizations must be authenticated to perform a mount operation. (format: 'yes' or 'no')
--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
weka fs remove <name>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--purge-from-obs]
[--force]
[--help]
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
weka fs download <name>
<group-name>
<total-capacity>
<ssd-capacity>
<obs-bucket>
<locator>
[--auth-required auth-required]
[--additional-obs-bucket additional-obs-bucket]
[--snapshot-name snapshot-name]
[--access-point access-point]
[--kms-key-identifier kms-key-identifier]
[--kms-namespace kms-namespace]
[--kms-role-id kms-role-id]
[--kms-secret-id kms-secret-id]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--skip-resource-validation]
[--help]
[--json]
[--raw-units]
[--UTC]
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
--auth-required
Require the mounting user to be authenticated for mounting this filesystem. This flag is only effective in the root organization, users in non-root organizations must be authenticated to perform a mount operation. (format: 'yes' or 'no')
--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
weka fs group [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--raw-units]
[--UTC]
[--no-header]
[--verbose]
--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
weka fs group add <name>
[--target-ssd-retention target-ssd-retention]
[--start-demote start-demote]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
[--raw-units]
[--UTC]
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
weka fs group remove <name>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
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
weka fs group update <name>
[--new-name new-name]
[--target-ssd-retention target-ssd-retention]
[--start-demote start-demote]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
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
weka fs kms-rewrap <name>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
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
weka fs protection [--color color] [--help]
--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
weka fs protection snapshot-policy [--color color] [--help]
--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
weka fs protection snapshot-policy attach <name>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--raw-units]
[--UTC]
[<filesystems>]...
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
weka fs protection snapshot-policy add <name>
<path>
[--description description]
[--enabled enabled]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
[--raw-units]
[--UTC]
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
--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
weka fs protection snapshot-policy remove <name>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--force]
[--help]
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
weka fs protection snapshot-policy detach <name>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--remove-waiting-tasks]
[--help]
[--raw-units]
[--UTC]
[--force]
[<filesystems>]...
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.
weka fs protection snapshot-policy duplicate <policyName>
<name>
[--description description]
[--include-attached-filesystems include-attached-filesystems]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
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
--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
weka fs protection snapshot-policy export <name>
<path>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
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
weka fs protection snapshot-policy list [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--raw-units]
[--UTC]
[--no-header]
[--verbose]
--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.
weka fs protection snapshot-policy run-once <name>
<schedule-type>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
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
weka fs protection snapshot-policy show <name>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--raw-units]
[--UTC]
[--json]
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
weka fs protection snapshot-policy update <name>
[--new-name new-name]
[--description description]
[--path path]
[--enabled enabled]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
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
--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
weka fs quota [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka fs quota list
List filesystem quotas (by default, only exceeding ones)
weka fs quota list [filesystem]
[--snap-name snap-name]
[--path path]
[--under under]
[--over over]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--all]
[--quick]
[--help]
[--raw-units]
[--UTC]
[--no-header]
[--verbose]
filesystem
Filesystem name
--snap-name
Optional snapshot name
-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
weka fs quota list-default [filesystem]
[--snap-name snap-name]
[--path path]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--raw-units]
[--UTC]
[--no-header]
[--verbose]
filesystem
Filesystem name
--snap-name
Optional snapshot name
-p, --path
Show this path only
--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,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
weka fs quota set <path>
[--soft soft]
[--hard hard]
[--grace grace]
[--owner owner]
[--filesystem filesystem]
[--snap-name snap-name]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
path*
Path in the filesystem
--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 directory quota in a filesystem
weka fs quota set-default <path>
[--soft soft]
[--hard hard]
[--grace grace]
[--owner owner]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
path*
Path in the filesystem
--soft
Soft limit for the directory (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 (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)
--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
weka fs quota reset <path>
[--generation generation]
[--filesystem filesystem]
[--snap-name snap-name]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
path*
Path in the filesystem
--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 directory quota in a filesystem
weka fs quota unset-default <path>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
path*
Path in the 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
weka fs reserve
Thin provisioning reserve for organizations
weka fs reserve [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka fs reserve set
Set an organization's thin provisioning SSD reserve
weka fs reserve set <ssd-capacity>
[--org org]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
[--raw-units]
[--UTC]
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)
--org
Organization 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 organizations
weka fs reserve status [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--raw-units]
[--UTC]
[--no-header]
[--verbose]
--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 an organization's thin provisioning SSD's reserve
weka fs reserve reset [--org org]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
[--raw-units]
[--UTC]
--org
Organization 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
weka fs restore <filesystem>
<source-name>
[--preserved-overwritten-snapshot-name preserved-overwritten-snapshot-name]
[--preserved-overwritten-snapshot-access-point preserved-overwritten-snapshot-access-point]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--force]
[--help]
[--json]
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
weka fs security [--color color] [--help]
--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.
weka fs security policy [--color color] [--help]
--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.
weka fs security policy attach <filesystem>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
[<policies>]...
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.
weka fs security policy detach <filesystem>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
[<policies>]...
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.
weka fs security policy list <filesystem>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--raw-units]
[--UTC]
[--no-header]
[--verbose]
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.
weka fs security policy reset <filesystem>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
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.
weka fs security policy set <filesystem>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
[<policies>]...
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
weka fs snapshot [--filesystem filesystem]
[--name name]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--raw-units]
[--UTC]
[--no-header]
[--verbose]
--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
weka fs snapshot access-point-naming-convention [--color color] [--help]
--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
weka fs snapshot access-point-naming-convention status [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
[--raw-units]
[--UTC]
--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
weka fs snapshot access-point-naming-convention update <access-point-naming-convention>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
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
weka fs snapshot copy <filesystem>
<source-name>
<destination-name>
[--preserved-overwritten-snapshot-name preserved-overwritten-snapshot-name]
[--preserved-overwritten-snapshot-access-point preserved-overwritten-snapshot-access-point]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
[--raw-units]
[--UTC]
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
weka fs snapshot add <filesystem>
<name>
[--access-point access-point]
[--source-snapshot source-snapshot]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--is-writable]
[--help]
[--raw-units]
[--UTC]
[--no-header]
[--verbose]
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
weka fs snapshot remove <filesystem>
<name>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--force]
[--help]
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
weka fs snapshot download <filesystem>
<locator>
[--name name]
[--access-point access-point]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--allow-non-chronological]
[--allow-divergence]
[--help]
[--json]
[--raw-units]
[--UTC]
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
weka fs snapshot update <filesystem>
<name>
[--new-name new-name]
[--access-point access-point]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
[--raw-units]
[--UTC]
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
weka fs snapshot upload <filesystem>
<snapshot>
[--site site]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--allow-non-chronological]
[--help]
[--json]
[--raw-units]
[--UTC]
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
weka fs tier [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--raw-units]
[--UTC]
[--no-header]
[--verbose]
--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
weka fs tier capacity [--filesystem filesystem]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--force-fresh]
[--help]
[--raw-units]
[--UTC]
[--no-header]
[--verbose]
--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,reclaimableThreshold,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
weka fs tier fetch [--non-existing non-existing]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--verbose]
[--help]
[--raw-units]
[--UTC]
[<path>]...
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
weka fs tier location <path>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--raw-units]
[--UTC]
[--no-header]
[--verbose]
[<paths>]...
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
weka fs tier obs [--name name]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--raw-units]
[--UTC]
[--no-header]
[--verbose]
--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
weka fs tier obs update <name>
[--new-name new-name]
[--hostname hostname]
[--port port]
[--protocol protocol]
[--auth-method auth-method]
[--region region]
[--access-key-id access-key-id]
[--secret-key secret-key]
[--bandwidth bandwidth]
[--download-bandwidth download-bandwidth]
[--upload-bandwidth upload-bandwidth]
[--remove-bandwidth remove-bandwidth]
[--max-concurrent-downloads max-concurrent-downloads]
[--max-concurrent-uploads max-concurrent-uploads]
[--max-concurrent-removals max-concurrent-removals]
[--max-extents-in-data-blob max-extents-in-data-blob]
[--max-data-blob-size max-data-blob-size]
[--upload-memory-limit upload-memory-limit]
[--enable-upload-tags enable-upload-tags]
[--sts-operation-type sts-operation-type]
[--sts-role-arn sts-role-arn]
[--sts-role-session-name sts-role-session-name]
[--sts-session-duration sts-session-duration]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--raw-units]
[--UTC]
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
--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
weka fs tier ops [name]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--raw-units]
[--UTC]
[--no-header]
[--verbose]
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
weka fs tier release [--non-existing non-existing]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--verbose]
[--help]
[--raw-units]
[--UTC]
[<path>]...
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
weka fs tier s3 [--obs-name obs-name]
[--name name]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--raw-units]
[--UTC]
[--no-header]
[--verbose]
--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
weka fs tier s3 add <name>
[--site site]
[--obs-name obs-name]
[--hostname hostname]
[--port port]
[--bucket bucket]
[--auth-method auth-method]
[--region region]
[--access-key-id access-key-id]
[--secret-key secret-key]
[--protocol protocol]
[--obs-type obs-type]
[--bandwidth bandwidth]
[--download-bandwidth download-bandwidth]
[--upload-bandwidth upload-bandwidth]
[--remove-bandwidth remove-bandwidth]
[--errors-timeout errors-timeout]
[--prefetch-mib prefetch-mib]
[--max-concurrent-downloads max-concurrent-downloads]
[--max-concurrent-uploads max-concurrent-uploads]
[--max-concurrent-removals max-concurrent-removals]
[--max-extents-in-data-blob max-extents-in-data-blob]
[--max-data-blob-size max-data-blob-size]
[--enable-upload-tags enable-upload-tags]
[--data-storage-class data-storage-class]
[--metadata-storage-class metadata-storage-class]
[--sts-operation-type sts-operation-type]
[--sts-role-arn sts-role-arn]
[--sts-role-session-name sts-role-session-name]
[--sts-session-duration sts-session-duration]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--dry-run]
[--skip-verification]
[--verbose-errors]
[--help]
[--json]
[--raw-units]
[--UTC]
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
--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
weka fs tier s3 attach <filesystem>
<obs-name>
[--mode mode]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--raw-units]
[--UTC]
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
weka fs tier s3 remove <name>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
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
weka fs tier s3 detach <filesystem>
<obs-name>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--force]
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
weka fs tier s3 snapshot [--color color] [--help]
--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
weka fs tier s3 snapshot list <name>
[--locator locator]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--raw-units]
[--UTC]
[--no-header]
[--verbose]
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
weka fs tier s3 update <name>
[--new-name new-name]
[--new-obs-name new-obs-name]
[--hostname hostname]
[--port port]
[--protocol protocol]
[--bucket bucket]
[--auth-method auth-method]
[--region region]
[--access-key-id access-key-id]
[--secret-key secret-key]
[--bandwidth bandwidth]
[--download-bandwidth download-bandwidth]
[--upload-bandwidth upload-bandwidth]
[--remove-bandwidth remove-bandwidth]
[--prefetch-mib prefetch-mib]
[--errors-timeout errors-timeout]
[--max-concurrent-downloads max-concurrent-downloads]
[--max-concurrent-uploads max-concurrent-uploads]
[--max-concurrent-removals max-concurrent-removals]
[--max-extents-in-data-blob max-extents-in-data-blob]
[--max-data-blob-size max-data-blob-size]
[--enable-upload-tags enable-upload-tags]
[--data-storage-class data-storage-class]
[--metadata-storage-class metadata-storage-class]
[--sts-operation-type sts-operation-type]
[--sts-role-arn sts-role-arn]
[--sts-role-session-name sts-role-session-name]
[--sts-session-duration sts-session-duration]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--dry-run]
[--skip-verification]
[--verbose-errors]
[--help]
[--raw-units]
[--UTC]
[--no-header]
[--verbose]
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
--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
weka fs update <name>
[--new-name new-name]
[--total-capacity total-capacity]
[--ssd-capacity ssd-capacity]
[--thin-provision-min-ssd thin-provision-min-ssd]
[--thin-provision-max-ssd thin-provision-max-ssd]
[--data-reduction data-reduction]
[--auth-required auth-required]
[--kms-key-identifier kms-key-identifier]
[--kms-namespace kms-namespace]
[--kms-role-id kms-role-id]
[--kms-secret-id kms-secret-id]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--use-cluster-kms-key-identifier]
[--help]
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)
--data-reduction
Enable data reduction
--auth-required
Require the mounting user to be authenticated for mounting this filesystem. This flag is only effective in the root organization, users in non-root organizations must be authenticated to perform a mount operation. (format: 'yes' or 'no')
--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)
--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
weka interface-group [--name name]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--no-header]
[--verbose]
--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
weka interface-group add <name>
<type>
[--subnet subnet]
[--gateway gateway]
[--allow-manage-gids allow-manage-gids]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--no-header]
[--verbose]
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: 'on' or 'off')
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-H, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T, --TIMEOUT
Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--profile
Name of the connection and authentication profile to use
-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
weka interface-group assignment [--name name]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--no-header]
[--verbose]
--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
weka interface-group remove <name>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--force]
[--help]
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
weka interface-group ip-range [--color color] [--help]
--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
weka interface-group ip-range add <name>
<ips>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
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
weka interface-group ip-range remove <name>
<ips>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--force]
[--help]
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
weka interface-group port [--color color] [--help]
--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
weka interface-group port add <name>
<server-id>
<port>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
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
weka interface-group port remove <name>
<server-id>
<port>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--force]
[--help]
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
weka interface-group update <name>
[--subnet subnet]
[--gateway gateway]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
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
weka local [--color color] [--help]
--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
weka local diags [--id id]
[--output-dir output-dir]
[--core-dump-limit core-dump-limit]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--collect-cluster-info]
[--tar]
[--verbose]
[--help]
-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 host 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.
weka local disable [--color color] [--type type]... [--help] [<container>]...
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 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.
weka local enable [--color color] [--type type]... [--help] [<container>]...
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.
weka local events [--path path]
[--container-name container-name]
[--color color]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--raw-units]
[--UTC]
[--no-header]
[--verbose]
--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 install-agent
Installs Weka agent on the machine the command is executed from
weka local install-agent [--color color] [--no-update] [--no-start] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
--no-update
Don't update the locally installed containers
--no-start
Do not register the weka-agent service and start it after its creation
-h, --help
Show help message
weka 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.
weka local monitoring <enabled> [--color color] [--type type]... [--help] [<container>]...
enabled*
Whether monitoring should be on or off (format: 'on' or 'off')
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
weka local ps [--color color]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--raw-units]
[--UTC]
[--no-header]
[--verbose]
--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,state,running,disabled,uptime,monitoring,persistent,port,pid,status,versionName,failureText,failure,failureTime,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
weka local reset-data [--container container] [--color color] [--clean-unused] [--force] [--help] [<version-name>]...
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
weka local resources [--container container] [--color color] [--stable] [--help] [--json] [--raw-units] [--UTC]
-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.
weka local resources apply
Apply changes to resources locally
weka local resources apply [--container container] [--color color] [--graceful] [--help] [--force]
-C, --container
The container name
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-g, --graceful
Restart the container gracefully
-h, --help
Show help message
-f, --force
Force this action without further confirmation. This action will restart the container on this host and cannot be undone.
weka local resources auto-remove-timeout
Configure the auto-remove-timeout (in seconds) to remove inactive client containers.
weka local resources auto-remove-timeout <auto-remove-timeout>
[--container container]
[--color color]
[--force]
[--help]
auto-remove-timeout*
The auto-remove timeout in seconds to remove inactive client containers.
-C, --container
The container name
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-f, --force
Force this action without further confirmation. This would cause a non-client container to become a client and this action is irreversible..
-h, --help
Show help message
weka local resources bandwidth
Limit weka's bandwidth for the host
weka local resources bandwidth <bandwidth> [--container container] [--color color] [--help]
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)
-C, --container
The container name
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka local resources base-port
Change the port-range used by the container. Weka containers require 100 ports to operate.
weka local resources base-port <base-port> [--container container] [--color color] [--help]
base-port*
The first port that will be used by the Weka container, out of a total of 100 ports.
-C, --container
The container name
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka local resources cores
Change the core configuration of the host
weka local resources cores <cores>
[--container container]
[--frontend-dedicated-cores frontend-dedicated-cores]
[--drives-dedicated-cores drives-dedicated-cores]
[--compute-dedicated-cores compute-dedicated-cores]
[--color color]
[--core-ids core-ids]...
[--no-frontends]
[--only-drives-cores]
[--only-compute-cores]
[--only-frontend-cores]
[--allow-mix-setting]
[--help]
cores*
Number of CPU cores dedicated to weka - If set to 0 - no drive could be added to this host
-C, --container
The container name
--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')
--core-ids...
Specify the ids of weka dedicated cores (may be repeated or comma-separated)
--no-frontends
Don't allocate frontend nodes
--only-drives-cores
Create only nodes with a drives role
--only-compute-cores
Create only nodes with a compute role
--only-frontend-cores
Create only nodes 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 local resources dedicate
Set the host as dedicated to weka. For example it can be rebooted whenever needed, and configured by weka for optimal performance and stability
weka local resources dedicate <on> [--container container] [--color color] [--help]
on*
Set the host as weka dedicated, off unsets host as weka dedicated (format: 'on' or 'off')
-C, --container
The container name
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka local resources export
Export stable resources to file
weka local resources export <path> [--container container] [--color color] [--staging] [--stable] [--help]
path*
Path to export resources
-C, --container
The container name
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
--staging
List the resources from the currently staged resources that were not yet applied
--stable
List the resources from the currently stable resources, which are the last known good resources
-h, --help
Show help message
weka local resources failure-domain
Set the host failure-domain
weka local resources failure-domain [--container container] [--name name] [--color color] [--auto] [--help]
-C, --container
The container name
--name
Add this host 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')
--auto
Set this host to be a failure-domain of its own
-h, --help
Show help message
weka local resources fqdn
Configure the fqdn to be used by other containers for TLS hostname verification when interacting with the cluster.
weka local resources fqdn <fqdn> [--container container] [--color color] [--help]
fqdn*
The Fully Qualified Domain Name (FQDN) to be used by other containers for TLS hostname verification when interacting with the cluster.
-C, --container
The container name
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka local resources import
Import resources from file
weka local resources import <path> [--container container] [--color color] [--with-identifiers] [--help] [--force]
path*
Path of file to import resources from
-C, --container
The container name
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
--with-identifiers
Import net device unique identifiers
-h, --help
Show help message
-f, --force
Force this action without further confirmation. This action will override any resource changes that have not been applied, and cannot be undone.
weka local resources join-ips
Set the IPs and ports of all hosts in the cluster. This will enable the host to join the cluster using these IPs.
weka local resources join-ips [--container container]
[--color color]
[--join-fqdns join-fqdns]...
[--restricted]
[--help]
[<management-ips>]...
management-ips...
New IP:port pairs for the management processes. If no port is used the command will use the default Weka port
-C, --container
The container name
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
--join-fqdns...
FQDN:port pairs for the management processes. If no port is used the command will use the default Weka port (may be repeated or comma-separated)
--restricted
Join using restricted client port
-h, --help
Show help message
weka local resources join-secret
Configure the secret used when joining a cluster as a backend
weka local resources join-secret <secret> [--container container] [--color color] [--purge] [--help]
secret*
Cluster join secret
-C, --container
The container name
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
--purge
Purge previous join secrets
-h, --help
Show help message
weka local resources management-ips
Set the host's management node IPs. Setting 2 IPs will turn this hosts networking into highly-available mode
weka local resources management-ips [--container container] [--color color] [--help] [<management-ips>]...
management-ips...
New IPs for the management nodes
-C, --container
The container name
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka local resources memory
Dedicate a set amount of RAM to weka
weka local resources memory <memory> [--container container] [--color color] [--help]
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)
-C, --container
The container name
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka local resources net
List and control container resources
weka local resources net [--container container] [--color color] [--stable] [--help] [--json]
-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
weka local resources net add
Allocate a dedicated networking device on a host (to the cluster).
weka local resources net add <device>
[--container container]
[--gateway gateway]
[--netmask netmask]
[--name name]
[--label label]
[--vfs vfs]
[--vlan vlan]
[--color color]
[--ips ips]...
[--help]
device*
Network device pci-slot/mac-address/interface-name(s)
-C, --container
The container name
--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
--vfs
The number of VFs to preallocate (default is all supported by NIC)
--vlan
The VLAN to use (802.1Q, Ethernet only, 1-4094)
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
--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)
-h, --help
Show help message
weka local resources net remove
Undedicate a networking device in a host.
weka local resources net remove <name> [--container container] [--color color] [--help]
name*
Net device name or identifier as appears in weka local resources net
-C, --container
The container name
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka local resources restore
Restore resources from Stable resources
weka local resources restore [--container container] [--color color] [--help]
-C, --container
The container name
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka local restart
Restart a Weka container
weka local restart [--wait-time wait-time]
[--color color]
[--type type]...
[--dont-restart-dependent-containers]
[--force]
[--help]
[<container>]...
container...
The container to restart
-w, --wait-time
How long to wait for the container to start (default: 15m) (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-t, --type...
The container types to restart (may be repeated or comma-separated)
--dont-restart-dependent-containers
Do not restart dependent containers
-f, --force
Skip the check for active mounts and perform an ungraceful restart
-h, --help
Show help message
weka local rm
Delete a Weka container from the machine this command is executed from (this removed the data associated with the container, but retains the downloaded software)
weka local rm [--color color] [--all] [--force] [--help] [<containers>]...
containers...
The containers to remove
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
--all
Remove all containers
-f, --force
Force this action without further confirmation. This would delete all data associated with the container(s) and can potentially lose all data in the cluster.
-h, --help
Show help message
weka local run
Execute a command inside a new container that has the same mounts as the given container. If no container is specified, either "default" or the only defined container is selected. If no command is specified, opens an interactive shell.
weka local run [--container container] [--in in] [--color color] [--environment environment]... [--help] [<command>]...
-C, --container
The container to run in
--in
The container version to run the command in
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-e, --environment...
Environment variable to add (may be repeated)
-h, --help
Show help message
weka local setup
Container setup commands
weka local setup [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka local setup client
Setup a local weka client container
weka local setup client [--name name]
[--cores cores]
[--memory memory]
[--bandwidth bandwidth]
[--timeout timeout]
[--base-port base-port]
[--weka-version weka-version]
[--fqdn fqdn]
[--color color]
[--core-ids core-ids]...
[--management-ips management-ips]...
[--join-ips join-ips]...
[--net net]...
[--disable]
[--no-start]
[--allow-mix-setting]
[--restricted]
[--help]
-n, --name
The name to give the container
--cores
Number of CPU cores dedicated to weka
--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)
--bandwidth
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)
-t, --timeout
Join command timeout in seconds (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--base-port
The first port that will be used by the Weka container, out of a total of 100 ports.
--weka-version
Use the specified version to start the container in
--fqdn
The Fully Qualified Domain Name (FQDN) to be used by other containers for TLS hostname verification when interacting with the cluster
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
--core-ids...
Specify the ids of weka dedicated cores (may be repeated or comma-separated)
--management-ips...
New IPs for the management nodes (may be repeated or comma-separated)
--join-ips...
New IP:port pairs for the management processes. If no port is used the command will use the default Weka port (may be repeated or comma-separated)
--net...
Network specification - /[ip]/[bits]/[gateway]. Or: 'udp' to enforce UDP and avoid an attempt of auto deduction (may be repeated or comma-separated)
--disable
Should the container be created as disabled
--no-start
Do not start the container after its creation
--allow-mix-setting
Allow specified core-ids even if there are running containers with AUTO core-ids allocation on the same server.
--restricted
Restricted client mode functionality only
-h, --help
Show help message
weka local setup container
Setup a local weka container
weka local setup container [--name name]
[--cores cores]
[--frontend-dedicated-cores frontend-dedicated-cores]
[--drives-dedicated-cores drives-dedicated-cores]
[--compute-dedicated-cores compute-dedicated-cores]
[--memory memory]
[--bandwidth bandwidth]
[--failure-domain failure-domain]
[--timeout timeout]
[--container-id container-id]
[--base-port base-port]
[--resources-path resources-path]
[--weka-version weka-version]
[--fqdn fqdn]
[--auto-remove-timeout auto-remove-timeout]
[--color color]
[--core-ids core-ids]...
[--management-ips management-ips]...
[--join-ips join-ips]...
[--join-fqdns join-fqdns]...
[--net net]...
[--disable]
[--no-start]
[--no-frontends]
[--only-drives-cores]
[--only-compute-cores]
[--only-frontend-cores]
[--only-dataserv-cores]
[--allow-mix-setting]
[--dedicate]
[--force]
[--ignore-used-ports]
[--skip-management-ips-check]
[--client]
[--restricted]
[--help]
-n, --name
The name to give the container
--cores
Number of CPU cores dedicated to weka
--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 )
--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)
--bandwidth
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)
--failure-domain
Add this container to a named failure-domain. A failure-domain will be created if it doesn't exist yet. If not specified, an automatic failure domain will be assigned.
-t, --timeout
Join command timeout in seconds (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--container-id
Designate a container-id that will be used when the container joins the cluster
--base-port
The first port that will be used by the Weka container, out of a total of 100 ports.
--resources-path
Import the container's resources from a file (additional command-line flags specified will override the resources in the file)
--weka-version
Use the specified version to start the container in
--fqdn
The Fully Qualified Domain Name (FQDN) to be used by other containers for TLS hostname verification when interacting with the cluster
--auto-remove-timeout
Set the timeout (in seconds) to remove inactive client containers. Applies only with the --client flag.
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
--core-ids...
Specify the ids of weka dedicated cores (may be repeated or comma-separated)
--management-ips...
New IPs for the management nodes (may be repeated or comma-separated)
--join-ips...
New IP:port pairs for the management processes. If no port is used the command will use the default Weka port (may be repeated or comma-separated)
--join-fqdns...
FQDN:port pairs for the management processes. If no port is used the command will use the default Weka port (may be repeated or comma-separated)
--net...
Network specification - /[ip]/[bits]/[gateway]. Or: 'udp' to enforce UDP and avoid an attempt of auto deduction (may be repeated or comma-separated)
--disable
Should the container be created as disabled
--no-start
Do not start the container after its creation
--no-frontends
Don't allocate frontend nodes
--only-drives-cores
Create only nodes with a drives role
--only-compute-cores
Create only nodes with a compute role
--only-frontend-cores
Create only nodes with a frontend role
--only-dataserv-cores
Create only nodes with a dataserv role
--allow-mix-setting
Allow specified core-ids even if there are running containers with AUTO core-ids allocation on the same server.
--dedicate
Set the host as weka dedicated
--force
Create a new container even if a container with the same name exists, disregarding all safety checks!
--ignore-used-ports
Allow container to start even if the required ports are used by other processes
--skip-management-ips-check
Skip The enforcement of management IPs
--client
Create persistent client container
--restricted
Restricted client mode functionality only
-h, --help
Show help message
weka local setup envoy
Setup a local envoy container
weka local setup envoy [--name name] [--color color] [--disable] [--no-start] [--help]
-n, --name
The name to give the container
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
--disable
Should the container be created as disabled
--no-start
Do not start the container after its creation
-h, --help
Show help message
weka local setup services
Setup a local services container
weka local setup services [--dependent-container-name dependent-container-name]
[--color color]
[--disable]
[--no-start]
[--help]
-dep, --dependent-container-name
The name of the container that the service container depends on
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
--disable
Should the container be created as disabled
--no-start
Do not start the container after its creation
-h, --help
Show help message
weka local setup taskmon
Setup a local taskmon container
weka local setup taskmon [--color color] [--disable] [--no-start] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
--disable
Should the container be created as disabled
--no-start
Do not start the container after its creation
-h, --help
Show help message
weka local setup weka
Setup a local weka container
weka local setup weka [--name name] [--color color] [--disable] [--no-start] [--help]
-n, --name
The name to give the container
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
--disable
Should the container be created as disabled
--no-start
Do not start the container after its creation
-h, --help
Show help message
weka local start
Start a Weka container
weka local start [--wait-time wait-time]
[--color color]
[--type type]...
[--skip-start-and-enable-dependent]
[--help]
[<container>]...
container...
The container to start
-w, --wait-time
How long to wait for the container to start (default: 15m) (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-t, --type...
The container types to start (may be repeated or comma-separated)
--skip-start-and-enable-dependent
Skip starting and enabling dependent containers when starting containers by name
-h, --help
Show help message
weka local status
Show the status of a Weka container
weka local status [--color color] [--type type]... [--verbose] [--help] [--json] [<container>]...
container...
The container to display it's status
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-t, --type...
The container types to show (may be repeated or comma-separated)
-v, --verbose
Verbose mode
-h, --help
Show help message
-J, --json
Format output as JSON
weka local stop
Stop a Weka container
weka local stop [--reason reason]
[--color color]
[--type type]...
[--skip-stop-and-disable-dependent]
[--force]
[--help]
[<container>]...
container...
The container to stop
--reason
The reason weka was stopped, will be presented to the user during 'weka status'
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-t, --type...
The container types to stop (may be repeated or comma-separated)
--skip-stop-and-disable-dependent
Skip stopping and disabling dependent containers
-f, --force
Skip the check for active mounts and perform an ungraceful stop
-h, --help
Show help message
weka local upgrade
Upgrade a Weka Host Container to its cluster version
weka local upgrade [--container container]
[--target-version target-version]
[--upgrade-container-timeout upgrade-container-timeout]
[--prepare-container-timeout prepare-container-timeout]
[--container-action-timeout container-action-timeout]
[--color color]
[--allow-not-ready]
[--dont-upgrade-agent]
[--upgrade-dependents]
[--all]
[--help]
-C, --container
The container name
-t, --target-version
Specify a specific target version for upgrade, instead of upgrading to the backend's version.
NOTE - This parameter is
DANGEROUS, use with caution. Incorrect usage may cause upgrade failure.
--upgrade-container-timeout
How long to wait for the container to upgrade. default is 120s (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--prepare-container-timeout
How long to wait for the container to prepare for upgrade. default is 120s (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--container-action-timeout
How long to wait for the container action to run before timing out and retrying 30s (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
--allow-not-ready
Allow starting local upgrade while the container is not fully up
--dont-upgrade-agent
Don't upgrade the weka agent
--upgrade-dependents
Upgrade dependent containers
--all
Upgrade all containers
-h, --help
Show help message
weka mount
Mounts a wekafs filesystem. This is the helper utility installed at /sbin/mount.wekafs.
weka mount <source>
<target>
[--option option]
[--type type]
[--color color]
[--no-mtab]
[--sloppy]
[--fake]
[--verbose]
[--help]
[--raw-units]
[--UTC]
source*
Source filesystem to mount
target*
Location to mount the source filesystem on
-o, --option
Mount options
-t, --type
The filesystem type
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-n, --no-mtab
Mount without writing in /etc/mtab. This is necessary for example when /etc is on a read-only filesystem
-s, --sloppy
Tolerate sloppy mount options rather than failing
-f, --fake
Causes everything to be done except for the actual system call
-v, --verbose
Verbose mode
-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 nfs
Commands that manage client-groups, permissions and interface-groups
weka nfs [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka nfs client-group
Lists NFS client groups
weka nfs client-group [--name name]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--no-header]
[--verbose]
--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,rules (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 nfs client-group add
Create an NFS client group
weka nfs client-group add <name>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--no-header]
[--verbose]
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: name,rules (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 nfs client-group remove
Delete an NFS client group
weka nfs client-group remove <name>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--force]
[--help]
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, --force
Force this action without further confirmation. This action may disrupt IO service for connected NFS clients and can be undone by re-creating the client group.
-h, --help
Show help message
weka nfs clients
NFS Clients usage information
weka nfs clients [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka nfs clients show
Show NFS Clients usage information. If no options are given, all NFS Ganesha containers will be selected.
weka nfs clients show [--interface-group interface-group]
[--container-id container-id]
[--fip fip]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--fsnames fsnames]...
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--no-header]
[--verbose]
--interface-group
interface-group-name
--container-id
container-id
--fip
floating-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
-f, --format
Specify in what format to output the result (format: 'view', 'csv', 'markdown', 'json' or 'oldview')
--fsnames...
A comma-separated list of filesystems. If no options are given, all NFS exported filesystems will be selected. (may be repeated or comma-separated)
-o, --output...
Specify which columns to output. May include any of the following: hostid,fsname,client_ip,idle_time,num_v3_ops,num_v4_ops,num_v4_open_ops,num_v4_close_ops (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 nfs debug-level
Manage debug level for nfs servers.
weka nfs debug-level [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka nfs debug-level set
Set debug level for nfs servers. Return to default (EVENT) when finish debugging.
weka nfs debug-level set <level>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--nfs-hosts nfs-hosts]...
[--help]
level*
The debug level, can be one of this options: EVENT, INFO, DEBUG, MID_DEBUG, FULL_DEBUG
--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
--nfs-hosts...
Hosts to set debug level (pass weka's host id as a number). All hosts as default (may be repeated or comma-separated)
-h, --help
Show help message
weka nfs debug-level show
Get debug level for nfs servers.
weka nfs debug-level show [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--nfs-hosts nfs-hosts]...
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--no-header]
[--verbose]
--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')
--nfs-hosts...
Only return these host IDs (pass weka's host id as a number). All hosts as default (may be repeated or comma-separated)
-o, --output...
Specify which columns to output. May include any of the following: host,debugLevel,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
--no-header
Don't show column headers when printing the output
-v, --verbose
Show all columns in output
weka nfs global-config
NFS Global Configuration
weka nfs global-config [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka nfs global-config set
Set NFS global configuration options
weka nfs global-config set [--mountd-port mountd-port]
[--config-fs config-fs]
[--lockmgr-port lockmgr-port]
[--statmon-port statmon-port]
[--notify-port notify-port]
[--acl acl]
[--default-acl-type default-acl-type]
[--extended-stats extended-stats]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--default-supported-versions default-supported-versions]...
[--enable-auth-types enable-auth-types]...
[--no-restart]
[--help]
[--force]
--mountd-port
Configure the port number of the mountd service
--config-fs
config filesystem name, use "" to invalidate
--lockmgr-port
The alternate port for the nfs lock manager (default: 0 means any available port)
--statmon-port
The alternate port for the nfs status monitor (default: 0 means any available port)
--notify-port
The alternate port for notification used in NFSv3 (default: 0 means any available port)
--acl
Enables or disables NFSv4 ACL support (default: On) (format: 'on' or 'off')
--default-acl-type
Specifies the default ACL type. Options are none, posix, nfsv4, or hybrid (default: posix) (format: 'none', 'posix', 'nfsv4' or 'hybrid')
--extended-stats
enable or disable NFS stats collection for each client and permission (default: On) (format: 'on' or 'off')
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-H, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T, --TIMEOUT
Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--profile
Name of the connection and authentication profile to use
--default-supported-versions...
A comma-separated list of the default supported NFS versions for new permissions (format: 'v3' or 'v4', may be repeated or comma-separated)
--enable-auth-types...
A comma-separated list of NFS authentication types -- none, sys, krb5, krb5i, krb5p for permissions (format: 'none', 'sys', 'krb5', 'krb5i' or 'krb5p', may be repeated or comma-separated)
--no-restart
Prevents the restart of NFS-W containers when applying changes (default: false)
-h, --help
Show help message
-f, --force
Force this action without further confirmation. This may cause a temporary disruption in the NFS service.
weka nfs global-config show
Show the NFS global configuration
weka nfs global-config show [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
--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 nfs interface-group
List interface groups
weka nfs interface-group [--name name]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--no-header]
[--verbose]
--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 nfs interface-group add
Create an interface group
weka nfs interface-group add <name>
<type>
[--subnet subnet]
[--gateway gateway]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--no-header]
[--verbose]
name*
Interface group name
type*
Group type. cli subnet type can be NFS
--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
-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 nfs 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
weka nfs interface-group assignment [--name name]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--no-header]
[--verbose]
--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 nfs interface-group remove
Delete an interface group
weka nfs interface-group remove <name>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--force]
[--help]
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 NFS clients and can be undone by re-creating the interface group.
-h, --help
Show help message
weka nfs interface-group ip-range
Commands that manage nfs interface-groups' ip-ranges
weka nfs interface-group ip-range [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka nfs interface-group ip-range add
Add an ip range to an interface group
weka nfs interface-group ip-range add <name>
<ips>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
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 nfs interface-group ip-range remove
Delete an ip range from an interface group
weka nfs interface-group ip-range remove <name>
<ips>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--force]
[--help]
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 NFS clients and can be undone by re-creating the IP range.
-h, --help
Show help message
weka nfs interface-group port
Commands that manage nfs interface-groups' ports
weka nfs interface-group port [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka nfs interface-group port add
Add a server port to an interface group
weka nfs interface-group port add <name>
<server-id>
<port>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
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 nfs interface-group port remove
Delete a server port from an interface group
weka nfs interface-group port remove <name>
<server-id>
<port>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--force]
[--help]
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 NFS clients and can be undone by re-adding the port.
-h, --help
Show help message
weka nfs interface-group update
Update an interface group
weka nfs interface-group update <name>
[--subnet subnet]
[--gateway gateway]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
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 nfs kerberos
NFS Kerberos Commands
weka nfs kerberos [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka nfs kerberos registration
NFS Kerberos service registration
weka nfs kerberos registration [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka nfs kerberos registration setup-ad
Register NFS Kerberos service with Microsoft Active Directory. Running this command with the restart option can
disrupt IO service for connected NFS clients.
weka nfs kerberos registration setup-ad <nfs-service-name>
<realm-admin-name>
[realm-admin-passwd]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--force]
[--restart]
[--help]
nfs-service-name*
NFS FQDN Service Name (Maximum 20 characters for hostname in FQDN
realm-admin-name*
KDC Realm Admin Name
realm-admin-passwd
KDC Realm Admin password
--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 this action when the service is already registered (default: false)
--restart
Don't restart the NFS-W containers to apply changes (default: false)
-h, --help
Show help message
weka nfs kerberos registration setup-mit
Register NFS Kerberos service with MIT KDC. Running this command with the restart option can disrupt IO service
for connected NFS clients.
weka nfs kerberos registration setup-mit <nfs-service-name>
<keytab-file>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--force]
[--restart]
[--help]
nfs-service-name*
NFS FQDN Service Name
keytab-file*
Path to keytab file
--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 this action when the service is already registered (default: false)
--restart
Don't restart the NFS-W containers to apply changes (default: false)
-h, --help
Show help message
weka nfs kerberos registration show
Show NFS Kerberos service registration information
weka nfs kerberos registration show [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--no-header]
[--verbose]
--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: nfs_service_name,kdc_type,generation_id,registration_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)
-h, --help
Show help message
--no-header
Don't show column headers when printing the output
-v, --verbose
Show all columns in output
weka nfs kerberos reset
Wipe out NFS Kerberos Service configuration information. Running this command without the no-restart option can
disrupt IO service for connected NFS clients.
weka nfs kerberos reset [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--force]
[--no-restart]
[--help]
--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 this action without further confirmation (default: false)
--no-restart
Don't restart the NFS-W containers to apply changes (default: false)
-h, --help
Show help message
weka nfs kerberos service
NFS Kerberos service
weka nfs kerberos service [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka nfs kerberos service setup
Setup the NFS Kerberos Service information. Running this command with the restart option can disrupt IO service
for connected NFS clients.
weka nfs kerberos service setup <kdc-realm-name>
<kdc-primary-server>
<kdc-admin-server>
[--kdc-secondary-server kdc-secondary-server]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--force]
[--restart]
[--help]
kdc-realm-name*
KDC Realm Name
kdc-primary-server*
KDC Primary Server
kdc-admin-server*
KDC Admin Server
--kdc-secondary-server
KDC Secondary Server
--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 this action when the service is already configured (default: false)
--restart
Restart the NFS-W containers to apply changes (default: false)
-h, --help
Show help message
weka nfs kerberos service show
Show NFS Kerberos service setup information
weka nfs kerberos service show [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--no-header]
[--verbose]
--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: realm_name,primary_server,secondary_server,admin_server,generation_id,service_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)
-h, --help
Show help message
--no-header
Don't show column headers when printing the output
-v, --verbose
Show all columns in output
weka nfs ldap
NFS LDAP Commands
weka nfs ldap [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka nfs ldap export-openldap
Export in use configuration information for NFS to use OpenLDAP.
weka nfs ldap export-openldap <server-name>
<ldap-domain>
<sssd-conf-file>
<idmapd-conf-file>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
server-name*
OpenLDAP Server Name
ldap-domain*
OpenLDAP Domain
sssd-conf-file*
Path to sssd configuration file
idmapd-conf-file*
Path to idmapd configuration file
--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 nfs ldap import-openldap
Import configuration information for NFS to use OpenLDAP. Running this command without the no-restart option can
disrupt IO service for connected NFS clients.
weka nfs ldap import-openldap <server-name>
<ldap-domain>
<sssd-conf-file>
<idmapd-conf-file>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--verify]
[--force]
[--no-restart]
[--help]
server-name*
OpenLDAP Server Name
ldap-domain*
OpenLDAP Domain
sssd-conf-file*
Path to sssd configuration file
idmapd-conf-file*
Path to idmapd configuration file
--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
--verify
verify connectivity with the OpenLDAP server (default: false)
--force
Force this action when OpenLDAP client is already setup (default: false)
--no-restart
Don't restart NFS-W containers to apply changes (default: false)
-h, --help
Show help message
weka nfs ldap reset
Wipe out NFS LDAP configuration information, This action may disrupt IO service for connected NFS clients if used without no-restart option
weka nfs ldap reset [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--force]
[--no-restart]
[--help]
--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 this action without further confirmation (default: false)
--no-restart
Don't restart the NFS-W containers to apply changes (default: false)
-h, --help
Show help message
weka nfs ldap setup-ad
Setup configuration information for NFS to use Active Directory LDAP. Running this command without the no-restart
option can disrupt IO service for connected NFS clients.
weka nfs ldap setup-ad [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--force]
[--no-restart]
[--help]
--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 this action when Active Directory LDAP client is already setup (default: false)
--no-restart
Don't restart the NFS-W containers to apply changes (default: false)
-h, --help
Show help message
weka nfs ldap setup-ad-nokrb
Setup configuration information for NFS to use Active Directory LDAP for ACL only when kerberos is not used.
Running this command without the no-restart option can disrupt IO service for connected NFS clients.
weka nfs ldap setup-ad-nokrb <server-name>
<ldap-domain>
<nfs-service-name>
<admin-user-name>
[admin-user-password]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--force]
[--no-restart]
[--help]
server-name*
AD Server Name
ldap-domain*
AD Domain
nfs-service-name*
NFS FQDN Service Name (Maximum 20 characters for hostname in FQDN
admin-user-name*
AD Admin Name
admin-user-password
AD Admin password
--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 this action when Active Directory LDAP client is already setup (default: false)
--no-restart
Don't restart the NFS-W containers to apply changes (default: false)
-h, --help
Show help message
weka nfs ldap setup-openldap
Setup configuration information for NFS to use OpenLDAP. Running this command without the no-restart option can
disrupt IO service for connected NFS clients.
weka nfs ldap setup-openldap <server-name>
<ldap-domain>
<reader-user-name>
[reader-user-password]
[--base-dn base-dn]
[--ldap-port-number ldap-port-number]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--force]
[--no-restart]
[--help]
server-name*
OpenLDAP Server Name
ldap-domain*
OpenLDAP Domain
reader-user-name*
OpenLDAP Reader User Name (DN based name e.g. cn=readonly-user,dc=test,dc=example,dc=com)
reader-user-password
OpenLDAP Reader User password
--base-dn
OpenLDAP Base DN (e.g. dc=myldapdomain,dc=example,dc=com)
--ldap-port-number O
penLDAP Port Number (default: 389)
--color S
pecify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-H, --HOST S
pecify the host. Alternatively, use the WEKA_HOST env variable
-P, --PORT S
pecify the port. Alternatively, use the WEKA_PORT env variable
-C, --CONNECT-TIMEOUT T
imeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w,
i
nfinite/unlimited)
-T, --TIMEOUT T
imeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w,
--profile N
ame of the connection and authentication profile to use
--force F
orce this action when OpenLDAP client is already setup (default: false)
--no-restart D
on't restart NFS-W containers to apply changes (default: false)
-h, --help S
how help message
weka nfs ldap show
Show NFS LDAP setup information
weka nfs ldap show [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--no-header]
[--verbose]
--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: server_type,domain,server_name,server_port,base_dn,reader_name,reader_password,generation_id,setup_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)
-h, --help
Show help message
--no-header
Don't show column headers when printing the output
-v, --verbose
Show all columns in output
weka nfs permission
List NFS permissions for a filesystem
weka nfs permission [--filesystem filesystem]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--no-header]
[--verbose]
--filesystem
File system 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,filesystem,group,path,type,squash,auid,agid,obsdirect,manageGids,options,customOptions,privilegedPort,priority,supportedVersions,enabledAuthTypes,aclType (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 nfs permission add
Allow a client group to access a file system
weka nfs permission add <filesystem>
<group>
[--path path]
[--permission-type permission-type]
[--root-squashing root-squashing]
[--squash squash]
[--anon-uid anon-uid]
[--anon-gid anon-gid]
[--obs-direct obs-direct]
[--manage-gids manage-gids]
[--privileged-port privileged-port]
[--acl-type acl-type]
[--force-acl-type force-acl-type]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--supported-versions supported-versions]...
[--enable-auth-types enable-auth-types]...
[--no-restart]
[--force]
[--help]
filesystem*
File system name
group*
Client group name
--path
path [default: /]
--permission-type
Permission type (format: 'ro' or 'rw')
--root-squashing
Root squashing (format: 'on' or 'off')
--squash
Permission squashing. NOTE - The option 'all' can be used only on interface groups with --allow-manage-gids=on (format: 'none', 'root' or 'all')
--anon-uid
Anonymous UID to be used instead of root when root squashing is enabled
--anon-gid
Anonymous GID to be used instead of root when root squashing is enabled
--obs-direct
Obs direct (format: 'on' or 'off')
--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. NOTE - this only works with a interface group which allows manage-gids (format: 'on' or 'off')
--privileged-port
Privileged port (format: 'on' or 'off')
--acl-type
Specifies the ACL type. Options include none, posix, nfsv4, and hybrid. Default is determined by the NFS global configuration (format: 'none', 'posix', 'nfsv4' or 'hybrid')
--force-acl-type
Forces a change to the ACL type for existing permissions on the same filesystem (format: 'on' or 'off')
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-H, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T, --TIMEOUT
Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--profile
Name of the connection and authentication profile to use
--supported-versions...
A comma-separated list of supported NFS versions (format: 'v3' or 'v4', may be repeated or comma-separated)
--enable-auth-types...
A comma-separated list of NFS authentication types -- none, sys, krb5, krb5i, krb5p (format: 'none', 'sys', 'krb5', 'krb5i' or 'krb5p', may be repeated or comma-separated)
--no-restart
Prevents the restart of NFS-W containers when applying changes (default: false), null, No.HideFromUsage
-f, --force
Force this action without further confirmation. This action will affect all NFS users of this permission/export, Use it with caution and consult the Weka Customer Success team at need.
-h, --help
Show help message
weka nfs permission remove
Delete a file system permission
weka nfs permission remove <filesystem>
<group>
[--path path]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--force]
[--help]
filesystem*
File system name
group*
Client group name
--path
path [default: /]
--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 NFS clients and can be undone by re-creating the filesystem permission.
-h, --help
Show help message
weka nfs permission update
Edit a file system permission
weka nfs permission update <filesystem>
<group>
[--path path]
[--permission-type permission-type]
[--root-squashing root-squashing]
[--squash squash]
[--anon-uid anon-uid]
[--anon-gid anon-gid]
[--obs-direct obs-direct]
[--manage-gids manage-gids]
[--custom-options custom-options]
[--privileged-port privileged-port]
[--acl-type acl-type]
[--force-acl-type force-acl-type]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--supported-versions supported-versions]...
[--enable-auth-types enable-auth-types]...
[--force]
[--no-restart]
[--help]
filesystem*
File system name
group*
Client group name
--path
path [default: /]
--permission-type
Permission type (format: 'ro' or 'rw')
--root-squashing
Root squashing (format: 'on' or 'off')
--squash
Permission squashing. NOTE - The option 'all' can be used only on interface groups with --allow-manage-gids=on (format: 'none', 'root' or 'all')
--anon-uid
Anonymous UID to be used instead of root when root squashing is enabled
--anon-gid
Anonymous GID to be used instead of root when root squashing is enabled
--obs-direct
Obs direct (format: 'on' or 'off')
--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. NOTE - this only works with a interface group which allows manage-gids (format: 'on' or 'off')
--custom-options
Custom export options
--privileged-port
Privileged port (format: 'on' or 'off')
--acl-type
Specifies the ACL type. Options include none, posix, nfsv4, and hybrid. Default is determined by the NFS global configuration (format: 'none', 'posix', 'nfsv4' or 'hybrid')
--force-acl-type
Forces a change to the ACL type for existing permissions on the same filesystem (format: 'on' or 'off')
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-H, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T, --TIMEOUT
Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--profile
Name of the connection and authentication profile to use
--supported-versions...
A comma-separated list of supported NFS versions (format: 'v3' or 'v4', may be repeated or comma-separated)
--enable-auth-types...
A comma-separated list of NFS authentication types -- none, sys, krb5, krb5i, krb5p (format: 'none', 'sys', 'krb5', 'krb5i' or 'krb5p', may be repeated or comma-separated)
--force
Force this action without further confirmation
--no-restart
Prevents the restart of NFS-W containers when applying changes (default: false), null, No.HideFromUsage
-h, --help
Show help message
weka nfs rules
Commands that manage NFS-rules
weka nfs rules [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka nfs rules add
Commands that add NFS-rules
weka nfs rules add [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka nfs rules add dns
Add a DNS rule to an NFS client group
weka nfs rules add dns <name>
<dns>
[--ip ip]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
name*
Group name
dns*
DNS rule with *?[] wildcards rule
--ip
IP with netmask or CIDR rule, in the 1.1.1.1/255.255.0.0 or 1.1.1.1/16 format
--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 nfs rules add ip
Add an IP rule to an NFS client group
weka nfs rules add ip <name>
<ip>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
name*
Group name
ip*
IP with netmask or CIDR rule, in the 1.1.1.1/255.255.0.0 or 1.1.1.1/16 format
--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 nfs rules remove
Commands for deleting NFS-rules
weka nfs rules remove [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka nfs rules remove dns
Delete a DNS rule from an NFS client group
weka nfs rules remove dns <name>
<dns>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
name*
Group name
dns*
DNS rule with *?[] wildcards rule
--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 nfs rules remove ip
Delete an IP rule from an NFS client group
weka nfs rules remove ip <name>
<ip>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
name*
Group name
ip*
IP with netmask or CIDR rule, in the 1.1.1.1/255.255.0.0 or 1.1.1.1/16 format
--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 org
List organizations defined in the Weka cluster
weka org [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--raw-units]
[--UTC]
[--no-header]
[--verbose]
--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,allocSSD,quotaSSD,allocTotal,quotaTotal,policyNames,policyIds (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 org add
Create a new organization in the Weka cluster
weka org add <name>
<username>
[--ssd-quota ssd-quota]
[--total-quota total-quota]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
name*
Organization name
username*
Username of organization admin
password*
Password of organization admin
--ssd-quota
SSD quota (format: capacity in decimal or binary units: 1B, 1KB, 1MB, 1GB, 1TB, 1PB, 1EB, 1KiB, 1MiB, 1GiB, 1TiB, 1PiB, 1EiB)
--total-quota
Total quota (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
-J, --json
Format output as JSON
weka org remove
Delete an organization
weka org remove <org>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--force]
[--help]
[--json]
org*
Organization 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, --force
Force this action without further confirmation. This action will DELETE ALL DATA stored in this organization's filesystems and cannot be undone.
-h, --help
Show help message
-J, --json
Format output as JSON
weka org rename
Change an organization name
weka org rename <org>
<new-name>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
org*
Current organization name or ID
new-name*
New organization 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 org security
Manages organization security
weka org security [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka org security policy
Manages organization security policies.
weka org security policy [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka org security policy attach
Attaches new security policies to an organization, adding them to the existing policies.
weka org security policy attach <org>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
[<policies>]...
org*
Organization name or ID.
policies...
Security policy names or IDs to attach to the organization.
--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 org security policy detach
Removes security policies from an organization.
weka org security policy detach <org>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
[<policies>]...
org*
Organization name or ID.
policies...
Security policy names or IDs to remove from the organization.
--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 org security policy list
List organization security policies.
weka org security policy list <org>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--raw-units]
[--UTC]
[--no-header]
[--verbose]
org*
Organization 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: 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 org security policy reset
Removes all security policies from an organization.
weka org security policy reset <org>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
org*
Organization 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
weka org security policy set
Sets security policies for an organization, replacing the existing list of policies.
weka org security policy set <org>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
[<policies>]...
org*
Organization name or ID.
policies...
Security policy names or IDs to assign to the organization.
--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 org security revoke-tokens
Revokes all API tokens issued for this organization.
weka org security revoke-tokens <org>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--force]
org*
Organization 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
-f, --force
Force this action without further confirmation. This action will log all users out of the organization.
weka org set-quota
Set an organization's SSD and/or total quotas
weka org set-quota <org>
[--ssd-quota ssd-quota]
[--total-quota total-quota]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
org*
Organization name or ID
--ssd-quota
SSD quota (format: capacity in decimal or binary units: 1B, 1KB, 1MB, 1GB, 1TB, 1PB, 1EB, 1KiB, 1MiB, 1GiB, 1TiB, 1PiB, 1EiB)
--total-quota
Total quota (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
-J, --json
Format output as JSON
weka s3
Commands that manage Weka's S3 container
weka s3 [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka s3 bucket
S3 Cluster Bucket Commands
weka s3 bucket [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka s3 bucket add
Create an S3 bucket
weka s3 bucket add <name>
[--policy policy]
[--policy-json policy-json]
[--hard-quota hard-quota]
[--existing-path existing-path]
[--fs-name fs-name]
[--fs-id fs-id]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--force]
[--help]
[--json]
name*
bucket name to create
--policy
Set an existing S3 policy for a bucket
--policy-json
Get S3 policy for bucket in JSON format
--hard-quota
Hard limit for the directory (format: capacity in decimal or binary units: 1B, 1KB, 1MB, 1GB, 1TB, 1PB, 1EB, 1KiB, 1MiB, 1GiB, 1TiB, 1PiB, 1EiB)
--existing-path
existing path
--fs-name
file system name
--fs-id
file system 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, --force
Force when existing-path has quota
-h, --help
Show help message
-J, --json
Format output as JSON
weka s3 bucket remove
Destroy an S3 bucket
weka s3 bucket remove <name>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--unlink]
[--help]
[--json]
[--force]
name*
bucket name to destroy
--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
--unlink
unlinks the bucket, but leave the data directory in place
-h, --help
Show help message
-J, --json
Format output as JSON
-f, --force
Force this action without further confirmation. This action may disrupt IO service for connected S3 clients..
weka s3 bucket lifecycle-rule
S3 Bucket Lifecycle
weka s3 bucket lifecycle-rule [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka s3 bucket lifecycle-rule add
Add a lifecycle rule to an S3 Bucket
weka s3 bucket lifecycle-rule add <bucket>
<expiry-days>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--prefix prefix]
[--tags tags]
[--help]
[--json]
bucket*
S3 Bucket Name
expiry-days*
expiry days
--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
--prefix
prefix
--tags
object tags
-h, --help
Show help message
-J, --json
Format output as JSON
weka s3 bucket lifecycle-rule list
List all lifecycle rules of an S3 bucket
weka s3 bucket lifecycle-rule list <bucket>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--no-header]
[--verbose]
bucket*
S3 Bucket 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,expiry_days,prefix,tags (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 s3 bucket lifecycle-rule remove
Remove a lifecycle rule from an S3 bucket
weka s3 bucket lifecycle-rule remove <bucket>
<name>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
bucket*
S3 Bucket Name
name*
rule 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 s3 bucket lifecycle-rule reset
Reset all lifecycle rules of an S3 bucket
weka s3 bucket lifecycle-rule reset <bucket>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
[--force]
bucket*
S3 Bucket 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 will delete the existing S3 bucket rules.
weka s3 bucket list
Show all the buckets on the S3 cluster
weka s3 bucket list [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--raw-units]
[--UTC]
[--no-header]
[--verbose]
--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,hard,used,path,fs (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 s3 bucket policy
S3 bucket policy commands
weka s3 bucket policy [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka s3 bucket policy get
Get S3 policy for bucket
weka s3 bucket policy get <bucket-name>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
bucket-name*
full path to bucket to get policy for
--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 s3 bucket policy get-json
Get S3 policy for bucket in JSON format
weka s3 bucket policy get-json <bucket-name>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
bucket-name*
full path to bucket to get policy for
--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 s3 bucket policy set
Set an existing S3 policy for a bucket, Available predefined options are : none|download|upload|public
weka s3 bucket policy set <bucket-name>
<bucket-policy>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
bucket-name*
full path to bucket to set policy for
bucket-policy*
Set an existing S3 policy. Available predefined options are: none
--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 s3 bucket policy set-custom
Set a custom S3 policy for bucket
weka s3 bucket policy set-custom <bucket-name>
<policy-file>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
bucket-name*
Full path to bucket to set policy for
policy-file*
Path of the file containing the policy rules
--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 s3 bucket policy reset
Unset the configured S3 policy for bucket
weka s3 bucket policy reset <bucket-name>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
bucket-name*
full path to bucket to unset the policy for
--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 s3 bucket quota
S3 Bucket Quota, configure the hard limit of bucket disk usage
weka s3 bucket quota [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka s3 bucket quota set
Set the hard limit of bucket's disk usage
weka s3 bucket quota set <name>
<hard-quota>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
name*
bucket name
hard-quota*
Hard limit for the directory (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 s3 bucket quota reset
Remove the hard limit on bucket's disk usage
weka s3 bucket quota reset <name>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
name*
bucket 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 s3 cluster
View info about the S3 cluster managed by weka
weka s3 cluster [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--verbose]
[--help]
[--json]
--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 mode
-h, --help
Show help message
-J, --json
Format output as JSON
weka s3 cluster audit-webhook
S3 Cluster Audit Webhook Commands
weka s3 cluster audit-webhook [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka s3 cluster audit-webhook disable
Disable the Audit Webhook
weka s3 cluster audit-webhook disable [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
--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 s3 cluster audit-webhook enable
Enable/Disable the S3 audit webhook on the S3 Cluster
weka s3 cluster audit-webhook enable [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--endpoint endpoint]
[--auth-token auth-token]
[--help]
[--verify]
--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
--endpoint
The webhook endpoint
--auth-token
The webhook authentication token
-h, --help
Show help message
--verify
verification to apply configuration
weka s3 cluster audit-webhook show
Show the S3 Audit Webhook configuration
weka s3 cluster audit-webhook show [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
--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 s3 cluster container
Commands that manage Weka's S3 cluster's containers
weka s3 cluster container [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka s3 cluster container add
Add S3 containers to S3 cluster
weka s3 cluster container add [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[<container-ids>]...
container-ids...
The containers to add to the S3 cluster
--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 s3 cluster container list
Lists containers in S3 cluster
weka s3 cluster container list [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
--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 s3 cluster container remove
Remove S3 containers from S3 cluster
weka s3 cluster container remove [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[<container-ids>]...
container-ids...
The containers to remove from the S3 cluster
--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 s3 cluster add
Create an S3 cluster managed by weka
weka s3 cluster add <default-fs-name>
<config-fs-name>
[--port port]
[--key key]
[--secret secret]
[--max-buckets-limit max-buckets-limit]
[--anonymous-posix-uid anonymous-posix-uid]
[--anonymous-posix-gid anonymous-posix-gid]
[--domain domain]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--container container]...
[--all-servers]
[--force]
[--help]
default-fs-name*
S3 default filesystem name
config-fs-name*
S3 config filesystem name
--port
S3 service port
--key
S3 service key
--secret
S3 service secret
--max-buckets-limit
Limit the number of buckets that can be created
--anonymous-posix-uid
POSIX UID for anonymous users
--anonymous-posix-gid
POSIX GID for anonymous users
--domain
Virtual host-style comma seperated 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
--container...
The containers that will serve via the S3 protocol (pass weka's container ID as a number) (may be repeated or comma-separated)
--all-servers
Install S3 on all servers
-f, --force
Force this action without further confirmation. Be aware that this will impact all S3 buckets within the S3 service. Exercise caution and consult the WEKA Customer Success team if assistance is required.
-h, --help
Show help message
weka s3 cluster remove
Destroy the S3 cluster managed by weka. This will not delete the data, just stop exposing it via S3
weka s3 cluster remove [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--force]
[--help]
--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.
troying the S3 cluster r
emoves the S3 service and its associated configuration, including IAM policies, buckets, and ILM rules. access will no longer be available for clients.
s operation does not aut
omatically delete the data stored within the buckets.
ever, internal users wit
h S3 roles will be permanently removed from the system..
-h, --help
Show help message
weka s3 cluster status
Show which of the containers are ready.
weka s3 cluster status [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--no-header]
[--verbose]
--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,hostname,statusTitle,ip,port,versions,uptime,requests,lastError,failureTime (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 s3 cluster update
Update an S3 cluster
weka s3 cluster update [--key key]
[--secret secret]
[--port port]
[--anonymous-posix-uid anonymous-posix-uid]
[--anonymous-posix-gid anonymous-posix-gid]
[--domain domain]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--container container]...
[--all-servers]
[--force]
[--help]
--key
S3 service key
--secret
S3 service secret
--port
S3 service port
--anonymous-posix-uid
POSIX UID for anonymous users
--anonymous-posix-gid
POSIX GID for anonymous users
--domain
Virtual host-style comma seperated domains. Empty to disable
--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
--container...
The containers that will serve via the S3 protocol (may be repeated or comma-separated)
--all-servers
Install S3 on all servers
-f, --force
Force this action without further confirmation. Be aware that this will impact all S3 buckets within the S3 service. Exercise caution and consult the WEKA Customer Success team if assistance is required.
-h, --help
Show help message
weka s3 log-level
S3 log-level Commands
weka s3 log-level [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka s3 log-level get
Show current S3 log level on container
weka s3 log-level get [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--container container]...
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--no-header]
[--verbose]
--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...
The containers that will change their log level severity (may be repeated or comma-separated)
-o, --output...
Specify which columns to output. May include any of the following: host,stdout (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 s3 policy
S3 policy commands
weka s3 policy [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka s3 policy add
Add an S3 IAM policy
weka s3 policy add <policy-name>
<policy-file>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
policy-name*
The policy name
policy-file*
Path of the file containing the policy rules
--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 s3 policy attach
Attach an S3 policy to a user
weka s3 policy attach <policy>
<user>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
policy*
Policy name to attach
user*
User 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 s3 policy detach
Detach an S3 policy from a user
weka s3 policy detach <user>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
user*
User 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 s3 policy list
Print a list of the existing S3 IAM policies
weka s3 policy list [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--no-header]
[--verbose]
--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 (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 s3 policy remove
Remove an S3 IAM policy
weka s3 policy remove <policy>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
policy*
Policy name to remove
--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 s3 policy show
Show the details of an S3 IAM policy
weka s3 policy show <policy-name>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
policy-name*
Policy name to show
--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 s3 service-account
S3 service account commands. Should be run only with an S3 user role
weka s3 service-account [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka s3 service-account add
Add an S3 service account
weka s3 service-account add [--policy-file policy-file]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
--policy-file
Policy file path
--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 s3 service-account list
Print a list of the user's S3 service accounts
weka s3 service-account list [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--no-header]
[--verbose]
--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: accessKey (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 s3 service-account remove
Remove an S3 service account
weka s3 service-account remove <access_key>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
access_key*
Access key of the service account to remove
--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 s3 service-account show
Show the details of an S3 service account
weka s3 service-account show <access_key>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
access_key*
Access key of the service account to show
--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 s3 sts
S3 security token commands
weka s3 sts [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka s3 sts assume-role
Generate a temporary security token with an assumed role using existing user credentials
weka s3 sts assume-role [--access-key access-key]
[--secret-key secret-key]
[--policy-file policy-file]
[--duration duration]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
--access-key
Access key
--secret-key
Secret key
--policy-file
Policy file path
--duration
Duration, valid values: 15 minutes to 52 weeks and 1 day (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
weka security
Security commands.
weka security [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka security ca-cert
Commands handling custom CA signed certificate
weka security ca-cert [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka security ca-cert download
Download the Weka cluster custom certificate, if such certificate was set
weka security ca-cert download <path>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
path*
Path to output file
--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 security ca-cert set
Add a custom certificate to the certificates list. If a custom certificate is already set, this command updates it.
weka security ca-cert set [--cert-file cert-file]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
--cert-file
Path to certificate file
--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 security ca-cert status
Show the Weka cluster CA-cert status and certificate
weka security ca-cert status [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
--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 security ca-cert reset
Unsets custom CA signed certificate from cluster
weka security ca-cert reset [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
--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 security cors-trusted-sites
Commands for handling Cross Origin Resource Sharing weka apis
weka security cors-trusted-sites [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka security cors-trusted-sites add
Add a trusted site to list, provide url with http or https prefix and port number if not a standard port.
weka security cors-trusted-sites add <site>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
site*
Trusted site
--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 security cors-trusted-sites list
Lists the set of trusted sites where CORS in configured
weka security cors-trusted-sites list [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
--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 security cors-trusted-sites remove
Remove the specified site from the trusted list.
weka security cors-trusted-sites remove <site>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
site*
Site to remove from the trusted list
--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 security cors-trusted-sites remove-all
Removes all trusted sites for Cross Origin Resource Sharing
weka security cors-trusted-sites remove-all [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
--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 security kms
List the currently configured key management service settings
weka security kms [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
--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 security kms rewrap
Rewraps all the master filesystem keys using the configured KMS. This can be used to rewrap with a rotated KMS key, or to change wrapping to the newly-configured KMS.
weka security kms rewrap [--new-key-uid new-key-uid]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--all]
[--convert-to-cluster-key-on-fs]
[--help]
[--json]
--new-key-uid
(KMIP-only) Unique identifier for the new key to be used to wrap filesystem keys
--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
rewrap all the filesystem keys
--convert-to-cluster-key-on-fs
Convert all encrypted filesystems to use cluster key
-h, --help
Show help message
-J, --json
Format output as JSON
weka security kms set
Configure the active KMS
weka security kms set <type>
<address>
<key-identifier>
[--token token]
[--namespace namespace]
[--client-cert client-cert]
[--client-key client-key]
[--ca-cert ca-cert]
[--role-id role-id]
[--secret-id secret-id]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--convert-to-cluster-key-on-fs]
[--help]
type*
KMS type, one of ["vault", "kmip"]
address*
Server address, usually a hostname:port or a URL
key-identifier*
Key to secure the filesystem keys with, e.g a key name (for Vault) or a key uid (for KMIP)
--token
API token to access the KMS
--namespace
Namespace (Vault, optional)
--client-cert
Path to the client certificate PEM file
--client-key
Path to the client key PEM file
--ca-cert
Path to the CA certificate PEM file
--role-id
Role Id to access the KMS
--secret-id
Secret Id to access the KMS
--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
--convert-to-cluster-key-on-fs
Convert all encrypted filesystems to use cluster key
-h, --help
Show help message
weka security kms reset
Remove external KMS configurations. This will fail if there are any encrypted filesystems that rely on the KMS.
weka security kms reset [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--allow-downgrade]
[--help]
--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-downgrade
Allows downgrading existing encrypted filesystems to local encryption instead of a KMS
-h, --help
Show help message
weka security lockout-config
Commands used to interact with the account lockout config parameters
weka security lockout-config [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka security lockout-config reset
Reset the number of failed attempts before lockout and the duration of lock to their defaults
weka security lockout-config reset [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
--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 security lockout-config set
Configure the number of failed attempts before lockout and the duration of lock
weka security lockout-config set [--failed-attempts failed-attempts]
[--lockout-duration lockout-duration]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
--failed-attempts
Number of consecutive failed logins before user account locks out
--lockout-duration
How long the account should be locked out for after failed logins (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 security lockout-config show
Show the current number of attempts needed to lockout and how long the lockout is for
weka security lockout-config show [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
--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 security login-banner
Commands used to view and edit the login banner
weka security login-banner [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka security login-banner disable
Disable the login banner
weka security login-banner disable [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
--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 security login-banner enable
Enable the login banner
weka security login-banner enable [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
--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 security login-banner reset
Resets the login banner back to the default state (empty)
weka security login-banner reset [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
--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 security login-banner set
Set the login banner
weka security login-banner set <login-banner>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
login-banner*
Text banner to be displayed before the user logs into the web UI
--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 security login-banner show
Show the current login banner
weka security login-banner show [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
--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 security policy
Manages security policies.
weka security policy [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka security policy add
Creates a new security policy.
weka security policy add <name>
[--description description]
[--action action]
[--read-only read-only]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--ips ips]...
[--roles roles]...
[--help]
[--json]
name*
Name of the new security policy. (up to 64 alphanumeric characters, hyphens (-), underscores (_), and periods (.), starting with a letter)
--description
Description of the security policy. (up to 256 characters)
--action
Whether access is granted or denied when the security policy matches. (format: 'allow' or 'deny')
--read-only
The security policy allows read-only mounts only. (format: 'on' or 'off')
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-H, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T, --TIMEOUT
Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--profile
Name of the connection and authentication profile to use
--ips...
IP address ranges to which the security policy applies. (format: IP or IP/CIDR or IP1-IP2 or A.B.C.D-E, may be repeated or comma-separated)
--roles...
User roles to which the security policy applies. (format: 'clusteradmin', 'orgadmin', 'regular', 'readonly', 's3' or 'csi', may be repeated or comma-separated)
-h, --help
Show help message
-J, --json
Format output as JSON
weka security policy remove
Deletes a security policy.
weka security policy remove <policy>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--force]
policy*
Name or ID of security 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
-f, --force
Force this action without further confirmation. Security policy details will be lost with no chance for recovery.
weka security policy duplicate
Duplicates an existing security policy, creating a new one.
weka security policy duplicate <policy>
<name>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
policy*
Name or ID of the security policy to duplicate.
name*
Name of the new security policy. (up to 64 alphanumeric characters, hyphens (-), underscores (_), and periods (.), starting with a letter)
--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 security policy join
Manages security policies related to cluster joining.
weka security policy join [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka security policy join attach
Adds new security policies applied when joining cluster, adding them to the existing policies.
weka security policy join attach [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--client]
[--backend]
[--force]
[--help]
[--json]
[<policies>]...
policies...
Security policy names or IDs to attach to cluster join process.
--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
-c, --client
Apply policies to clients.
-b, --backend
Apply policies to backends.
-f, --force
Force update, bypassing safeguards (may disrupt cluster members!)
-h, --help
Show help message
-J, --json
Format output as JSON
weka security policy join detach
Removes security policies applied when joining cluster.
weka security policy join detach [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--client]
[--backend]
[--force]
[--help]
[--json]
[<policies>]...
policies...
Security policy names or IDs to remove from cluster join process.
--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
-c, --client
Apply policies to clients.
-b, --backend
Apply policies to backends.
-f, --force
Force update, bypassing safeguards (may disrupt cluster members!)
-h, --help
Show help message
-J, --json
Format output as JSON
weka security policy join list
Lists security policies applied when joining containers.
weka security policy join list [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--client]
[--backend]
[--help]
[--raw-units]
[--UTC]
[--no-header]
[--verbose]
--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: mode,policyNames,policyIds (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)
-c, --client
List policies for clients.
-b, --backend
List policies for backends.
-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 security policy join reset
Removes all security policies applied when joining cluster.
weka security policy join reset [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--client]
[--backend]
[--help]
[--json]
--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
-c, --client
Reset policies applied to clients.
-b, --backend
Reset policies applied to backends.
-h, --help
Show help message
-J, --json
Format output as JSON
weka security policy join set
Sets security policies for joining cluster, replacing the existing set of policies.
weka security policy join set [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--client]
[--backend]
[--force]
[--help]
[--json]
[<policies>]...
policies...
Security policy names or IDs applied to cluster join process.
--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
-c, --client
Apply policies to clients.
-b, --backend
Apply policies to backends.
-f, --force
Force update, bypassing safeguards (may disrupt cluster members!)
-h, --help
Show help message
-J, --json
Format output as JSON
weka security policy list
List security policies defined in the Weka cluster.
weka security policy list [--action action]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--roles roles]...
[--ips ips]...
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--raw-units]
[--UTC]
[--no-header]
[--verbose]
--action
Lists security policies that match a specific action. (format: 'allow' or 'deny')
--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')
--roles...
Lists security policies that include specific roles. (format: 'clusteradmin', 'orgadmin', 'regular', 'readonly', 's3' or 'csi', may be repeated or comma-separated)
--ips...
Lists security policies that include specific IP address ranges. (format: IP or IP/CIDR or IP1-IP2 or A.B.C.D-E, may be repeated or comma-separated)
-o, --output...
Specify which columns to output. May include any of the following: uid,id,name,refCount,description,action,roles,ips,readonly,createdBy,createdAt,modifiedBy,modifiedAt (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 security policy show
Displays information about a specific security policy.
weka security policy show <policy>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--json]
[--help]
policy*
Name or ID of security 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
-J, --json
Format output as JSON
-h, --help
Show help message
weka security policy test
Simulates the effect of one or more security policies.
weka security policy test [--role role]
[--ip ip]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--join]
[--help]
[--json]
[<policy>]...
policy...
Policies to evaluate, with access verified in the order listed.
--role
Simulate effect of policies on API access from the given user role. (format: 'clusteradmin', 'orgadmin', 'regular', 'readonly', 's3' or 'csi')
--ip
IP address to evaluate as the source address.
--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
--join
Simulate effect of policies when joining the cluster.
-h, --help
Show help message
-J, --json
Format output as JSON
weka security policy update
Updates the settings of an existing security policy.
weka security policy update <policy>
[--description description]
[--action action]
[--new-name new-name]
[--read-only read-only]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--roles roles]...
[--add-roles add-roles]...
[--remove-roles remove-roles]...
[--ips ips]...
[--add-ips add-ips]...
[--remove-ips remove-ips]...
[--force]
[--help]
[--json]
policy*
Name or ID of security policy.
--description
Updates the description of the security policy. (up to 256 characters)
--action
Changes whether access is granted when the security policy matches. (format: 'allow' or 'deny')
--new-name
New name of the security policy. (up to 64 alphanumeric characters, hyphens (-), underscores (_), and periods (.), starting with a letter)
--read-only
The security policy allows read-only mounts only. (format: 'on' or 'off')
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-H, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T, --TIMEOUT
Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--profile
Name of the connection and authentication profile to use
--roles...
User roles to which the security policy applies. (format: 'clusteradmin', 'orgadmin', 'regular', 'readonly', 's3' or 'csi', may be repeated or comma-separated)
--add-roles...
User roles to append to the security policy. (format: 'clusteradmin', 'orgadmin', 'regular', 'readonly', 's3' or 'csi', may be repeated or comma-separated)
--remove-roles...
User roles to remove from the security policy. (format: 'clusteradmin', 'orgadmin', 'regular', 'readonly', 's3' or 'csi', may be repeated or comma-separated)
--ips...
IP address ranges to which the security policy applies. (format: IP or IP/CIDR or IP1-IP2 or A.B.C.D-E, may be repeated or comma-separated)
--add-ips...
IP address ranges to append to the security policy. (format: IP or IP/CIDR or IP1-IP2 or A.B.C.D-E, may be repeated or comma-separated)
--remove-ips...
IP address ranges to remove from the security policy. (format: IP or IP/CIDR or IP1-IP2 or A.B.C.D-E, may be repeated or comma-separated)
-f, --force
Force update, bypassing safeguards (may disrupt cluster members!)
-h, --help
Show help message
-J, --json
Format output as JSON
weka security tls
TLS commands.
weka security tls [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka security tls download
Download the Weka cluster TLS certificate
weka security tls download <path>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
path*
Path to output file
--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 security tls local
TLS local configuration commands
weka security tls local [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka security tls local set
Make HTTP server use local TLS configuration. If local TLS already configured, updates the configuration.
weka security tls local set [--private-key private-key]
[--certificate certificate]
[--ca-cert ca-cert]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--all]
[--help]
[<container-ids>]...
container-ids...
A list of container ids to apply local TLS configuration
--private-key
Path to TLS private key pem file
--certificate
Path to TLS certificate pem file
--ca-cert
Path to TLS CA certificate pem file
--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 TLS configuration on all the backend containers in the cluster
-h, --help
Show help message
weka security tls local reset
Removes the local TLS configuration.
weka security tls local reset [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--private-key]
[--ca-cert]
[--all]
[--help]
[<container-ids>]...
container-ids...
A list of container ids to apply local TLS configuration
--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
--private-key
Remove local TLS private key and associated certificate
--ca-cert
Remove local TLS CA certificate
--all
Apply TLS configuration on all the backend containers in the cluster
-h, --help
Show help message
weka security tls set
Make Ngnix use TLS when accessing UI. If TLS already set this command updates the key and certificate.
weka security tls set [--private-key private-key]
[--certificate certificate]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
--private-key
Path to TLS private key pem file
--certificate
Path to TLS certificate pem file
--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 security tls status
Show the Weka cluster TLS status and certificate
weka security tls status [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
--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 security tls reset
Make Ngnix not use TLS when accessing UI
weka security tls reset [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
--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 security token-expiry
Commands used to interact with the auth token expiration parameters
weka security token-expiry [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka security token-expiry set
Configure the times for which auth tokens will be valid
weka security token-expiry set [--access-token access-token]
[--refresh-token refresh-token]
[--access-token-max access-token-max]
[--refresh-token-max refresh-token-max]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
--access-token
How long access tokens are valid by default (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--refresh-token
How long refresh tokens are valid by default (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--access-token-max
Maximum duration allowed for access tokens (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--refresh-token-max
Maximum duration allowed for refresh tokens (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 security token-expiry show
Show the current expiration limits for auth tokens
weka security token-expiry show [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
--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 smb
Commands that manage Weka's SMB container
weka smb [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka smb cluster
View info about the SMB cluster managed by weka
weka smb cluster [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
--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 smb cluster container
Update an SMB cluster containers
weka smb cluster container [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka smb cluster container add
Update an SMB cluster
weka smb cluster container add [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--container-ids container-ids]...
[--help]
[--force]
--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
--container-ids...
The SMB containers being added (pass weka's host id as a number) (may be repeated or comma-separated)
-h, --help
Show help message
-f, --force
Force this action without further confirmation. This action may disrupt IO service for connected SMB clients.
weka smb cluster container remove
Update an SMB cluster
weka smb cluster container remove [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--container-ids container-ids]...
[--help]
[--force]
--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
--container-ids...
The SMB containers being removed (pass weka's container id as a number) (may be repeated or comma-separated)
-h, --help
Show help message
-f, --force
Force this action without further confirmation. This action may disrupt IO service for connected SMB clients.
weka smb cluster add
Create a SMB cluster managed by weka
weka smb cluster add <netbios-name>
<domain>
<config-fs-name>
[--symlink symlink]
[--domain-netbios-name domain-netbios-name]
[--idmap-backend idmap-backend]
[--default-domain-mapping-from-id default-domain-mapping-from-id]
[--default-domain-mapping-to-id default-domain-mapping-to-id]
[--joined-domain-mapping-from-id joined-domain-mapping-from-id]
[--joined-domain-mapping-to-id joined-domain-mapping-to-id]
[--encryption encryption]
[--scale-out-mode scale-out-mode]
[--smb-conf-extra smb-conf-extra]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--container-ids container-ids]...
[--smb-ips-pool smb-ips-pool]...
[--smb-ips-range smb-ips-range]...
[--help]
netbios-name*
The netbios name to give to the SMB cluster
domain*
The domain to join the SMB cluster to
config-fs-name*
SMB config filesystem name
--symlink
Enable or disable symbolic link (symlink) support for the SMB-W cluster. (format: 'on' or 'off')
--domain-netbios-name
The domain netbios name; If not given, the default will be the first part of the given domain name
--idmap-backend
The SMB domain backend type (rid, rfc2307, etc.). Note that rfc2307 requires uid/gid configuration on the Active Directory and is persistent, while rid does not require any Active Directory configuration but in case of range changes uids/gids could break.
--default-domain-mapping-from-id
The SMB default domain first id
--default-domain-mapping-to-id
The SMB default domain last id
--joined-domain-mapping-from-id
The joined domain first id
--joined-domain-mapping-to-id
The joined domain last id
--encryption
Encryption (format: 'enabled', 'disabled', 'desired' or 'required')
--scale-out-mode
Controls the sync level between the SMB-W servers. Possible values: 'full' (Default), 'partial'. The default value is 'full,' but you can use 'partial' if shared access to files is unnecessary. Be cautious when deviating from the default setting; consult the documentation or Customer Success to avoid misuse. (format: 'none', 'full' or 'partial')
--smb-conf-extra
Extra smb configuration options
--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
--container-ids...
The containers that will serve via the SMB protocol (pass weka's container id as a number) (may be repeated or comma-separated)
--smb-ips-pool...
IPs used as floating IPs for samba to server SMB in a HA manner. Then should not be assigned to any container on the network (may be repeated or comma-separated)
--smb-ips-range...
IPs used as floating IPs for samba to server SMB in a HA manner. Then should not be assigned to any container on the network (may be repeated or comma-separated)
-h, --help
Show help message
weka smb cluster debug
Set debug level in an SMB container
weka smb cluster debug <level>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--container-ids container-ids]...
[--help]
[--json]
level*
The debug level
--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
--container-ids...
Hosts to set debug level (pass weka's host id as a number). All hosts as default (may be repeated or comma-separated)
-h, --help
Show help message
-J, --json
Format output as JSON
weka smb cluster remove
Destroy the SMB cluster managed by weka. This will not delete the data, just stop exposing it via SMB
weka smb cluster remove [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--force]
[--help]
--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 SMB clients.
-h, --help
Show help message
weka smb cluster status
Show which of the containers are ready.
weka smb cluster status [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
--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 smb cluster trusted-domains
List all trusted domains
weka smb cluster trusted-domains [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--no-header]
[--verbose]
--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,domain,idmap,from,to (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 smb cluster trusted-domains add
Add a new trusted domain
weka smb cluster trusted-domains add <domain-name>
<from-id>
<to-id>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--force]
[--help]
[--json]
domain-name*
The name of the domain being added
from-id*
The first id
to-id*
The last 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, --force
Force this action without further confirmation. This action may disrupt IO service for connected SMB clients and modify existing uids/gids.
-h, --help
Show help message
-J, --json
Format output as JSON
weka smb cluster trusted-domains remove
Remove a trusted domain
weka smb cluster trusted-domains remove <trusteddomain-id>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--force]
[--help]
trusteddomain-id*
The id of the domain to remove
--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 SMB clients and modify existing uids/gids.
-h, --help
Show help message
weka smb cluster update
Update an SMB cluster
weka smb cluster update [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--encryption encryption]
[--smb-ips-pool smb-ips-pool]...
[--smb-ips-range smb-ips-range]...
[--help]
--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
--encryption
Encryption (format: 'enabled', 'disabled', 'desired' or 'required')
--smb-ips-pool...
IPs used as floating IPs for SMB to serve in a HA manner. Then should not be assigned to any host on the network (may be repeated or comma-separated)
--smb-ips-range...
IPs used as floating IPs for SMB to serve in a HA manner. Then should not be assigned to any host on the network (may be repeated or comma-separated)
-h, --help
Show help message
weka smb cluster wait
Wait for SMB cluster to become ready
weka smb cluster wait [--timeout timeout]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
-t, --timeout
Timeout (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 smb domain
View info about the domain
weka smb domain [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
--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 smb domain join
Join cluster to Active Directory domain
weka smb domain join <username>
[password]
[--server server]
[--create-computer create-computer]
[--extra-options extra-options]
[--timeout timeout]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--debug]
[--help]
[--json]
username*
The name of the administrator user to join the domain using it
password
The administrator user password
--server
Specifies the remote domain controller for SMB-W domain join commands.
--create-computer
Creates an SMB cluster computer account in AD under a specified OU.
--extra-options
Consult with SMB 'net ads join' manual for extra options
-t, --timeout
Join command timeout in seconds (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
--debug
Run the command in debug mode
-h, --help
Show help message
-J, --json
Format output as JSON
weka smb domain leave
Leave Active Directory domain
weka smb domain leave <username>
[password]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--debug]
[--force]
[--help]
[--json]
username*
The name of the administrator user to leave the domain using it
password
The administrator user password
--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
--debug
Run the command in debug mode
-f, --force
Force to leave the domain. Use when Active Directory is unresponsive
-h, --help
Show help message
-J, --json
Format output as JSON
weka smb share
List all shares exposed via SMB
weka smb share [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--no-header]
[--verbose]
--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,share,filesystem,description,path,fmask,dmask,acls,options,additional,direct,Sensitivity,encryption,validUsers,invalidUsers,readonlyUsers,readwriteUsers,readonlyShare,allowGuestAccess,hidden,vfsZerocopyRead,namedStreams (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 smb share add
Add a new share to be exposed by SMB
weka smb share add <share-name>
<fs-name>
[--description description]
[--internal-path internal-path]
[--file-create-mask file-create-mask]
[--directory-create-mask directory-create-mask]
[--acl acl]
[--map-acls map-acls]
[--case-sensitivity case-sensitivity]
[--obs-direct obs-direct]
[--encryption encryption]
[--read-only read-only]
[--user-list-type user-list-type]
[--allow-guest-access allow-guest-access]
[--enable-ADS enable-ADS]
[--hidden hidden]
[--vfs-zerocopy-read vfs-zerocopy-read]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--users users]...
[--force]
[--help]
[--json]
share-name*
The name of the share being added
fs-name*
Filesystem name to share
--description
A description for SMB to show regarding the share
--internal-path
The path inside the filesystem to share
--file-create-mask
POSIX mode mask files will be created with. E.g. "0744"
--directory-create-mask
POSIX mode mask directories will be created with. E.g. "0755"
--acl
Enable Windows ACLs on the share. Will also be translated (as possible) to POSIX ACLs. (format: 'on' or 'off')
--map-acls
Map ACL (format: 'posix', 'windows', 'hybrid' or 'none')
--case-sensitivity
Enable or disable case sensitivity for the specified SMB share. When enabled, the share distinguishes between files with the same name but different capitalization. This option applies exclusively to SMB-W cluster. (format: 'on' or 'off')
--obs-direct
Mount share in obs-direct mode (format: 'on' or 'off')
--encryption
Encryption (format: 'cluster_default', 'desired' or 'required')
--read-only
Mount share as read-only (format: 'on' or 'off')
--user-list-type
The list type to which users are added to (format: 'read_only', 'read_write', 'valid' or 'invalid')
--allow-guest-access
Allow guests to access the share (format: 'on' or 'off')
--enable-ADS
Enables the use of Alternate Data Streams (ADS) on a specified SMB share. (format: 'yes' or 'no')
--hidden
Hidden (format: 'on' or 'off')
--vfs-zerocopy-read
Enable zero-copy reads if supported. Default: true (format: 'on' or 'off')
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-H, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T, --TIMEOUT
Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--profile
Name of the connection and authentication profile to use
--users...
Users to add (may be repeated or comma-separated)
-f, --force
Force this action without further confirmation. This action will affect all SMB users of this share, Use it with caution and consult the Weka Customer Success team at need.
-h, --help
Show help message
-J, --json
Format output as JSON
weka smb share host-access
Show host access help
weka smb share host-access [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka smb share host-access add
Add hosts IPs to host access list
weka smb share host-access add <share-id>
<mode>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--ips ips]...
[--help]
[--json]
share-id*
The id of the share
mode*
allow/deny host access (format: 'allow' or 'deny')
--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 add (may be repeated or comma-separated)
-h, --help
Show help message
-J, --json
Format output as JSON
weka smb share host-access list
Show host access list
weka smb share host-access list [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--no-header]
[--verbose]
--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,share,mode,IP (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 smb share host-access remove
Remove hosts IPs from a user list
weka smb share host-access remove <share_id>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
[<hosts>]...
share_id*
The id of the share being removed from
hosts...
Hosts IPs to remove
--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 smb share host-access reset
Reset host access lists
weka smb share host-access reset <share-id>
<mode>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--force]
[--help]
[--json]
share-id*
The id of the share
mode*
allow/deny host access (format: 'allow' or 'deny')
--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 will delete all host access ips.
-h, --help
Show help message
-J, --json
Format output as JSON
weka smb share list
Show lists help
weka smb share list [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka smb share list add
Add users to a user list
weka smb share list add <share-id>
<user-list-type>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--users users]...
[--help]
[--json]
share-id*
The id of the share
user-list-type*
The list type (format: 'read_only', 'read_write', 'valid' or 'invalid')
--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
--users...
Users to add (may be repeated or comma-separated)
-h, --help
Show help message
-J, --json
Format output as JSON
weka smb share list remove
Remove users from a user list
weka smb share list remove <share_id>
<user-list-type>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--users users]...
[--help]
[--json]
share_id*
The id of the share being removed from
user-list-type*
The list type from which users are removed from (format: 'read_only', 'read_write', 'valid' or 'invalid')
--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
--users...
Users to remove (may be repeated or comma-separated)
-h, --help
Show help message
-J, --json
Format output as JSON
weka smb share list reset
Reset a user list
weka smb share list reset <share-id>
<user-list-type>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
share-id*
The id of the share
user-list-type*
The list type (format: 'read_only', 'read_write', 'valid' or 'invalid')
--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 smb share list show
Show user lists
weka smb share list show [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--no-header]
[--verbose]
--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,share,readonly,validusers,invalidusers,readonlyusers,readwriteusers (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 smb share remove
Remove a share exposed by SMB
weka smb share remove <share-id>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--force]
[--help]
share-id*
The id of the share to remove
--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 SMB clients.
-h, --help
Show help message
weka smb share update
Update an SMB share
weka smb share update <share-id>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--encryption encryption]
[--read-only read-only]
[--allow-guest-access allow-guest-access]
[--hidden hidden]
[--help]
share-id*
The id of the share to update
--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
--encryption
Encryption (format: 'cluster_default', 'desired' or 'required')
--read-only
Mount as read-only (format: 'on' or 'off')
--allow-guest-access
Allow Guest Access (format: 'on' or 'off')
--hidden
Hidden (format: 'on' or 'off')
-h, --help
Show help message
weka stats
List all statistics that conform to the filter criteria
weka stats [--start-time <start>]
[--end-time <end>]
[--interval interval]
[--resolution-secs <secs>]
[--role role]
[--aggregate-by aggregate-by]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--category category]...
[--stat stat]...
[--process-ids process-ids]...
[--param param]...
[--exclude-process-ids exclude-process-ids]...
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--accumulated]
[--per-process]
[--per-role]
[--no-zeros]
[--show-internal]
[--skip-validations]
[--help]
[--raw-units]
[--UTC]
[--no-header]
[--verbose]
--start-time
Query for stats starting at this time (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
Query for stats up to 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)
--interval
Period (in seconds) of time of the report
--resolution-secs
Length of each interval in the report period
--role
Limit the report to processes with the specified role
--aggregate-by
Aggregate statistics by the specified component (format: 'none', 'process', 'container' or 'server')
--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')
--category...
Retrieve only statistics of the specified categories (may be repeated or comma-separated)
--stat...
Retrieve only the specified statistics (may be repeated or comma-separated)
--process-ids...
Limit the report to the specified processes (may be repeated or comma-separated)
--param...
For parameterized statistics, retrieve only the instantiations where the specified parameter is of the specified value. Multiple values can be supplied for the same key, e.g. '--param method:putBlocks --param method:initBlock'. (format: key:value, may be repeated or comma-separated)
--exclude-process-ids...
Limit the report to all processes except the specified ones (may be repeated or comma-separated)
-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)
--accumulated
Show accumulated statistics, not rate statistics
--per-process
Do not aggregate statistics across processes
--per-role
Aggregate statistics by role
-Z, --no-zeros
Do not retrieve results where the value is 0
--show-internal
Show internal statistics
--skip-validations
Skip category/stat name validations
-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 stats list-types
Show the statistics definition information
weka stats list-types [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--show-internal]
[--help]
[--no-header]
[--verbose]
[<name-or-category>]...
name-or-category...
Filter by these names or categories
--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: category,clabel,identifier,description,label,type,unit,params,realted,permission,ntype,accumulate,histogram,histogramUnit (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 statistics
-h, --help
Show help message
--no-header
Don't show column headers when printing the output
-v, --verbose
Show all columns in output
weka stats realtime
Get performance related stats which are updated in a one-second interval.
weka stats realtime [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--raw-units]
[--UTC]
[--show-total]
[--no-header]
[--verbose]
[<process-ids>]...
process-ids...
Only show realtime stats of these 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
-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,hostname,role,mode,writeps,writebps,wlatency,readps,readbps,rlatency,ops,cpu,l6recv,l6send,upload,download,rdmarecv,rdmasend (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.
--show-total
Show each column's sum of values in the real-time statistics output
--no-header
Don't show column headers when printing the output
-v, --verbose
Show all columns in output
weka stats retention
Configure retention for statistics
weka stats retention [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka stats retention restore-default
Restore default retention for statistics
weka stats retention restore-default [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--dry-run]
[--help]
[--json]
--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
--dry-run
Only test the command, don't affect the system
-h, --help
Show help message
-J, --json
Format output as JSON
weka stats retention set
Choose how long to keep statistics for
weka stats retention set [--days days]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--dry-run]
[--help]
[--json]
--days
Number of days to keep the statistics
--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
--dry-run
Only test the command, don't affect the system
-h, --help
Show help message
-J, --json
Format output as JSON
weka stats retention status
Show configured statistics retention
weka stats retention status [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
--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 status
Get an overall status of the Weka cluster
weka status [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--detailed-capacity]
[--help]
[--json]
[--raw-units]
[--UTC]
--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
--detailed-capacity
Include more detailed capacity information
-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 status rebuild
Show the cluster phasing in/out progress, and protection per fault-level
weka status rebuild [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
[--raw-units]
[--UTC]
--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 status reduction
Show cluster data reduction information'
weka status reduction [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
[--raw-units]
[--UTC]
--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 umount
Unmounts wekafs filesystems. This is the helper utility installed at /sbin/umount.wekafs.
weka umount <target>
[--type type]
[--color color]
[--verbose]
[--no-mtab]
[--lazy-unmount]
[--force]
[--readonly]
[--help]
target*
The target mount point to unmount
-t, --type
Indicate that the actions should only be taken on file systems of the specified type
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-v, --verbose
Verbose mode
-n, --no-mtab
Unmount without writing in /etc/mtab
-l, --lazy-unmount
Detach the filesystem from the filesystem hierarchy now, and cleanup all references to the filesystem as soon as it is not busy anymore
-f, --force
Force unmount
-r, --readonly
In case unmounting fails, try to remount read-only
-h, --help
Show help message
weka upgrade
Commands that control the upgrade precedure of Weka
weka upgrade [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka upgrade pause
Pause the upgrade process
weka upgrade pause [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
--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 upgrade resume
Resume the upgrade process
weka upgrade resume [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
--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 upgrade supported-features
List upgrade features supported by the running cluster
weka upgrade supported-features [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
--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 user
List users defined in the Weka cluster
weka user [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--sort sort]...
[--filter filter]...
[--filter-color filter-color]...
[--help]
[--no-header]
[--verbose]
--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,user,source,role,s3Policy,posix_uid,posix_gid (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 user add
Create a new user in the Weka cluster
weka user add <username>
<role>
[--posix-uid posix-uid]
[--posix-gid posix-gid]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
username*
Username of the new user to create
role*
The role of the new user (format: 'clusteradmin', 'orgadmin', 'regular', 'readonly', 's3' or 'csi')
password*
Password for the new user: must contain at least 8 characters, and have at least one uppercase letter, one lowercase letter, and one number or special character. Typing special characters as arguments to this command might require escaping
--posix-uid
POSIX UID for user (S3 Only)
--posix-gid
POSIX GID for user (S3 Only)
--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 user change-role
Change the role of an existing user.
weka user change-role <username>
<role>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
username*
Username of user to change the role of
role*
New role to set for the user (format: 'clusteradmin', 'orgadmin', 'regular', 'readonly', 's3' or 'csi')
--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 user remove
Delete user from the Weka cluster
weka user remove <username>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
username*
User's 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 user generate-token
Generate an access token for the current logged in user for use with REST API
weka user generate-token [--access-token-timeout access-token-timeout]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
--access-token-timeout
In how long should the access token expire (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
-J, --json
Format output as JSON
weka user ldap
Show current LDAP configuration used for authenticating users
weka user ldap [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
--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 user ldap disable
Disable authentication through the configured LDAP server
weka user ldap disable [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--force]
[--help]
[--json]
--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 would prevent all LDAP users from logging-in until LDAP is enabled again.
-h, --help
Show help message
-J, --json
Format output as JSON
weka user ldap enable
Enable authentication through the configured LDAP server (has no effect if LDAP server is already enabled)
weka user ldap enable [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
--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 user ldap reset
Delete all LDAP settings from the cluster
weka user ldap reset [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--force]
[--help]
[--json]
--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 would prevent all LDAP users from logging-in until LDAP is configured again.
-h, --help
Show help message
-J, --json
Format output as JSON
weka user ldap setup
Setup an LDAP server for user authentication
weka user ldap setup <server-uri>
<base-dn>
<user-object-class>
<user-id-attribute>
<group-object-class>
<group-membership-attribute>
<group-id-attribute>
<reader-username>
[--cluster-admin-group cluster-admin-group]
[--org-admin-group org-admin-group]
[--regular-group regular-group]
[--readonly-group readonly-group]
[--start-tls start-tls]
[--ignore-start-tls-failure ignore-start-tls-failure]
[--server-timeout-secs server-timeout-secs]
[--protocol-version protocol-version]
[--user-revocation-attribute user-revocation-attribute]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
server-uri*
LDAP server URI ([ldap://]hostname[:port] or ldaps://hostname[:port])
base-dn*
Base DN
user-object-class*
User object class
user-id-attribute*
User ID attribute
group-object-class*
Group object class
group-membership-attribute*
Group membership attribute
group-id-attribute*
Group ID attribute
reader-username*
Reader username
reader-password*
Reader password
--cluster-admin-group
LDAP group of users that should get ClusterAdmin role (this role is only available for the root tenant to configure)
--org-admin-group
LDAP group of users that should get OrgAdmin role
--regular-group
LDAP group of users that should get Regular role
--readonly-group
LDAP group of users that should get ReadOnly role
--start-tls
Issue StartTLS after connecting (should not be used with ldaps://) (format: 'yes' or 'no')
--ignore-start-tls-failure
Ignore start TLS failure (format: 'yes' or 'no')
--server-timeout-secs
LDAP connection timeout in seconds
--protocol-version
LDAP protocol version
--user-revocation-attribute
User revocation attribute: If provided, updating this attribute in the LDAP server automatically revokes all user tokens.
--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 user ldap setup-ad
Setup an Active Directory server for user authentication
weka user ldap setup-ad <server-uri>
<domain>
<reader-username>
[--cluster-admin-group cluster-admin-group]
[--org-admin-group org-admin-group]
[--regular-group regular-group]
[--readonly-group readonly-group]
[--start-tls start-tls]
[--ignore-start-tls-failure ignore-start-tls-failure]
[--server-timeout-secs server-timeout-secs]
[--user-revocation-attribute user-revocation-attribute]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
server-uri*
LDAP server URI ([ldap://]hostname[:port] or ldaps://hostname[:port])
domain*
Domain
reader-username*
Reader username
reader-password*
Reader password
--cluster-admin-group
LDAP group of users that should get ClusterAdmin role (this role is only available for the root tenant to configure)
--org-admin-group
LDAP group of users that should get OrgAdmin role
--regular-group
LDAP group of users that should get Regular role
--readonly-group
LDAP group of users that should get ReadOnly role
--start-tls
Issue StartTLS after connecting (should not be used with ldaps://) (format: 'yes' or 'no')
--ignore-start-tls-failure
Ignore start TLS failure (format: 'yes' or 'no')
--server-timeout-secs
LDAP connection timeout in seconds
--user-revocation-attribute
User revocation attribute: If provided, updating this attribute in the LDAP server automatically revokes all user tokens.
--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 user ldap update
Edit LDAP server configuration
weka user ldap update [--server-uri server-uri]
[--base-dn base-dn]
[--user-object-class user-object-class]
[--user-id-attribute user-id-attribute]
[--group-object-class group-object-class]
[--group-membership-attribute group-membership-attribute]
[--group-id-attribute group-id-attribute]
[--reader-username reader-username]
[--reader-password reader-password]
[--cluster-admin-group cluster-admin-group]
[--org-admin-group org-admin-group]
[--regular-group regular-group]
[--readonly-group readonly-group]
[--start-tls start-tls]
[--certificate certificate]
[--ignore-start-tls-failure ignore-start-tls-failure]
[--server-timeout-secs server-timeout-secs]
[--protocol-version protocol-version]
[--user-revocation-attribute user-revocation-attribute]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
--server-uri
LDAP server URI ([ldap://]hostname[:port] or ldaps://hostname[:port])
--base-dn
Base DN
--user-object-class
User object class
--user-id-attribute
User ID attribute
--group-object-class
Group object class
--group-membership-attribute
Group membership attribute
--group-id-attribute
Group ID attribute
--reader-username
Reader username
--reader-password
Reader password
--cluster-admin-group
LDAP group of users that should get ClusterAdmin role (this role is only available for the root tenant to configure)
--org-admin-group
LDAP group of users that should get OrgAdmin role
--regular-group
LDAP group of users that should get Regular role
--readonly-group
LDAP group of users that should get ReadOnly role
--start-tls
Issue StartTLS after connecting (should not be used with ldaps://) (format: 'yes' or 'no')
--certificate
Certificate or certificate chain for the LDAP server
--ignore-start-tls-failure
Ignore certificate verification errors (format: 'yes' or 'no')
--server-timeout-secs
LDAP connection timeout in seconds
--protocol-version
LDAP protocol version
--user-revocation-attribute
User revocation attribute: If provided, updating this attribute in the LDAP server automatically revokes all user tokens.
--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 user login
Logs a user into the Weka cluster. If login is successful, the user credentials are saved to the user homedir.
weka user login [username]
[password]
[--org org]
[--path path]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
username
User's username
password
User's password
-g, --org
Organization name or ID
-p, --path
The path where the login token will be saved (default: ~/.weka/auth-token.json). This path can also be specified using the WEKA_TOKEN environment variable. After logging-in, use the WEKA_TOKEN environment variable to specify where the login token is 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 user logout
Logs the current user out of the Weka cluster by removing the user credentials from WEKA_TOKEN if exists, or otherwise from the user homedir
weka user logout [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
--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 user passwd
Set a user's password. If the currently logged-in user is an admin, it can change the password for all other users in the organization.
weka user passwd [--username username]
[--current-password current-password]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
password*
New password: must contain at least 8 characters, and have at least one uppercase letter, one lowercase letter, and one number or special character. Typing special characters as arguments to this command might require escaping
--username
Username to change the password for, by default password is changed for the current user
--current-password
User's current password. Only necessary if changing current user's password
--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 user revoke-tokens
Revoke all existing login tokens of an internal user
weka user revoke-tokens <username>
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
[--json]
username*
Username of user to revoke the tokens for
--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 user update
Change parameters of an existing user.
weka user update <username>
[--posix-uid posix-uid]
[--posix-gid posix-gid]
[--role role]
[--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--help]
username*
Username of user to update
--posix-uid
POSIX UID for user (S3 Only)
--posix-gid
POSIX GID for user (S3 Only)
--role
New role to set for the user (format: 'clusteradmin', 'orgadmin', 'regular', 'readonly', 's3' or 'csi')
--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 user whoami
Get information about currently logged-in user
weka user whoami [--color color]
[--HOST HOST]
[--PORT PORT]
[--CONNECT-TIMEOUT CONNECT-TIMEOUT]
[--TIMEOUT TIMEOUT]
[--profile profile]
[--format format]
[--output output]...
[--help]
[--no-header]
[--verbose]
--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: orgId,orgName,user,source,role (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 version
When run without arguments, lists the versions available on this machine. Subcommands allow for downloading of versions, setting the current version and other actions to manage versions.
weka version [--color color] [--full] [--help] [--json]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
--full
Show only fully installed versions
-h, --help
Show help message
-J, --json
Format output as JSON
weka version current
Prints the current version. If no version is set, a failure exit status is returned.
weka version current [--container container] [--color color] [--help]
-C, --container
Get the version for a specific container
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka version get
Download a Weka version to the machine this command is executed from
weka version get <version>
[--color color]
[--from from]...
[--set-current]
[--no-progress-bar]
[--set-dist-servers]
[--client-only]
[--driver-only]
[--help]
version*
Version to download
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
--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)
--set-current
Set the downloaded version as the current version. Will fail if any containers are currently running.
--no-progress-bar
Don't render download progress bar
--set-dist-servers
Override the default distribution servers upon successful download
--client-only
Only download components required for client
--driver-only
Only download components required for compiling drivers
-h, --help
Show help message
weka version prepare
Prepare the version for use. This includes things like compiling the version drivers for the local machine.
weka version prepare <version-name> [--color color] [--help] [<containers>]...
version-name*
The version to prepare
containers...
The containers to prepare the version for
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message
weka version rm
Delete a version from the machine this command is executed from
weka version rm [--color color] [--clean-unused] [--force] [--help] [<version-name>]...
version-name...
The versions to remove
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
--clean-unused
Delete all versions which aren't the current set version, or the version of any of the containers
-f, --force
Force this action without further confirmation. This action may be undone by re-downloading the version.
-h, --help
Show help message
weka version set
Set the current version. Containers must be stopped before setting the current version and the new version must have already been downloaded.
weka version set <version>
[--container container]
[--color color]
[--allow-running-containers]
[--default-only]
[--agent-only]
[--set-dependent]
[--client-only]
[--help]
version*
The version name to use
-C, --container
The container to set the version for
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
--allow-running-containers
Do not verify that all containers are stopped
--default-only
Only set the default version used for creating containers
--agent-only
Only set the agent version
--set-dependent
Set the version for all containers depending on the specified container
--client-only
Only set the client version
-h, --help
Show help message
weka version reset
Unset the current version. Containers must be stopped before setting the current version and the new version must have already been downloaded.
weka version reset [--color color] [--help]
--color
Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled')
-h, --help
Show help message