The s3qladm command¶

Synopsis¶

s3qladm [options] <action> <storage url>

where action may be either of passphrase, recover-key, clear, shrink-db, upgrade or restore-metadata.

Description¶

The s3qladm command performs various operations on unmounted S3QL file systems. The file system must not be mounted when using s3qladm or things will go wrong badly.

The storage url depends on the backend that is used. The S3QL User’s Guide should be consulted for a description of the available backends.

Options¶

The s3qladm command accepts the following options.

--authfile <path>

Read authentication credentials from this file (default: /home/nikratio/.s3ql/authinfo2).

--backend-options <options>

Backend specific options (separate by commas). See backend documentation for available options.

--cachedir <path>

Store cached data in this directory (default: /home/nikratio/.s3ql).

--max-connections <no>

Maximum number of concurrent backend I/O operations (default: 32). This is independent of –max-threads, which governs compression.

--max-threads <no>

Number of parallel compression/encryption threads to use (default: auto). This bounds CPU parallelism only and is independent of –max- connections.

--debug

Activate debugging output from all S3QL modules. Debug messages are written to the destination given by –log.

--debug-modules <module>

Activate debugging output from the named module. May be given multiple times; use ‘all’ for everything. Debug messages are written to the destination given by –log.

--quiet

be really quiet

--install-completion

Install completion for the current shell.

--show-completion

Show completion for the current shell, to copy it or customize the installation.

--help

Show this message and exit.

Actions¶

The following actions may be specified. Every action takes the storage url of the file system as its argument. Individual actions may accept additional options; these are listed below where they exist, but you can always run s3qladm <action> --help to see the full set of options accepted by a particular action. Please consult the S3QL User’s Guide for more detailed information.

passphrase¶

Change the encryption passphrase of the file system.

recover-key¶

Recover the master encryption key from an external backup.

clear¶

Delete the file system with all the stored data.

shrink-db¶

Recover unused space in the metadata database.

upgrade¶

Upgrade the file system to the newest revision. This action accepts the following option:

--metadata-block-size <size>

Block size (in KiB) to use for storing filesystem metadata. Backend object size may be smaller than this due to compression. [default: 64]

restore-metadata¶

Interactively restore backups of the file system metadata.

Exit Codes¶

s3qladm may terminate with the following exit codes:

0:: Everything went well.
1:: An unexpected error occurred. This may indicate a bug in the program.
2:: Invalid command line argument or configuration file key.

3:: Invalid backend option.
10:: Could not open log file for writing.
12:: Authentication file has insecure permissions.
13:: Unable to parse proxy settings.
14:: Invalid credentials (Authentication failed).
15:: No permission to access backend (Authorization denied).
16:: Invalid storage URL, specified location does not exist in backend.
17:: Wrong file system passphrase.
18:: No S3QL file system found at given storage URL.
19:: Unable to connect to backend, can’t resolve hostname.
45:: Unable to access cache directory.

Table of Contents

Previous topic

Next topic