NAME

dumpnet.HOST.conf - the target host configuration file

DESCRIPTION

A dumpnet.HOST.conf file is used to configure a remote host that should be backuped (referred to as a ``target host''). Its general format is specified in the CONFIGURATION FILE FORMAT section in dumpnet(8). It should be placed in a host configuration directory (a subdirectory of $DUMPNET_HOME/conf/) - see the CONFIGURATION section in dumpnet(8) for details.

A rudimentary check of the configuration file can be done using dumpnet.checkHostConfig(8).

The default host configuration file is always included right before the actual host configuration file. It is stored at $DUMPNET_HOME/conf/_defaults/dumpnet.HOST.conf.

dumpnet.HOST.conf primarily contains a list of modules to call for this target host. Every line not starting with a `#' sign is considered part of this list. The available modules are:

 - dumpnet.host.fstab
 - dumpnet.host.userdefined
 - dumpnet.host.diff
 - dumpnet.host.info
 - dumpnet.host.aide
 - dumpnet.host.report
 - dumpnet.host.reportmail

Optionally the module name can be followed by a configuration file for that module. The path to the configuration file is relative to the target host configuration directory (the directory that contains the dumpnet.HOST.conf file for this target host). If no configuration file is explicitly specified the defaults will be used. They can be configured using the *_conf options (see below for details).

dumpnet.host will call the module in the order listed. Therefore make sure the last two modules are dumpnet.host.report and dumpnet.host.reportmail. You can use the same module multiple times with different configuration files. For example if you wanted to backup one set of filesystems before running dumpnet.host.userdefined and another set afterwords you could do the following configuration:

 dumpnet.host.fstab dumpnet.fstab1.conf
 dumpnet.host.userdefined
 dumpnet.host.fstab dumpnet.fstab2.conf 
 dumpnet.host.info
 dumpnet.host.aide
 dumpnet.host.report
 dumpnet.host.reportmail

The following options can be set in dumpnet.HOST.conf using the ``# options'' statement - see the section CONFIGURATION FILE FORMAT in dumpnet(8) for details. All of them are set in the default host configuration file but can be overwritten:

host

The IP address or host name of the target host. By default this is an empty string which will cause the name of the target host configuration directory to be used as the host name. This works as long as you follow the convention of using the host name for the target host configuration directory.

oslogin

The login to use when connecting to the target host via SSH using public key authentication. The public key of the user running dumpnet on the dumpnet host must be placed in ~/.ssh/authorized_keys on the target host. As root privileges are required in most cases oslogin is set to ``root'' per default. Even tough ``root'' is the default it is recommended to use an unpriviliged user to log into the target host and then run all commands using sudo - please see the dosudo and sudo options below.

dosudo

If set to ``true'' all commands run on the target host will be executed using sudo. By default this option is not set at all which is equal to setting it to ``false''. This option can be overwritten in dumpnet.fstab.conf, dumpnet.userdefined.conf, dumpnet.aide.conf, dumpnet.diff.conf and dumpnet.info.conf.

infoDir

The name of the directory used by dumpnet.host.info. Think of it as $backupDir/$host/$infoDir. See dumpnet.conf(8) for $backupDir and the STORAGE section of dumpnet(8) for a general discription of the backup directory layout. Per default infoDir is set to ``info''. It also is possible to set this variable in dumpnet.info.conf(8) with an option statement.

aideDir

The name of the directory used by dumpnet.host.aide. Think of it as $backupDir/$host/$aideDir. See dumpnet.conf(8) for $backupDir and the STORAGE section of dumpnet(8) for a general discription of the backup directory layout. Per default aideDir is set to ``aide''. It also is possible to set this variable in dumpnet.aide.conf(8) with an option statement.

reportDir

The name of the directory used by dumpnet.host.report. Think of it as $backupDir/$host/$reportDir. See dumpnet.conf(8) for $backupDir and the STORAGE section of dumpnet(8) for a general discription of the backup directory layout. Per default reportDir is set to ``report''. It also is possible to set this variable in dumpnet.report.conf(8) with an option statement.

dump

The location of the dump executable on the target host. Per default it is set to ``dump'' to get you started more easyly. It is recommended to use an absolute path if possible.

aide

The location of the aide executable on the target host. This must be an absolute path as dumpnet.host.aide will copy the file to the dumpnet host and check its md5sum. Per default it is set to ``/usr/bin/aide''. If possible, place the executable on a valume with a physical write protection (like a CD-R). It also is possible to set this variable in dumpnet.aide.conf(8) with an option statement.

sudo

The location of the sudo executable on the target host. By default this option is just set to ``sudo''.

rsync

The location of the rsync executable on the target host. By default this option is just set to ``rsync''.

gnu_tar

The location of the GNU version of the tar executable on the target host. On Linux and Cygwin this will be just ``tar''. On OpenBSD the GNU version of tar is not installed by default. Please see the INSTALL file for more information on how to install gtar on OpenBSD or on other Unix OSs.

gzip

The location of the gzip executable on the target host. By default this option is just set to ``gzip''.

bash

The location of the bash executable on the target host. By default this option is just set to ``bash''.

gnu_date

The location of the GNU version of the date executable on the target host. By default this option is just set to ``date''.

dump_args

With this option you can specify with which options dump should be called. dump's -T option is used so that we do not depend on the target host's /etc/dumpdates. The default target host configuration file contains the following:

 # option dump_args='-T \"$dump_date_format\" -f - $mount_point'

This perfectly works for Linux and OpenBSD. FreeBSD allows you to take a snapshot in <fs_root>/.snap/ and dump that which is more consistent. Therefore it is recommended to change the dump_args option within a FreeBSD target host configuration file to:

 # option dump_args='-LT \"$dump_date_format\" -f - $mount_point'

dump_date_format

The format of the date that is used with dump's -T option. This can be one of the date format variables documented in dumpnet.userdefined.conf. Per default dump_date_format is set to '$lastLevDateDumpFormat' which works for the dump version used by Linux. When doing a backup of a OpenBSD target host, you will have to set dump_date_format to '$lastLevDateBSDDumpFormat'. The difference is the missing timezone specification in $lastLevDateBSDDumpFormat. Please see dumpnet.userdefined.conf for details about the exact date formats.

aide_modification_loglevel

dumpnet.host.aide will check if the compared aide databases differ. If they don't this will be logged using the log level info. If they do differ it will be logged using the log level specified in aide_modification_loglevel. Default is ``warn''. Possible values are:

info: The fact that the databases differ will be logged using the level info (INFO).
warn: The fact that the databases differ will be logged using the level warn (WARN).
error: The fact that the databases differ will be logged using the level error (ERRO). dumpnet.host.aide will exit with the 1 after logging the error.

rsyncPreserveOwnerAndDevices

This option applies only to dumpnet.host.fstab.rsync(8). If set to ``true'' dumpnet.host.fstab.rsync will run rsync as root on the dumpnet host to preserve owner and devices (rsync options -o and -D implied by option -a). sudo will be used to gain root previleges (please see the $local_sudo option in dumpnet.conf(8)).

rsync is always called with the -a option which implies the options -D (preserve devices) and -o (preserve ownership). But devices and ownership will actually only be preserved if rsync is run with root previleges on the dumpnet host. The result would be a directory tree exectly as on the target host. This means that the dumpnet user would eventually not be able to read files contained in the backup directory. To be able to use the restore mode it is recommended to create a TOC-file. Because the contents of the backup directory will be read with root previleges if necessary and stored in the TOC-file owned by the dumpnet user. Because of these complications the default is not to run rsync with root previleges on the dumpnet host which results in all files being owned by the dumpnet user. If rsync is run as root sudo will be used - please see the $sudo option in dumpnet.HOST.conf(8). For some more information please see the -n option of dumpnet.host.fstab.rsync(8).

The following variables are set in the default host configuration file and should not be overwritten if there is no good reason. They name the configuration files for the dumpnet.host.* modules. All locations are relative to the actual host configuration file (not the default host configuration file). Please note: if you want multiple target hosts to use the same configuration files use the ``extends'' statement and leave the configuration file locations as they are. See the section CONFIGURATION FILE FORMAT in dumpnet(8) for details.

fstab_conf: The location of the configuration file for dumpnet.host.fstab. The default is ``dumpnet.fstab.conf''
userdefined_conf: The location of the configuration file for dumpnet.host.userdefined. The default is ``dumpnet.userdefined.conf''
diff_conf: The location of the configuration file for dumpnet.host.diff. The default is ``dumpnet.diff.conf''
info_conf: The location of the configuration file for dumpnet.host.info. The default is ``dumpnet.info.conf''
aide_conf: The location of the configuration file for dumpnet.host.aide. The default is ``dumpnet.aide.conf''
report_conf: The location of the configuration file for dumpnet.host.report. The default is ``dumpnet.report.conf''
reportmail_conf: The location of the configuration file for dumpnet.host.reportmail. The default is ``dumpnet.reportmail.conf''

EXAMPLES

A default host configuration file could look like this:

 # option host=""
 # option oslogin="root"
 # option infoDir="info"
 # option aideDir="aide"
 # option reportDir="report"
 # option dump="dump"
 # option aide="/usr/bin/aide"
 # option fstab_conf="dumpnet.fstab.conf"
 # option userdefined_conf="dumpnet.userdefined.conf"
 # option diff_conf="dumpnet.diff.conf"
 # option info_conf="dumpnet.info.conf"
 # option aide_conf="dumpnet.aide.conf"
 # option report_conf="dumpnet.report.conf"
 # option reportmail_conf="dumpnet.reportmail.conf"

A sample target host configuration file:

 # option host="example.com"
 # option dump="/usr/sbin/dump"
 # option aide="/usr/sbin/aide"
 dumpnet.host.fstab
 dumpnet.host.userdefined
 dumpnet.host.diff
 dumpnet.host.diff dumpnet.diff_local.conf
 dumpnet.host.info
 dumpnet.host.aide
 dumpnet.host.report
 dumpnet.host.reportmail

Here we use dumpnet.host.diff twice - the second time with the config file dumpnet.diff_local.conf. In that config file we could set runLocally to ``true'' and run nmap to make sure we notice if a new port gets opened - see dumpnet.host.diff(8) for details.

FILES

 $DUMPNET_HOME/conf/_defaults/dumpnet.HOST.conf
 $DUMPNET_HOME/conf/$host/dumpnet.HOST.conf

AUTHOR

 Lukas Feiler <lukas.feiler@lukasfeiler.com>

COPYRIGHT AND LICENSE