NAME

dumpnet.report.conf - the host-specific dumpnet.host.report configuration file

DESCRIPTION

A dumpnet.report.conf file is used to configure the module dumpnet.host.report for a specific target host. It should be placed in a host configuration directory (a subdirectory of $DUMPNET_HOME/conf/) - see the CONFIGURATION section in dumpnet(8) for details.

The general format of this configuration file is specified in the section CONFIGURATION FILE FORMAT in dumpnet(8).

This config file primarily contains a list of commands to execute locally on the dumpnet host to generate additional information for the report. Lines starting with `#' are not part of the list. You can certainly use the ``option'' and ``extends'' statements - see the CONFIGURATION FILE FORMAT section in dumpnet(8). Options you might want to set are:

include_info

If set to ``true'', the contents of the file generated by dumpnet.host.info will be included. The default is ``false''.

include_aide

If set to ``true'', the contents of the report file generated by dumpnet.host.aide will be included. The default is ``false''.

cleanup_policy

The cleanup policy to apply for the generated reports. Please see the CLEANUP section in dumpnet(8) for details.

reportDir

The name of the sub-directory where the output files are to be stored: $backupDir/$host/$reportDir. It is recommended to go with the default configured in the default host configuration file: ``report''.

read_options

Options to be passed to the bash builtin read to read in the configuration file. In some cases you will want to use the -r option which causes the backslash not to act as an escape character. The backslash is considered to be part of the line. In particular, a backslash-newline pair may not be used as a line continuation. If read_options is not set (or set to an empty string) a backslash-newline pair can be used as a line continuation but all literal backslashes will have to be escaped.

Example:

 # option read_options="-r"

EXAMPLES

An example file could look like this:

 # option cleanup_policy="keepFor_5_months,keepWeekly"
 # option include_info=true
 # option include_aide=true
 df -h
 uptime

SEE ALSO

 dumpnet.host(8)
 dumpnet.host.report(8)

AUTHOR

 Lukas Feiler <lukas.feiler@lukasfeiler.com>

COPYRIGHT AND LICENSE

dumpnet is published under the LGPL (GNU LESSER GENERAL PUBLIC LICENSE). Please see the LICENSE file contained in the installation tarball for details. The official web site is http://dumpnet.sourceforge.net.