Changes

From SME Server
Jump to navigationJump to search

Affa (view source)

Revision as of 14:05, 26 October 2014

1,182 bytes added ,  14:05, 26 October 2014
Further rework to move instructions towards Affa 3.
Line 270: Line 270:  
<li>The functions “--rise” and “--undo-rise”</li>
 
<li>The functions “--rise” and “--undo-rise”</li>
 
</ul>
 
</ul>
−
Consequently the list below should reproduce the list for the unforked Affa 3 version, plus the additional properties above. For details refer to [http://www.guedel.eu/index.php/info-matique/sme-server/affa-v3/ stephdl's website].
+
Consequently the list below should reproduce the list for the unforked Affa 3 version, plus adding the properties above. For details refer to [http://www.guedel.eu/index.php/info-matique/sme-server/affa-v3/ stephdl's website].
 
{| border="1" cellpadding="3" cellspacing=0
 
{| border="1" cellpadding="3" cellspacing=0
 
|-
 
|-
Line 278: Line 278:  
| FQHN or IP
 
| FQHN or IP
 
| no
 
| no
−
| none
+
| <none>
 
| FQHN or IP of the source host (mandatory)
 
| FQHN or IP of the source host (mandatory)
 
|-
 
|-
Line 290: Line 290:  
| text string
 
| text string
 
| no
 
| no
−
| none
+
| <none>
 
| Any text that describes the job
 
| Any text that describes the job
 
|-
 
|-
Line 308: Line 308:  
| full path
 
| full path
 
| yes
 
| yes
−
| none
+
| <none>
 
| File(s) or directory(s) to be included in the backup.  
 
| File(s) or directory(s) to be included in the backup.  
 
|-
 
|-
Line 314: Line 314:  
| full path
 
| full path
 
| yes
 
| yes
−
| none
+
| <none>
 
| File(s) or directory(s) to be excluded from the backup.  
 
| File(s) or directory(s) to be excluded from the backup.  
 
|-
 
|-
Line 395: Line 395:  
| User who has permission to access the job archives via the CIFS protocol.
 
| User who has permission to access the job archives via the CIFS protocol.
 
|-
 
|-
−
| preJobCommand, preJobCommandRemote
+
| preJobCommand<br> preJobCommandRemote
 
| path relative to /etc/affa/scripts/
 
| path relative to /etc/affa/scripts/
 
| yes
 
| yes
−
| none
+
| <none>
 
| Scripts to be executed before a job run. The job name and type (scheduled, daily etc.) are passed as arguments to the program. The preJobCommandRemote scripts are copied to the remote server and then executed there. The scripts are executed in alphabetical order. Use a numerical prefix if you need a specific order e.g. 01scriptB, 02remotescriptA, 03scriptA. Use the included prescript-sample.pl and prescriptRemote-sample.pl as a starting point for own scripts.
 
| Scripts to be executed before a job run. The job name and type (scheduled, daily etc.) are passed as arguments to the program. The preJobCommandRemote scripts are copied to the remote server and then executed there. The scripts are executed in alphabetical order. Use a numerical prefix if you need a specific order e.g. 01scriptB, 02remotescriptA, 03scriptA. Use the included prescript-sample.pl and prescriptRemote-sample.pl as a starting point for own scripts.
 
|-
 
|-
−
| postJobCommand, postJobCommandRemote
+
| postJobCommand<br> postJobCommandRemote
 
| path relative to /etc/affa/scripts/
 
| path relative to /etc/affa/scripts/
 
| yes
 
| yes
−
| none
+
| <none>
 
| Scripts to be executed after a job run. The job name, the type (scheduled, daily etc.) and the exit code of the job run are passed as arguments to the program. The postJobCommandRemote scripts are copied to the remote server and then executed there. The scripts are executed in alphabetical order. Use a numerical prefix if you need a specific order e.g. 01scriptB, 02remotescriptA, 03scriptA. Use the included postscript-sample.pl and postscriptRemote-sample.pl as a starting point for own scripts.
 
| Scripts to be executed after a job run. The job name, the type (scheduled, daily etc.) and the exit code of the job run are passed as arguments to the program. The postJobCommandRemote scripts are copied to the remote server and then executed there. The scripts are executed in alphabetical order. Use a numerical prefix if you need a specific order e.g. 01scriptB, 02remotescriptA, 03scriptA. Use the included postscript-sample.pl and postscriptRemote-sample.pl as a starting point for own scripts.
 
|-
 
|-
Line 465: Line 465:  
| string
 
| string
 
| no
 
| no
−
| none
+
| <none>
 
| Additional option string to be passed to rsync
 
| Additional option string to be passed to rsync
 
|-
 
|-
Line 479: Line 479:  
| 0
 
| 0
 
| run rsync process on source niced.  
 
| run rsync process on source niced.  
−
  −
   
|-
 
|-
−
| SMEServer
+
| killAt
−
| yes ''or'' no || yes || when set to yes the default e-smith directories are automatically included and the property RPMCheck=yes can be used
+
| HHMM
−
 
+
| no
 +
| <none>
 +
| The time at which a job will be killed if it was still running. You can use it for example to kill jobs that are running over the internet early in the morning so that your users have the full bandwidth available during office hours.
 
|-
 
|-
−
| RPMCheck
+
| resumeKilledAt
−
| 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.
+
| HHMM
−
|-
+
| no
−
| DiskSpaceWarn
+
| <none>
−
| 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.
+
| The time at which a killed job will be resumed. This allows you to start earlier in the evening than the scheduled time.
−
'''Note:''' When RootDir is a symbolic link to another filesystem the disk usage of the local filesystem rather than the linked filesystem is checked. Set the mountpoint as the RootDir to get correct checking.
  −
 
  −
|-
  −
| Watchdog
  −
| 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.
  −
 
  −
 
   
|-
 
|-
 
| chattyOnSuccess
 
| chattyOnSuccess
−
| 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.
+
| integer >= 0
 +
| no
 +
| 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. Both properties must be set to have automount function working.
+
| full path
 +
| no
 +
| <none>
 +
| 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
 +
| no
 +
| <none>
 +
| An option string passed to the mount command.
 
|-
 
|-
 
| AutoUnmount  
 
| AutoUnmount  
−
| yes ''or'' no || yes || When set to 'no' the automounted device stay mounted after the Affa run.
+
| yes ''or'' no
 +
| no
 +
| yes
 +
| When set to 'no' the automounted device stay mounted after the Affa run.
 
|-
 
|-
 
| Debug  
 
| Debug  
−
| yes ''or'' no || no || set to yes to increase log verbosity
+
| yes ''or'' no
 +
| no
 +
| no
 +
| Set to yes to increase log verbosity.
 +
|-
 +
| remoteRsyncBinary
 +
| full path
 +
| no
 +
| /usr/bin/rsync
 +
| If the rsync program on the remote server is located in non-standard location, set it here
 +
|-
 +
| remoteNiceBinary
 +
| full path
 +
| no
 +
| /bin/nice
 +
| If the nice program on the remote server is located in non-standard location, set it here.
 +
|-
 +
| localRsyncBinary
 +
| full path
 +
| no
 +
| /usr/bin/rsync
 +
| If the local rsync program is located in non-standard location, set it here
 
|-
 
|-
−
| status
+
| localNiceBinary
−
| enabled ''or'' disabled || enabled || with set to disabled, no cron entries will made. You can still run a job manually.
+
| full path
−
 
+
| no
 +
| /bin/nice
 +
| If the nice local program is located in non-standard location, set it here.
 +
|-
 +
| RemoteAuthorizedKeysFile
 +
| path relative to remote user's home or full path
 +
| no
 +
| .ssh/authorized_keys2
 +
| If the remote host stores the authorized keys file in a non-standard location, set it here.
 
|-
 
|-
 
| rsyncdMode
 
| rsyncdMode
−
| yes ''or'' no || no || set to yes to connect to the rsync daemon on the remote host (instead of running rsync over ssh)
+
| yes ''or'' no
 +
| no
 +
| no
 +
| Set to yes to connect to the rsync daemon on the remote host (instead of running rsync over ssh).
 
|-
 
|-
 
| rsyncdModule
 
| rsyncdModule
−
| string || AFFA || the rsyncd module name (only applicable with rsyncdMode=yes)
+
| string
 +
| no
 +
| AFFA
 +
| The rsyncd module name (only applicable with rsyncdMode=yes).
 
|-
 
|-
 
| rsyncdUser
 
| rsyncdUser
−
| string || affa || the username for authentication to the rsync daemon (only applicable with rsyncdMode=yes)
+
| string
 +
| no
 +
| affa
 +
| The username for authentication to the rsync daemon (only applicable with rsyncdMode=yes).
 
|-
 
|-
 
| rsyncdPassword
 
| rsyncdPassword
−
| string || || the password for authentication to the rsync daemon (only applicable with rsyncdMode=yes)
+
| string
 +
| no
 +
| <none>
 +
| The password for authentication to the rsync daemon (only applicable with rsyncdMode=yes).
 +
 
 
|-
 
|-
−
| chunkFiles
+
| globalStatus
−
| string || || Filenames that Affa should chunk and compress. Multiple file names are to be separated by the slash (/) character, e.g. 'mysql.dump/pgsql.dump' chunks the two files mysql.dump and pgsql.dump. With ESXi=yes it is implicitly set to '*.vmdk'. See also command line options --chunk-archive and --unchunk-archive
+
| enabled ''or'' disabled ''or'' jobs
−
|}
+
| no
 +
| jobs
 +
| Set to enabled or disabled to overide the status settings in all job sections. When set to value jobs, the status settings in the job sections are effictive.<br>''Note:'' This property is allowed only in the [GlobalAffaConfig] section.
 +
|-
 +
| sendStatus
 +
| daily ''or'' weekly ''or'' monthly ''or'' never
 +
| no
 +
| weekly
 +
| Defines how frequently the status will be sent.<br>''Note:'' This property is allowed only in the [GlobalAffaConfig] section.
 +
|-
 +
| SMEServer
 +
| yes ''or'' no
 +
| no
 +
| no
 +
| When set to yes, the default e-smith directories are automatically included and the property RPMCheck=yes can be used.<br>''Note:'' this property is not implemented in Affa 3 for CentOS. It has been specifically added to the fork for SME.
 +
|-
 +
| RPMCheck
 +
| yes ''or'' no
 +
| no
 +
| no
 +
| Only applicable to jobs that backup a SME server. 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 useful, if you want have the option to rise the backup server to a production server from a backup.<br>''Note:'' this property is not implemented in Affa 3 for CentOS. It has been specifically added to the fork for SME.
 +
|-
 +
| Watchdog
 +
| yes ''or'' no
 +
| no
 +
| yes
 +
| Only applicable to jobs that backups a SME server. 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.<br>''Note:'' this property is not implemented in Affa 3 for CentOS. It has been specifically added to the fork for SME.
 +
}
    
==== Default configuration properties ====
 
==== Default configuration properties ====
−
All properties can be set as defaults in a configuration file in the [GlobalAffaConfig] section. This is useful, when you set up many similar jobs.  
+
For all 'name=value' properties defaults can be set in the [GlobalAffaConfig] section which are used in all job configuration when the corresponding property is omitted. For example, when these properties are set in [GlobalAffaConfig] section, they can be omitted in the specific job configurations. This is useful, when you set up many similar jobs.  
    
Example: You want to set the property 'localNice' to 19 for all jobs. Then add the following section in one of your configuration files:
 
Example: You want to set the property 'localNice' to 19 for all jobs. Then add the following section in one of your configuration files:
Line 542: Line 616:  
Consequently you don't need to set this property for your indiviual jobs. Properties set in the job record override the defaults.
 
Consequently you don't need to set this property for your indiviual jobs. Properties set in the job record override the defaults.
   −
The special properties 'sendStatus' and 'globalStatus' are only applicable to the GlobalAffaConfig section. 'sendStatus' controls the status report sent by email and can be set to the values 'never', 'daily', 'weekly' or 'monthly'.
+
==== Properties for global Settings ====
 +
The following special properties are only applicable to the [GlobalAffaConfig] section:
 +
<ul>
 +
<li>sendStatus</li>
 +
<li>globalStatus</li>
 +
</ul>
   −
==== Global enable / disable ====
   
All jobs can be disabled for execution through 'cronjobs" with setting 'globalStatus' to 'disabled'.
 
All jobs can be disabled for execution through 'cronjobs" with setting 'globalStatus' to 'disabled'.
 
  [GlobalAffaConfig]
 
  [GlobalAffaConfig]
Turandot
28

edits

Retrieved from "https://wiki.koozali.org/Special:MobileDiff/25836"

Navigation menu