SQWareProduction:db2:bin:sqwdb2 BackupDatabase.ksh
Contents
Presentation
Script $gvsqw_D2db2Bin/sqwdb2_BackupDatabase.ksh :
Generate db2Dump compressed by PIPE
Script makes purge of old generation automatically
You can also choose:
- different retention policy with -O and -T
- use different support with -TC
Online help
The online help is available for most scripts with the -h option.
Ex: $gvsqw_D2db2Bin/sqwdb2_BackupDatabase.ksh -h
Content of this assistance :
Sourcing sqwdb2_Global.lib v2024.07 SQWareProduction for Db2 (dbSQWare) ...
Usage: sqwdb2_BackupDatabase.ksh [-h] -I databasename [+ options]
DESCRIPTION
sqwdb2_BackupDatabase.ksh backup
SUPPORT
Db2 supported versions: 8.2 <= v <= 11.5
PARAMETERS
-I instance : Target instance for backup.
OPTIONS
-h : Display the full usage.
-s : Display samples of usage.
-HI nb_days : Number of days to keep (by default: 30).
-O type : online or offline (by default: online).
-T type : full or delta (by default: full).
-TC command : Tool command, 'USE TSM', 'USE XBSA', 'TO DISK' (by default: 'USE TSM').
-FRT code : Force return code value on error.
-AddMail email : Email address to add at 'pmexpdba@gmail.com'.
-SendReport : Send execution log report.
-NoMail : Deactivate sendmail on error pmexpdba@gmail.com (by default, send on error).
-NoCompress : Deactivate backup compression.
-Freeze : Freeze cluster resource when offline backup.
-Blackout : Blackout supervision when offline backup.
-Locale locale : Force Locale for help display (fr,en).
-Exec : Execute commands (by default, display generated commands).
Error management
Errors passing arguments
This type of message is generated:
Lack 'DatabaseAlias' parameter, Usage: sqwdb2_BackupDatabase.ksh [-h] -I databasename [+ options] For full help : sqwdb2_BackupDatabase.ksh -h
If you are connecting through a terminal, no mail will be sent and you will have more this kind of message:
Not sending mail because you are in connected mode !!! Lack 'DatabaseAlias' parameter ./sqwdb2_BackupDatabase.ksh[1613]: db2: not found [No such file or directory]
If you are not connected to a terminal, the error message appears and is sent by mail to the address contained in the variable $gvsqw_GlobalMail (See help customize this variable). The subject line will always start by "$gvsqw_MailMsg_db2 : " (See help customize this variable).
Execution errors
Whether you are or not connected to a terminal, the error message appears and an email containing a summary of treatment errors is sent to the address contained in the variable $gvsqw_Mail_db2 (See help customize this variable). The subject line will always start by "$gvsqw_MailMsg_db2 : " (See help customize this variable).
Usage examples
Sourcing sqwdb2_Global.lib v2024.07 SQWareProduction for Db2 (dbSQWare) ... #Standard help for script sqwdb2_BackupDatabase.ksh: $gvsqw_Db2Bin/sqwdb2_BackupDatabase.ksh -h #Display online help for this script $gvsqw_Db2Bin/sqwdb2_BackupDatabase.ksh -Locale en -h #Display online help for this script with forcing of the 'en' locale (by default locale managed by $gvsqw_Locale) $gvsqw_Db2Bin/sqwdb2_BackupDatabase.ksh -s #Display usage examples for this script $gvsqw_Db2Bin/sqwdb2_BackupDatabase.ksh -I $DB2INSTANCE #Generate commands but don't execute them ! $gvsqw_Db2Bin/sqwdb2_BackupDatabase.ksh -I $DB2INSTANCE -Exec #Generate db2Dump compressed by default $gvsqw_Db2Bin/sqwdb2_BackupDatabase.ksh -I $DB2INSTANCE -NoCompress -Exec #Execute db2Dump without compression $gvsqw_Db2Bin/sqwdb2_BackupDatabase.ksh -I $DB2INSTANCE -HI <NumberOfGenerations> -Exec #Changes the number of backup generations to keep $gvsqw_Db2Bin/sqwdb2_BackupDatabase.ksh -I $DB2INSTANCE -O <Type> -Exec #Changes the type <Type> of backup : Online or Offline (by default managed by $lvsqw_OfflineOnline) $gvsqw_Db2Bin/sqwdb2_BackupDatabase.ksh -I $DB2INSTANCE -O 'Online' -T <type> -Exec #Changes the format <type> of this 'Online' backup : Full or Delta (by default managed by $lvsqw_BackupType) $gvsqw_Db2Bin/sqwdb2_BackupDatabase.ksh -I $DB2INSTANCE -O 'Online' -T 'Full' -TC 'TO DISK' -Exec #execute a full online backup with the specified command 'TO DISK' (by default managed by '$lvsqw_ToolCommand') $gvsqw_Db2Bin/sqwdb2_BackupDatabase.ksh -I $DB2INSTANCE -O 'Offline' -Freeze -Exec #Freeze the database during an Offline backup $gvsqw_Db2Bin/sqwdb2_BackupDatabase.ksh -I $DB2INSTANCE -O 'Offline' -Blackout -Exec #Blackout supervision when offline backup $gvsqw_Db2Bin/sqwdb2_BackupDatabase.ksh -I $DB2INSTANCE -AddMail 'mymail1@mydomaine.com,mymail2@mydomaine.com' -Exec #Add the mail list to the default address managed by $gvsqw_GlobalMail (only this time), if needed separate by commas $gvsqw_Db2Bin/sqwdb2_BackupDatabase.ksh -I $DB2INSTANCE -SendReport -Exec #Send the log by email at the end of the treatment even if there is no error (by default, send on error) $gvsqw_Db2Bin/sqwdb2_BackupDatabase.ksh -I $DB2INSTANCE -NoMail -Exec #Disables sending an email on error to $gvsqw_GlobalMail (by default, send on error) $gvsqw_Db2Bin/sqwdb2_BackupDatabase.ksh -I $DB2INSTANCE -FRT <NumericValue> -Exec #Force return code to '<NumericValue>' on error (if no error, "exit 0!") #You can also force return code of this script on all your #environnement if you set the variable: $gvsqw_ForcedReturnCodeScript_sqwdb2_BackupDatabase=<NumericValue> #in configuration file $gvsqw_Db2Bin/../etc_cust/sqwdb2_GlobalVar.cfg
