NAME

dumpnet.conf - the golbal dumpnet configuration file

DESCRIPTION

The dumpnet.conf file is the golbal dumpnet configuration file. Its format is specified in the CONFIGURATION FILE FORMAT section in dumpnet(8). Its location is $DUMPNET_HOME/conf/dumpnet.conf. It primarily contains a list of the configuration files of the target hosts to backup.

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

The items of this list must not start with a `#' sign. dumpnet will call dumpnet.host for every host configuration file in the list (in the order specified). To do a simultaneous backup of multiple target hosts the `&' sign can be used. If the target host configuration file is followed by a `&' sign, dumpnet.host will be executed in the background.

In the following example we will simultaneously backup the web-servers of the law and the computer science faculty of our example university. But the simultanious backup of the FTP-servers will not start until the backup of www.cs.example.com is finished. Here we would want to make sure that the backup of www.law.example.com is faster than the one of www.cs.example.com or www.law.example.com and ftp.law.example.com would get backuped at the same time.

 $DUMPNET_HOME/conf/www.law.example.com/dumpnet.HOST.conf &
 $DUMPNET_HOME/conf/www.cs.example.com/dumpnet.HOST.conf
 $DUMPNET_HOME/conf/ftp.law.example.com/dumpnet.HOST.conf &
 $DUMPNET_HOME/conf/ftp.cs.example.com/dumpnet.HOST.conf

Therefore think twice before you use simultaneous backup. Make sure you have the resources - bandwidth and machine power on the dumpnet host - available. You may want to use different routes to your target hosts. If configured uncarefully you could certainly use dumpnet to produce a network DOS condition.

Furthermore the following options must be set using multiple ``# option ...'' statements - see the section CONFIGURATION FILE FORMAT in dumpnet(8) for details on the option statement.

backupDir

The root directory where all backups will be stored (without a trailing slash). Per default it is set to ``/backup''.

recycleBin

If non-empty, cleaned up files will not be deleted but moved to the recycle bin directory you specify. If you set this option to ``/recycle'' a file such as /backup/192.168.1.10/usr/SID10031_20050202232941_lev0 would get moved to /recycle/192.168.1.10/usr/. Using a recylce bin puts more burdon on the backup operator but allows you to double check that nothing is deleted you still need. Per default recycleBin is set to an empty string which means that cleaned up files will be deleted.

default_host_config

The location of the default target host configuration file. This file will always be included before the actual host configuration file. Per default it is set to ``$DUMPNET_HOME/conf/_defaults/dumpnet.HOST.conf''.

logfile_sessionId

The location of the Session ID log file. It will simply contain the last used SID on one line. Per default it is set to ``$DUMPNET_HOME/log/sessionId.log''.

cmd_dates_file

The location of the command dates file. Per default it is set to ``$DUMPNET_HOME/dumpnet.cmddates''. Please see dumpnet.cmddates(8) for details.

logfile_dump

The location of the standard log file (only SUCC and ERRO). Per default it is set to ``$DUMPNET_HOME/log/standard.log''.

ext_logfile_dump

The location of the extended log file (SUCC, ERRO, WARN and INFO). Per default it is set to ``$DUMPNET_HOME/log/extended.log''.

local_restore

The location of the restore executable on the local machine. You could use just ``restore'' if it is in your path but per default it is set to ``/sbin/restore''. Please note that the version of restore available on Linux can read a dump created under OpenBSD and vice versa.

local_grep

The location of the grep executable on the local machine that does support the -f option to specify a file of patterns. The default is ``grep''.

local_aide

The location of the aide executable on the local machine. You could use just ``aide'' if it is in your path. The default is ``aide''.

local_sudo

The location of the sudo executable on the local machine. You could use just ``sudo'' if it is in your path. The default is ``sudo''. To actually allow the dumpnet user to use sudo on the dumpnet host, you will have so setup the /etc/sudoers file to allow the dumpnet user to use sudo without being prompted for a password. Please see sudoers(5).

For now only dumpnet.host.fstab.rsync(8) is using the $local_sudo option.

local_rsync

The location of the rsync executable on the local machine. You could use just ``rsync'' if it is in your path. The default is ``rsync''.

local_gnu_date

The location of the GNU version of the date executable on the local machine. On Linux and Cygwin this will be just ``date''. On OpenBSD the GNU version of date is not installed by default. You will have to install the sh-utils package. For a i386 architecture on OpenBSD 3.6 sh-utils-2.0 could be installed by running

 # pkg_add ftp://ftp.openbsd.org/pub/OpenBSD/3.6/packages/i386/sh-utils-2.0.tgz

as root. The GNU version of date will be installed as gdate. So on OpenBSD you will have to set local_gnu_date to ``gdate''.

local_gnu_find

The location of the GNU version of the find executable on the local machine. On Linux and Cygwin this will be just ``find''. On OpenBSD the GNU version of find is not installed by default. You will have to install the findutils package. For a i386 architecture on OpenBSD 3.6 findutils-4.1 could be installed by running

 # pkg_add ftp://ftp.openbsd.org/pub/OpenBSD/3.6/packages/i386/findutils-4.1.tgz

as root. The GNU version of find will be installed as gfind. So on OpenBSD you will have to set local_gnu_find to ``gfind''.

local_gnu_md5sum

The location of the GNU version of the md5sum executable on the local machine. On Linux and Cygwin this will be just ``md5sum''. On OpenBSD the GNU version of md5sum is not installed by default. You will have to install the textutils package. For a i386 architecture on OpenBSD 3.6 textutils-2.0 could be installed by running

 # pkg_add ftp://ftp.openbsd.org/pub/OpenBSD/3.6/packages/i386/textutils-2.0.tgz

as root. The GNU version of md5sum will be installed as gmd5sum. So on OpenBSD you will have to set local_gnu_md5sum to ``gmd5sum''.

read_options

Options to be passed to the bash builtin read to read in the configuration files. 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. This option can be overwritten in any of the configuration files.

The variable DUMPNET_HOME also defined in dumpnet.conf by default, is only used within dumpnet.conf.

EXAMPLES

A sample configuration file could look like this - remember that the `#' sign must be the first character on all lines that are not part of the list:

 # option DUMPNET_HOME=`(cd $(dirname $0)/../; pwd)`
 # option backupDir="/backup"
 # option default_host_config=$DUMPNET_HOME/conf/_defaults/dumpnet.HOST.conf
 # option cmd_dates_file=$DUMPNET_HOME/log/dumpnet.cmddates
 # option logfile_dump=$DUMPNET_HOME/log/standard.log
 # option ext_logfile_dump=$DUMPNET_HOME/log/extended.log
 # option logfile_sessionId=$DUMPNET_HOME/log/sessionId.log
 # option local_restore="/sbin/restore"
 # option local_aide="aide"

 $DUMPNET_HOME/conf/www.example.com/dumpnet.HOST.conf
 $DUMPNET_HOME/conf/db.example.com/dumpnet.HOST.conf

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.

NAME

DESCRIPTION

EXAMPLES

SEE ALSO

AUTHOR

COPYRIGHT AND LICENSE