The s3qlctrl command¶

Synopsis¶

s3qlctrl [options] <action> <mountpoint> ...

where action may be either of flushcache, dropcache, log, cachesize or backup-metadata.

Description¶

The s3qlctrl command performs various actions on the S3QL file system mounted in mountpoint.

s3qlctrl can only be called by the user that mounted the file system and (if the file system was mounted with --allow-other or --allow-root) the root user.

Every subcommand takes the mountpoint of the file system as its first argument, plus any additional arguments described below. Individual subcommands may accept additional options; these are listed below where they exist, but you can always run s3qlctrl <subcommand> --help to see the full set of options accepted by a particular subcommand. The following subcommands are available:

flushcache¶

Write all modified blocks to the backend. The command blocks until the cache is clean:

s3qlctrl [options] flushcache <mountpoint>

dropcache¶

Flush the file system cache and then drop all contents (i.e., make the cache empty):

s3qlctrl [options] dropcache <mountpoint>

backup-metadata¶

Trigger an immediate metadata backup:

s3qlctrl [options] backup-metadata <mountpoint>

cachesize¶

Change the cache size of the file system:

s3qlctrl [options] cachesize <mountpoint> <size>

size is the new cache size in KiB.

log¶

Change the amount of information that is logged by the mounted file system:

s3qlctrl [options] log <mountpoint> <level> [<module> ...]

level is the desired new log level and may be either of debug, info or warn. One or more module may only be specified together with the debug level and restrict the debug output to just the listed modules. Specify all to enable debugging for every module.

Options¶

The s3qlctrl command also accepts the following options, no matter what specific action is being invoked:

--log <target>

Destination for log messages. Specify ‘none’ for standard output or ‘syslog’ for the system logging daemon. Anything else is interpreted as a file name. Log files are rotated when they reach 1 MiB, keeping at most 5 old files.

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

Exit Codes¶

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

Table of Contents

Previous topic

Next topic