configsnap man page

configsnap — manual page for configsnap 0.14


configsnap [options]


Record useful system state information, and compare to previous state if run with PHASE containing "post" or "rollback".


-h, --help

show this help message and exit

-w, --overwrite

if phase files already exist in tag dir, remove previously collected data with that tag

-a, --archive

pack output files into a tar archive

-v, --verbose

print debug info

-V, --version

print version

-s, --silent

no output to stdout


Force a comparison after collecting data

-t TAG, --tag=TAG

tag identifer (e.g. a ticket number)

-d BASEDIR, --basedir=BASEDIR

base directory to store output

-p PHASE, --phase=PHASE

phase this is being used for. Can be any string. Phases containing  post  or  rollback  will perform diffs

-C, --compare-only

Compare existing files with tags specified with --pre and --phase


suffix for files captured at previous state, for comparison

Custom Collection

Commands are all run as root, so the custom collection configuration file must be owned by root and not read or writable by other users. The file format is:

 [section] - The name of the output file, and the status message for this collection
Type - "command", to run a command, or "file" to save a file
Command - When Type = command, the fully qualified command to run, e.g. /bin/ss -tanp
File - The fully qualified path to a file to save, e.g. /etc/debconf.conf

For "command", there is the following additional optional setting:
Sort - save output sorted (default: False)

For either "command" or "file", the are the follow additional optional settings:
Failok - True/False - Whether to report problems running the command or copying the file (default: False)
Compare - True/False - Whether to compare output when phase contains post or rollback (default: False)


Type: command
Command: /bin/ps -aux
Compare: True

Type: file
File: /etc/debconf.conf
Failok: True

These would record two files per run, psspecial.phase and debconf.conf.phase.


 Optional configuration file to define additional command output and files to collect.


July 2018 configsnap 0.14 User Commands