501
edits
Changes
From SME Server
Jump to navigationJump to search→Job configuration properties: : Default column, new property AutoUnmount
{| border="1" cellpadding="3" cellspacing=0
{| border="1" cellpadding="3" cellspacing=0
|-
|-
| '''Property''' || '''Value''' || '''Description'''
| '''Property''' || '''Value''' || '''Default''' || '''Description'''
|-
|-
| remoteHostName
| remoteHostName
| FQHN or IP || of the source host
| FQHN or IP || || FQHN or IP of the source host (mandatory)
|-
|-
| TimeSchedule
| TimeSchedule
| HHMM,HHMM,... || doesn't need to be ordered. At least one time is mandatory
| HHMM,HHMM,... || || doesn't need to be ordered. At least one time is mandatory
|-
|-
| Description
| Description
| text string ||
| text string || ||
|-
|-
| scheduledKeep<br>dailyKeep<br>weeklyKeep<br>monthlyKeep<br>yearlyKeep
| scheduledKeep<br>dailyKeep<br>weeklyKeep<br>monthlyKeep<br>yearlyKeep
| integer >= 1 || how many of the scheduled, daily, weekly, monthly or yearly backups should be kept
| integer >= 1 || 2<br>7<br>4<br>12<br>2<br>|| how many of the scheduled, daily, weekly, monthly or yearly backups should be kept
|-
|-
| SMEServer
| SMEServer
| yes ''or'' no || when set to yes the default e-smith directories are automatically included and the property RPMCheck=yes can be used
| yes ''or'' no || yes || when set to yes the default e-smith directories are automatically included and the property RPMCheck=yes can be used
|-
|-
| Include[0]<br>Include[1]<br>...
| Include[0]<br>Include[1]<br>...
| full path || additional files or directories to include
| full path || || additional files or directories to include
|-
|-
| Exclude[0]<br>Exclude[1]<br>...
| Exclude[0]<br>Exclude[1]<br>...
| full path || additional files or directories exclude from backup
| full path || || additional files or directories exclude from backup
|-
|-
| RPMCheck
| RPMCheck
| yes ''or'' no || Only applicable to jobs that backups a SME 7 server.<br>Compares the packages installation of the source host with this affa backup host. Sends a message with diff list if not in sync. This check is usefull, if you want have the option to rise the backup server to a production server from a backup.
| yes ''or'' no || no || Only applicable to jobs that backups a SME 7 server.<br>Compares the packages installation of the source host with this affa backup host. Sends a message with diff list if not in sync. This check is usefull, if you want have the option to rise the backup server to a production server from a backup.
|-
|-
| DiskSpaceWarn
| DiskSpaceWarn
| strict ''or'' normal ''or'' risky ''or'' none || run a disk space check after a job has been completed. With level 'strict' a warning message will be sent, if the available space is less then the size of the just completed backup. With level 'normal'/'risky' the message is sent, if less than 50%/10% of the backup size is still available.
| strict ''or'' normal ''or'' risky ''or'' none || strict || run a disk space check after a job has been completed. With level 'strict' a warning message will be sent, if the available space is less then the size of the just completed backup. With level 'normal'/'risky' the message is sent, if less than 50%/10% of the backup size is still available.
|-
|-
| localNice
| localNice
| -19...+19 || run rsync local process niced.
| -19...+19 || 0 || run rsync local process niced.
|-
|-
| remoteNice
| remoteNice
| -19...+19 || run rsync process on source niced.
| -19...+19 || 0 || run rsync process on source niced.
|-
|-
| Watchdog
| Watchdog
| yes ''or'' no || Only applicable to jobs that backups a SME 7 server.<br>When a job is started, affa installs a watchdog script on the source in /etc/cron.d/, which sends a warning message, if the next scheduled job (taken from the TimeSchedule property + 10 minutes) did not run. This guarantees, that you will be notfied even in case of a affa server outage. The watchdog script send a daily reminder message, if the error continues. The next run job replaces the watchdog script with a new trigger time.
| yes ''or'' no || yes || Only applicable to jobs that backups a SME 7 server.<br>When a job is started, affa installs a watchdog script on the source in /etc/cron.d/, which sends a warning message, if the next scheduled job (taken from the TimeSchedule property + 10 minutes) did not run. This guarantees, that you will be notfied even in case of a affa server outage. The watchdog script send a daily reminder message, if the error continues. The next run job replaces the watchdog script with a new trigger time.
|-
|-
| sshPort
| sshPort
| service port || Default is 22. When sshd on the source host or your firewall listen on a non-standard port set the port here.
| service port || 22 || When sshd on the source host or your firewall listen on a non-standard port set the port here.
|-
|-
| ConnectionCheckTimeout
| ConnectionCheckTimeout
| seconds || before the rsync process is started on the remote source host, affa checks the ssh connection and exits with an error after the configured time, if the host does not respond.
| seconds || 120 || before the rsync process is started on the remote source host, affa checks the ssh connection and exits with an error after the configured time, if the host does not respond.
|-
|-
| rsyncTimeout
| rsyncTimeout
| seconds || Rsync exits, if no data is transferred for the configured time. This avoids infinitely hanging in case of a network error.
| seconds || 900 || Rsync exits, if no data is transferred for the configured time. This avoids infinitely hanging in case of a network error.
|-
|-
| rsyncCompress
| rsyncCompress
| yes ''or'' no || compress the transferred data. May be useful with slow internet connections. Increases CPU load on source and backup host.
| yes ''or'' no || no || compress the transferred data. May be useful with slow internet connections. Increases CPU load on source and backup host.
|-
|-
| EmailAddresses
| EmailAddresses
| name@domain.com,name@domain.com,... || comma separated list of mail addresses, where the messages should be sent to<br>'''Note:''' By default Affa only sends messages on errors, never on success (see property chattyOnSuccess).
| name@domain.com,name@domain.com,... || admin|| comma separated list of mail addresses, where the messages should be sent to<br>'''Note:''' By default Affa only sends messages on errors, never on success (see property chattyOnSuccess).
|-
|-
| chattyOnSuccess
| chattyOnSuccess
| integer >= 0 || when set to a value>0, Affa sends a message on a successfully completed job run and decrements the chattyOnSuccess value. When the value has reached zero, Affa falls back to the default and only sends messages on errors.
| integer >= 0 || 0 || when set to a value>0, Affa sends a message on a successfully completed job run and decrements the chattyOnSuccess value. When the value has reached zero, Affa falls back to the default and only sends messages on errors.
|-
|-
| AutomountDevice<br>AutomountPoint
| AutomountDevice<br>AutomountPoint
| full path || Device and mountpoint of backup device (e.g. USB disk). Device is automounted before a job starts and unmounted after job completion. With both properties empty no automount is done.
| full path || || Device and mountpoint of backup device (e.g. USB disk). Device is automounted before a job starts and unmounted after job completion. With both properties empty no automount is done.
|-
|-
| AutomountOptions
| AutomountOptions
| string || An option string passed to the mount command
| string || || An option string passed to the mount command
|-
| AutoUnmount
| yes ''or'' no || yes || When set to 'no' the automounted device stay mounted after the Affa run.
|-
|-
| preJobCommand<br>postJobCommand
| preJobCommand<br>postJobCommand
| full path || programs (local on the affa server) to be executed before/after a job run. The job name and type (scheduled, daily etc.) are passed as arguments to the program. The exit code is additionally passed to the post job command program. See /usr/lib/affa/ for sample perl scripts.
| full path || || programs (local on the affa server) to be executed before/after a job run. The job name and type (scheduled, daily etc.) are passed as arguments to the program. The exit code is additionally passed to the post job command program. See /usr/lib/affa/ for sample perl scripts.
|-
|-
| RootDir
| RootDir
| full path || where to store the backup archives, Do not use /home/e-smith or /root as these are included in the backup and therefore the rise option will not work! Recommended: /var/affa
| full path || /var/affa || where to store the backup archives, Do not use /home/e-smith or /root as these are included in the backup and therefore the rise option will not work! Recommended: /var/affa
|-
|-
| Debug
| Debug
| yes ''or'' no || set to yes to increase log verbosity
| yes ''or'' no || no || set to yes to increase log verbosity
|-
|-
| status
| status
| enabled ''or'' disabled || with set to disabled, no cron entries will made. You can still run a job manually.
| enabled ''or'' disabled || enabled || with set to disabled, no cron entries will made. You can still run a job manually.
|-
|-
| rsync--inplace
| rsync--inplace
| yes ''or'' no || set to no, if the rsync version on the source does not support this option (like rsync on SME6)
| yes ''or'' no || yes || set to no, if the rsync version on the source does not support this option (like rsync on SME6)
|-
|-
| rsync--modify-window
| rsync--modify-window
| integer >= 0 || When comparing two timestamps, rsync treats the timestamps as being equal if they differ by no more than the modify-window value. This is normally 0 for an exact match. A value >= 0 is useful if you can't get the clocks of the source and the Affa server in sync.
| integer >= 0 || 0 || When comparing two timestamps, rsync treats the timestamps as being equal if they differ by no more than the modify-window value. This is normally 0 for an exact match. A value >= 0 is useful if you can't get the clocks of the source and the Affa server in sync.
|-
|-
| StrictHostKeyChecking
| StrictHostKeyChecking
| yes ''or'' no || set to no to disable ssh host key check. Useful, when several servers behind a firewall should be reached over different forwarded ssh ports. Avoids the 'Offending key in...' prompt. Default setting is 'yes'.
| yes ''or'' no || yes || set to no to disable ssh host key check. Useful, when several servers behind a firewall should be reached over different forwarded ssh ports. Avoids the 'Offending key in...' prompt.
|}
|}
==== Default configuration properties ====
==== Default configuration properties ====
