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
--agent
Start the agent service
-h
, --help
Show help message
--build
Prints the CLI build number and exits
-v
, --version
Prints the CLI version and exits
--legal
Prints software license information and exits
weka agent
Commands that control the weka agent (outside the weka containers)
-h
, --help
Show help message
weka agent install-agent
Installs Weka agent on the machine the command is executed from
--no-update
Don't update the locally installed containers
-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.
-h
, --help
Show help message
weka agent supported-specs
List the Weka spec versions that are supported by this agent version
-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!
--force
Force the action to actually happen
--ignore-wekafs-mounts
Proceed even with active wekafs mounts
--keep-files
Do not remove Weka version images and keep in installation directory
-h
, --help
Show help message
weka agent autocomplete
Bash autocompletion utilities
-h
, --help
Show help message
weka agent autocomplete install
Locally install bash autocompletion utility
-h
, --help
Show help message
weka agent autocomplete uninstall
Locally uninstall bash autocompletion utility
-h
, --help
Show help message
weka agent autocomplete export
Export bash autocompletion script
-h
, --help
Show help message
weka alerts
List alerts in the Weka cluster
-H
, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P
, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C
, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T
, --TIMEOUT
Timeout to wait 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. Available options are: view
-o
, --output
...
Specify which columns to output. May include any of the following: muted,type,count,title,description,action
-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[,..]]
--muted
List muted alerts alongside the unmuted ones
-h
, --help
Show help message
--no-header
Don't show column headers when printing the output
-v
, --verbose
Show all columns in output
weka alerts types
List all alert types that can be returned from the Weka cluster
-H
, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P
, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C
, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T
, --TIMEOUT
Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--profile
Name of the connection and authentication profile to use
-h
, --help
Show help message
-J
, --json
Format output as JSON
weka alerts mute
Mute an alert-type. Muted alerts will not be prompted when listing active alerts. Alerts cannot be suppressed indefinitely, so a duration must be supplied. Once the supplied duration has passed, the alert-type would be automatically unmuted
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)
-H
, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P
, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C
, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T
, --TIMEOUT
Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--profile
Name of the connection and authentication profile to use
-h
, --help
Show help message
weka alerts unmute
Unmute an alert-type which was previously muted.
alert-type
*
An alert-type to unmute, use weka alerts types
to list types
-H
, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P
, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C
, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T
, --TIMEOUT
Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--profile
Name of the connection and authentication profile to use
-h
, --help
Show help message
weka alerts describe
Describe all the alert types that might be returned from the weka cluster (including explanations and how to handle them)
-H
, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P
, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C
, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T
, --TIMEOUT
Timeout to wait 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. Available options are: view
-o
, --output
...
Specify which columns to output. May include any of the following: type,title,action
-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[,..]]
-h
, --help
Show help message
--no-header
Don't show column headers when printing the output
-v
, --verbose
Show all columns in output
weka cloud
Cloud commands. List the cluster's cloud status, if no subcommand supplied.
-h
, --help
Show help message
weka cloud status
Show cloud connectivity status
-H
, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P
, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C
, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T
, --TIMEOUT
Timeout to wait 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. Available options are: view
-o
, --output
...
Specify which columns to output. May include any of the following: host,health
-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[,..]]
-h
, --help
Show help message
--no-header
Don't show column headers when printing the output
-v
, --verbose
Show all columns in output
weka cloud enable
Turn cloud features on
--cloud-url
The base url of the cloud service
--cloud-stats
Enable or disable uploading stats to the cloud (format: 'on' or 'off')
-H
, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P
, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C
, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T
, --TIMEOUT
Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--profile
Name of the connection and authentication profile to use
-h
, --help
Show help message
weka cloud disable
Turn cloud features off
-H
, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P
, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C
, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T
, --TIMEOUT
Timeout to wait for response, default: 1 minute (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
-H
, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P
, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C
, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T
, --TIMEOUT
Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--profile
Name of the connection and authentication profile to use
-s
, --set
Set a new proxy setting
-h
, --help
Show help message
-J
, --json
Format output as JSON
-u
, --unset
Remove the HTTP proxy setting
weka cloud update
Update cloud settings
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
-H
, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P
, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C
, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T
, --TIMEOUT
Timeout to wait for response, default: 1 minute (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
-H
, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P
, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C
, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T
, --TIMEOUT
Timeout to wait for response, default: 1 minute (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
--bytes-per-second
Maximum uploaded bytes per second
-H
, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P
, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C
, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T
, --TIMEOUT
Timeout to wait for response, default: 1 minute (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
-h
, --help
Show help message
weka cluster create
Form a Weka cluster from hosts that just has Weka installed on them
host-hostnames
...
A list of hostname 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
-H
, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P
, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C
, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T
, --TIMEOUT
Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--profile
Name of the connection and authentication profile to use
--host-ips
...
Management IP addresses; If empty, the hostnames will be resolved; If hosts are highly-available or mixed-networking, use IP set '++...+';
-h
, --help
Show help message
-J
, --json
Format output as JSON
weka cluster update
Update cluster configuration
--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)
-H
, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P
, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C
, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T
, --TIMEOUT
Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--profile
Name of the connection and authentication profile to use
-h
, --help
Show help message
weka cluster process
List the cluster processes
process-ids
...
Only return these processes IDs.
-H
, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P
, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C
, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T
, --TIMEOUT
Timeout to wait 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. Available options are: view
--container
...
Only return the processes of these container IDs, if not specified the weka-processes for all the containers will be returned
-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
-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[,..]]
-b
, --backends
Only return backend containers
-c
, --clients
Only return client containers
-l
, --leadership
Only return containers that are part of the cluster leadership
-L
, --leader
Only return the cluster leader
-h
, --help
Show help message
-R
, --raw-units
Print values in raw units (bytes, seconds, etc.). When not set, sizes are printed in human-readable format, e.g 1KiB 234MiB 2GiB.
-U
, --UTC
Print times in UTC. When not set, times are converted to the local time of this host.
--no-header
Don't show column headers when printing the output
-v
, --verbose
Show all columns in output
weka cluster bucket
List the cluster buckets, logical compute units used to divide the workload in the cluster
bucket-ids
...
Only return these bucket IDs.
-H
, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P
, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C
, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T
, --TIMEOUT
Timeout to wait 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. Available options are: view
-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
-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[,..]]
-h
, --help
Show help message
-R
, --raw-units
Print values in raw units (bytes, seconds, etc.). When not set, sizes are printed in human-readable format, e.g 1KiB 234MiB 2GiB.
-U
, --UTC
Print times in UTC. When not set, times are converted to the local time of this host.
--no-header
Don't show column headers when printing the output
-v
, --verbose
Show all columns in output
weka cluster failure-domain
List the Weka cluster failure domains
-H
, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P
, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C
, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T
, --TIMEOUT
Timeout to wait 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. Available options are: view
-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
-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[,..]]
--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
count
...
The number of failure-domains
-H
, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P
, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C
, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T
, --TIMEOUT
Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--profile
Name of the connection and authentication profile to use
--skip-resource-validation
Skip verifying that the cluster has enough RAM and SSD resources allocated for the hot-spare
-h
, --help
Show help message
-J
, --json
Format output as JSON
-R
, --raw-units
Print values in raw units (bytes, seconds, etc.). When not set, sizes are printed in human-readable format, e.g 1KiB 234MiB 2GiB.
-U
, --UTC
Print times in UTC. When not set, times are converted to the local time of this host.
weka cluster start-io
Start IO services
-H
, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P
, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C
, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T
, --TIMEOUT
Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--profile
Name of the connection and authentication profile to use
-h
, --help
Show help message
weka cluster stop-io
Stop IO services
-H
, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P
, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C
, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T
, --TIMEOUT
Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--profile
Name of the connection and authentication profile to use
--brutal-no-flush
Force stopping IO services immediately without graceful flushing of ongoing operations. Using this flag may cause data-loss if used without explicit guidance from WekaIO customer support.
--keep-external-containers
Keep external containers(S3, SMB, NFS) running
-f
, --force
Force this action without further confirmation. This action will disrupt operation of all connected clients. To restore IO service run 'weka cluster start-io'.
-h
, --help
Show help message
weka cluster drive
List the cluster's drives
uuids
...
A list of drive IDs or UUIDs to list. If no ID is specified, all drives are listed.
-H
, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P
, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C
, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T
, --TIMEOUT
Timeout to wait 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. Available options are: view
--container
...
Only return the drives of these container IDs, if not specified, all drives are listed
-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
-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[,..]]
--show-removed
Show drives that were removed from the cluster
-h
, --help
Show help message
-R
, --raw-units
Print values in raw units (bytes, seconds, etc.). When not set, sizes are printed in human-readable format, e.g 1KiB 234MiB 2GiB.
-U
, --UTC
Print times in UTC. When not set, times are converted to the local time of this host.
--no-header
Don't show column headers when printing the output
-v
, --verbose
Show all columns in output
weka cluster drive scan
Scan for provisioned drives on the cluster's containers
container-ids
...
A list of container ids to scan for drives
-H
, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P
, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C
, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T
, --TIMEOUT
Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--profile
Name of the connection and authentication profile to use
-h
, --help
Show help message
-R
, --raw-units
Print values in raw units (bytes, seconds, etc.). When not set, sizes are printed in human-readable format, e.g 1KiB 234MiB 2GiB.
-U
, --UTC
Print times in UTC. When not set, times are converted to the local time of this host.
weka cluster drive activate
Activate the supplied drive, or all drives (if none supplied)
uuids
...
A list of drive IDs or UUIDs to activate. If no ID is supplied, all inactive drives will be activated.
-H
, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P
, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C
, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T
, --TIMEOUT
Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--profile
Name of the connection and authentication profile to use
-h
, --help
Show help message
-R
, --raw-units
Print values in raw units (bytes, seconds, etc.). When not set, sizes are printed in human-readable format, e.g 1KiB 234MiB 2GiB.
-U
, --UTC
Print times in UTC. When not set, times are converted to the local time of this host.
weka cluster drive deactivate
Deactivate the supplied drive(s)
uuids
...
A list of drive IDs or UUIDs to deactivate.
-H
, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P
, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C
, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T
, --TIMEOUT
Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--profile
Name of the connection and authentication profile to use
--skip-resource-validation
Skip verifying that the configured hot spare capacity will remain available after deactivating the drives
-f
, --force
Force this action without further confirmation. This action may impact performance while the drive is phasing out.
-h
, --help
Show help message
weka cluster drive add
Add the given drive
container-id
*
The container the drive attached to (given by ids)
device-paths
...
Device paths of the drives to add
-H
, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P
, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C
, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T
, --TIMEOUT
Timeout to wait 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. Available options are: view
-o
, --output
...
Specify which columns to output. May include any of the following: path,uuid
-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[,..]]
--force
Force formatting the drive for weka, avoiding all safety checks!
--allow-format-non-wekafs-drives
Allow reuse of drives formatted by another versions
-h
, --help
Show help message
-R
, --raw-units
Print values in raw units (bytes, seconds, etc.). When not set, sizes are printed in human-readable format, e.g 1KiB 234MiB 2GiB.
-U
, --UTC
Print times in UTC. When not set, times are converted to the local time of this host.
--no-header
Don't show column headers when printing the output
-v
, --verbose
Show all columns in output
weka cluster drive remove
Remove the supplied drive(s)
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'
-H
, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P
, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C
, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T
, --TIMEOUT
Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--profile
Name of the connection and authentication profile to use
-f
, --force
Force this action without further confirmation. To undo the removal, add the drive back and re-scan the drives on the host local to the drive.
-h
, --help
Show help message
weka cluster mount-defaults
Commands for editing default mount options
-h
, --help
Show help message
weka cluster mount-defaults set
Set default mount options.
--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
, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P
, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C
, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T
, --TIMEOUT
Timeout to wait for response, default: 1 minute (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
-H
, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P
, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C
, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T
, --TIMEOUT
Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--profile
Name of the connection and authentication profile to use
-J
, --json
Format output as JSON
-h
, --help
Show help message
weka cluster mount-defaults reset
Reset default mount options
-H
, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P
, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C
, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T
, --TIMEOUT
Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
--profile
Name of the connection and authentication profile to use
--qos-max-throughput
qos-max-throughput is the maximum throughput allowed for the client for either receive or transmit traffic.
--qos-preferred-throughput
qos-preferred-throughput is the throughput that gets preferred state (NORMAL instead of LOW) in QoS.
--qos-max-ops
qos-max-ops is the maximum number of operations of any kind for the client
-h
, --help
Show help message
weka cluster servers
Commands for physical servers
-h
, --help
Show help message
weka cluster servers list
List the cluster servers
-H
, --HOST
Specify the host. Alternatively, use the WEKA_HOST env variable
-P
, --PORT
Specify the port. Alternatively, use the WEKA_PORT env variable
-C
, --CONNECT-TIMEOUT
Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited)
-T
, --TIMEOUT
Timeout to wait 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. Available options are: view
--role
...
Only list machines with specified roles. Possible roles: (format: 'backend', 'client', 'nfs', 'smb' or 's3')
-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
-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[,..]]
-h
, --help
Show help message
--no-header
Don't show column headers when printing the output
-v
, --verbose
Show all columns in output
weka cluster servers show
Show a single server overview according to given server uid