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
| Parameter | Description |
|---|---|
| Start the agent service |
| Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled') |
| Show help message |
| Prints the CLI build number and exits |
| Prints the CLI version and exits |
| Prints software license information and exits |
weka access-group
Commands that manage the cluster access-groups
| Parameter | Description |
|---|---|
| Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled') |
| Show help message |
weka access-group status
Show the status of the access-groups
| Parameter | Description |
|---|---|
| Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled') |
| Specify the host. Alternatively, use the WEKA_HOST env variable |
| Specify the port. Alternatively, use the WEKA_PORT env variable |
| Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Name of the connection and authentication profile to use |
| Show help message |
| Format output as JSON |
weka access-group enable
Enable access-groups
| Parameter | Description |
|---|---|
| Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled') |
| Specify the host. Alternatively, use the WEKA_HOST env variable |
| Specify the port. Alternatively, use the WEKA_PORT env variable |
| Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Name of the connection and authentication profile to use |
| Show help message |
| Format output as JSON |
weka access-group disable
Disable access-groups
| Parameter | Description |
|---|---|
| Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled') |
| Specify the host. Alternatively, use the WEKA_HOST env variable |
| Specify the port. Alternatively, use the WEKA_PORT env variable |
| Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Name of the connection and authentication profile to use |
| Show help message |
| Format output as JSON |
weka agent
Commands that control the weka agent (outside the weka containers)
| Parameter | Description |
|---|---|
| Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled') |
| Show help message |
weka agent install-agent
Installs Weka agent on the machine the command is executed from
| Parameter | Description |
|---|---|
| The port to listen on for incoming requests |
| Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled') |
| Don't update the locally installed containers |
| Do not register the weka-agent service and start it after its creation |
| Show help message |
weka agent update-containers
Update the currently available containers and version specs to the current agent version. This command does not update weka, only the container's representation on the local machine.
| Parameter | Description |
|---|---|
| Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled') |
| Show help message |
weka agent uninstall
Deletes all Weka files, drivers, shared memory and any other remainder from the machine this command is executed from. WARNING - This action is destructive and might cause a loss of data!
| Parameter | Description |
|---|---|
| Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled') |
| Force the action to actually happen |
| Proceed even with active wekafs mounts |
| Do not remove Weka version images and keep in installation directory |
| Show help message |
weka agent autocomplete
Bash autocompletion utilities
| Parameter | Description |
|---|---|
| Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled') |
| Show help message |
weka agent autocomplete install
Locally install bash autocompletion utility
| Parameter | Description |
|---|---|
| Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled') |
| Show help message |
weka agent autocomplete uninstall
Locally uninstall bash autocompletion utility
| Parameter | Description |
|---|---|
| Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled') |
| Show help message |
weka agent autocomplete export
Export bash autocompletion script
| Parameter | Description |
|---|---|
| Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled') |
| Show help message |
weka alerts
List alerts in the Weka cluster
| Parameter | Description |
|---|---|
| Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled') |
| Specify the host. Alternatively, use the WEKA_HOST env variable |
| Specify the port. Alternatively, use the WEKA_PORT env variable |
| Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Name of the connection and authentication profile to use |
| Specify in what format to output the result (format: 'view', 'csv', 'markdown', 'json' or 'oldview') |
| Specify which columns to output. May include any of the following: muted,type,count,title,description,action (may be repeated or comma-separated) |
| 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: [+ |
| Specify what values to filter by in a specific column. Usage: column1=val1[,column2=val2[,..]] (may be repeated or comma-separated) |
| List muted alerts alongside the unmuted ones |
| Show help message |
| Don't show column headers when printing the output |
| Show all columns in output |
weka alerts types
List all alert types that can be returned from the Weka cluster
| Parameter | Description |
|---|---|
| Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled') |
| Specify the host. Alternatively, use the WEKA_HOST env variable |
| Specify the port. Alternatively, use the WEKA_PORT env variable |
| Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Name of the connection and authentication profile to use |
| Show help message |
| Format output as JSON |
weka alerts mute
Mute an alert-type. Muted alerts will not appear in the list of active alerts. It is required to specify a duration for the mute. Once the set duration concludes, the alert-type will automatically be unmuted.
| Parameter | Description |
|---|---|
| An alert-type to mute, use |
| How long to mute this alert type for (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled') |
| Specify the host. Alternatively, use the WEKA_HOST env variable |
| Specify the port. Alternatively, use the WEKA_PORT env variable |
| Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Name of the connection and authentication profile to use |
| Show help message |
weka alerts unmute
Unmute an alert-type which was previously muted.
| Parameter | Description |
|---|---|
| An alert-type to unmute, use |
| Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled') |
| Specify the host. Alternatively, use the WEKA_HOST env variable |
| Specify the port. Alternatively, use the WEKA_PORT env variable |
| Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Name of the connection and authentication profile to use |
| 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)
| Parameter | Description |
|---|---|
| Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled') |
| Specify the host. Alternatively, use the WEKA_HOST env variable |
| Specify the port. Alternatively, use the WEKA_PORT env variable |
| Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Name of the connection and authentication profile to use |
| Specify in what format to output the result (format: 'view', 'csv', 'markdown', 'json' or 'oldview') |
| Specify which columns to output. May include any of the following: type,title,action (may be repeated or comma-separated) |
| 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: [+ |
| Specify what values to filter by in a specific column. Usage: column1=val1[,column2=val2[,..]] (may be repeated or comma-separated) |
| Show help message |
| Don't show column headers when printing the output |
| Show all columns in output |
weka cloud
Cloud commands. List the cluster's cloud status, if no subcommand supplied.
| Parameter | Description |
|---|---|
| Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled') |
| Show help message |
weka cloud status
Show cloud connectivity status
| Parameter | Description |
|---|---|
| Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled') |
| Specify the host. Alternatively, use the WEKA_HOST env variable |
| Specify the port. Alternatively, use the WEKA_PORT env variable |
| Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Name of the connection and authentication profile to use |
| Specify in what format to output the result (format: 'view', 'csv', 'markdown', 'json' or 'oldview') |
| Specify which columns to output. May include any of the following: host,health (may be repeated or comma-separated) |
| 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: [+ |
| Specify what values to filter by in a specific column. Usage: column1=val1[,column2=val2[,..]] (may be repeated or comma-separated) |
| Show help message |
| Don't show column headers when printing the output |
| Show all columns in output |
weka cloud enable
Turn cloud features on
| Parameter | Description |
|---|---|
| The base url of the cloud service |
| Enable or disable uploading stats to the cloud (format: 'on' or 'off') |
| Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled') |
| Specify the host. Alternatively, use the WEKA_HOST env variable |
| Specify the port. Alternatively, use the WEKA_PORT env variable |
| Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Name of the connection and authentication profile to use |
| Show help message |
weka cloud disable
Turn cloud features off
| Parameter | Description |
|---|---|
| Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled') |
| Specify the host. Alternatively, use the WEKA_HOST env variable |
| Specify the port. Alternatively, use the WEKA_PORT env variable |
| Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Name of the connection and authentication profile to use |
| Show help message |
weka cloud proxy
Get or set the HTTP proxy used to connect to cloud services
| Parameter | Description |
|---|---|
| Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled') |
| Specify the host. Alternatively, use the WEKA_HOST env variable |
| Specify the port. Alternatively, use the WEKA_PORT env variable |
| Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Name of the connection and authentication profile to use |
| Set a new proxy setting |
| Show help message |
| Format output as JSON |
| Remove the HTTP proxy setting |
weka cloud update
Update cloud settings
| Parameter | Description |
|---|---|
| AWS bucket name |
| AWS region |
| AWS access key |
| AWS secret |
| S3 session token |
| S3 bucket prefix |
| HTTP(S) proxy to connect to the cloud through |
| Maximum uploaded bytes per second |
| Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled') |
| Specify the host. Alternatively, use the WEKA_HOST env variable |
| Specify the port. Alternatively, use the WEKA_PORT env variable |
| Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Name of the connection and authentication profile to use |
| Show help message |
weka cloud upload-rate
Get the cloud upload rate
| Parameter | Description |
|---|---|
| Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled') |
| Specify the host. Alternatively, use the WEKA_HOST env variable |
| Specify the port. Alternatively, use the WEKA_PORT env variable |
| Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Name of the connection and authentication profile to use |
| Show help message |
| Format output as JSON |
weka cloud upload-rate set
Set the cloud upload rate
| Parameter | Description |
|---|---|
| Maximum uploaded bytes per second |
| Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled') |
| Specify the host. Alternatively, use the WEKA_HOST env variable |
| Specify the port. Alternatively, use the WEKA_PORT env variable |
| Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Name of the connection and authentication profile to use |
| Show help message |
weka cluster
Commands that manage the cluster
| Parameter | Description |
|---|---|
| Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled') |
| Show help message |
weka cluster create
Form a Weka cluster from hosts that just had Weka installed on them
| Parameter | Description |
|---|---|
| A list of hostnames to be included in the new cluster |
| The password for the cluster admin user; will be set to the default password if not provided |
| Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled') |
| Specify the host. Alternatively, use the WEKA_HOST env variable |
| Specify the port. Alternatively, use the WEKA_PORT env variable |
| Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Name of the connection and authentication profile to use |
| Management IP addresses; If empty, the hostnames will be resolved; If hosts are highly-available or mixed-networking, use IP set '++...+'; (may be repeated or comma-separated) |
| Show help message |
| Format output as JSON |
weka cluster update
Update cluster configuration
| Parameter | Description |
|---|---|
| Cluster name |
| Number of RAID data drives |
| Number of RAID protection parity drives |
| 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) |
| Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled') |
| Specify the host. Alternatively, use the WEKA_HOST env variable |
| Specify the port. Alternatively, use the WEKA_PORT env variable |
| Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Name of the connection and authentication profile to use |
| Show help message |
weka cluster process
List the cluster processes
| Parameter | Description |
|---|---|
| Only return these processes IDs. |
| Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled') |
| Specify the host. Alternatively, use the WEKA_HOST env variable |
| Specify the port. Alternatively, use the WEKA_PORT env variable |
| Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Name of the connection and authentication profile to use |
| Specify in what format to output the result (format: 'view', 'csv', 'markdown', 'json' or 'oldview') |
| 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) |
| Only return processes with these roles (format: 'management', 'frontend', 'compute', 'drives' or 'dataserv', may be repeated or comma-separated) |
| Specify which columns to output. May include any of the following: uid,id,containerId,slot,hostname,container,ips,status,software,release,role,mode,netmode,cpuId,core,socket,numa,cpuModel,memory,uptime,fdName,fdId,traceHistory,fencingReason,joinRejectReason,failureText,failure,failureTime,failureCode (may be repeated or comma-separated) |
| 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: [+ |
| Specify what values to filter by in a specific column. Usage: column1=val1[,column2=val2[,..]] (may be repeated or comma-separated) |
| Get result from local weka host |
| Only return backend containers |
| Only return client containers |
| Only return containers that are part of the cluster leadership |
| Only return the cluster leader |
| Show help message |
| Print values in raw units (bytes, seconds, etc.). When not set, sizes are printed in human-readable format, e.g 1KiB 234MiB 2GiB. |
| Print times in UTC. When not set, times are converted to the local time of this host. |
| Don't show column headers when printing the output |
| Show all columns in output |
weka cluster bucket
List the cluster buckets, logical compute units used to divide the workload in the cluster
| Parameter | Description |
|---|---|
| Only return these bucket IDs. |
| Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled') |
| Specify the host. Alternatively, use the WEKA_HOST env variable |
| Specify the port. Alternatively, use the WEKA_PORT env variable |
| Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Name of the connection and authentication profile to use |
| Specify in what format to output the result (format: 'view', 'csv', 'markdown', 'json' or 'oldview') |
| 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) |
| 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: [+ |
| Specify what values to filter by in a specific column. Usage: column1=val1[,column2=val2[,..]] (may be repeated or comma-separated) |
| Show help message |
| Print values in raw units (bytes, seconds, etc.). When not set, sizes are printed in human-readable format, e.g 1KiB 234MiB 2GiB. |
| Print times in UTC. When not set, times are converted to the local time of this host. |
| Don't show column headers when printing the output |
| Show all columns in output |
weka cluster failure-domain
List the Weka cluster failure domains
| Parameter | Description |
|---|---|
| Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled') |
| Specify the host. Alternatively, use the WEKA_HOST env variable |
| Specify the port. Alternatively, use the WEKA_PORT env variable |
| Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Name of the connection and authentication profile to use |
| Specify in what format to output the result (format: 'view', 'csv', 'markdown', 'json' or 'oldview') |
| 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) |
| 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: [+ |
| Specify what values to filter by in a specific column. Usage: column1=val1[,column2=val2[,..]] (may be repeated or comma-separated) |
| Show drives that were removed from the cluster |
| Show help message |
| Print values in raw units (bytes, seconds, etc.). When not set, sizes are printed in human-readable format, e.g 1KiB 234MiB 2GiB. |
| Print times in UTC. When not set, times are converted to the local time of this host. |
| Don't show column headers when printing the output |
| Show all columns in output |
weka cluster hot-spare
Get or set the number of hot-spare failure-domains in the cluster. If param is not given, the current number of hot-spare FDs will be listed
| Parameter | Description |
|---|---|
| The number of failure-domains |
| Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled') |
| Specify the host. Alternatively, use the WEKA_HOST env variable |
| Specify the port. Alternatively, use the WEKA_PORT env variable |
| Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Name of the connection and authentication profile to use |
| Skip verifying that the cluster has enough RAM and SSD resources allocated for the hot-spare |
| Show help message |
| Format output as JSON |
| Print values in raw units (bytes, seconds, etc.). When not set, sizes are printed in human-readable format, e.g 1KiB 234MiB 2GiB. |
| Print times in UTC. When not set, times are converted to the local time of this host. |
weka cluster start-io
Start IO services
| Parameter | Description |
|---|---|
| Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled') |
| Specify the host. Alternatively, use the WEKA_HOST env variable |
| Specify the port. Alternatively, use the WEKA_PORT env variable |
| Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Name of the connection and authentication profile to use |
| Show help message |
weka cluster stop-io
Stop IO services
| Parameter | Description |
|---|---|
| Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled') |
| Specify the host. Alternatively, use the WEKA_HOST env variable |
| Specify the port. Alternatively, use the WEKA_PORT env variable |
| Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Name of the connection and authentication profile to use |
| 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(S3, SMB, NFS) running |
| Force this action without further confirmation. This action will disrupt operation of all connected clients. To restore IO service run 'weka cluster start-io'. |
| Show help message |
weka cluster drive
List the cluster's drives
| Parameter | Description |
|---|---|
| A list of drive IDs or UUIDs to list. If no ID is specified, all drives are listed. |
| Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled') |
| Specify the host. Alternatively, use the WEKA_HOST env variable |
| Specify the port. Alternatively, use the WEKA_PORT env variable |
| Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Name of the connection and authentication profile to use |
| Specify in what format to output the result (format: 'view', 'csv', 'markdown', 'json' or 'oldview') |
| Only return the drives of these container IDs, if not specified, all drives are listed (may be repeated or comma-separated) |
| 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 (may be repeated or comma-separated) |
| 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: [+ |
| Specify what values to filter by in a specific column. Usage: column1=val1[,column2=val2[,..]] (may be repeated or comma-separated) |
| Show drives that were removed from the cluster |
| Show help message |
| Print values in raw units (bytes, seconds, etc.). When not set, sizes are printed in human-readable format, e.g 1KiB 234MiB 2GiB. |
| Print times in UTC. When not set, times are converted to the local time of this host. |
| Don't show column headers when printing the output |
| Show all columns in output |
weka cluster drive scan
Scan for provisioned drives on the cluster's containers
| Parameter | Description |
|---|---|
| A list of container ids to scan for drives |
| Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled') |
| Specify the host. Alternatively, use the WEKA_HOST env variable |
| Specify the port. Alternatively, use the WEKA_PORT env variable |
| Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Name of the connection and authentication profile to use |
| Show help message |
| Print values in raw units (bytes, seconds, etc.). When not set, sizes are printed in human-readable format, e.g 1KiB 234MiB 2GiB. |
| 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)
| Parameter | Description |
|---|---|
| A list of drive IDs or UUIDs to activate. If no ID is supplied, all inactive drives will be activated. |
| Specify whether to use color in output (format: 'auto', 'disabled' or 'enabled') |
| Specify the host. Alternatively, use the WEKA_HOST env variable |
| Specify the port. Alternatively, use the WEKA_PORT env variable |
| Timeout for connecting to cluster, default: 10 secs (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Timeout to wait for response, default: 1 minute (format: 3s, 2h, 4m, 1d, 1d5h, 1w, infinite/unlimited) |
| Name of the connection and authentication profile to use |
| Show help message |
| Print values in raw units (bytes, seconds, etc.). When not set, sizes are printed in human-readable format, e.g 1KiB 234MiB 2GiB. |
| 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)