SQWareProduction:oracle:bin:sqwora PhysicalColdBackup.ksh

Presentation

Script $gvsqw_OraBin/sqwora_PhysicalColdBackup.ksh :

execute physical cold backup (gzip)

Online help

The online help is available for most scripts with the -h option.
Ex: $gvsqw_OraBin/sqwora_PhysicalColdBackup.ksh -h
Content of this assistance :

Sourcing sqwora_Global.lib v2024.02 SQWareProduction for Oracle (dbSQWare) ... 

Usage: sqwora_PhysicalColdBackup.ksh [-h] -I <instance> [+ options]

DESCRIPTION
   sqwora_PhysicalColdBackup.ksh execute physical cold backup (gzip)
SUPPORT
   Oracle supported versions: 9iR2 <= v <= 21c

PARAMETERS
     -I  instance       : Target instance to backup.
OPTIONS
     -h                 : Display the full usage.
     -s                 : Display samples of usage.
     -FRT return_code   : Force return code value on error.
     -P       Nb threads: Number of threads for gzip (by default 2).
     -HI      nb_gen    : Number of generations to keep (by default: 1).
     -AddMail   email   : Email address to add at 'pmexpdba@gmail.com'.
     -SendReport        : Send execution log report.
     -Freeze            : Freeze cluster resource when cold backup.
     -Blackout          : Blackout supervision when cold backup.
     -NoMail            : Deactivate sendmail on error to pmexpdba@gmail.com (by default, send on error).
     -Locale    locale  : Force Locale for help display (fr,en).
     -Exec              : Run backup (by default, display generated commands)

Error management

Errors passing arguments

This type of message is generated:

Lack instance parameter, Usage: sqwora_PhysicalColdBackup.ksh [-h] -I <instance> [+ options]
For full help : sqwora_PhysicalColdBackup.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 instance parameter

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_oracle : " (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_oracle (See help customize this variable). The subject line will always start by "$gvsqw_MailMsg_oracle : " (See help customize this variable).

Usage examples

Sourcing sqwora_Global.lib v2024.02 SQWareProduction for Oracle (dbSQWare) ... 

#Standard help for script sqwora_PhysicalColdBackup.ksh:

$gvsqw_OraBin/sqwora_PhysicalColdBackup.ksh -h
#Display online help for this script

$gvsqw_OraBin/sqwora_PhysicalColdBackup.ksh -Locale en -h
#Display online help for this script with forcing of the 'en' locale (by default locale managed by $gvsqw_Locale)

$gvsqw_OraBin/sqwora_PhysicalColdBackup.ksh -s
#Display usage examples for this script

$gvsqw_OraBin/sqwora_PhysicalColdBackup.ksh -I $ORACLE_SID
#Generate commands but don't execute them !

$gvsqw_OraBin/sqwora_PhysicalColdBackup.ksh -I $ORACLE_SID -Exec
#Execute physical cold backup (gzip)

$gvsqw_OraBin/sqwora_PhysicalColdBackup.ksh -I $ORACLE_SID -HI 4 -Exec
#Number of generations to keep, here 4

$gvsqw_OraBin/sqwora_PhysicalColdBackup.ksh -I $ORACLE_SID -Freeze -Exec
#Freeze the database during an Offline backup

$gvsqw_OraBin/sqwora_PhysicalColdBackup.ksh -I $ORACLE_SID -Blackout -Exec
#Blackout supervision when offline back

$gvsqw_OraBin/sqwora_PhysicalColdBackup.ksh -I $ORACLE_SID -P <NumericValue> -Exec
#Run sqwora_PhysicalColdBackup.ksh script with a parallel degree of '<NumericValue>'
#Use by default the variable gvsqw_NbThreadXXX in $gvsqw_OraBin/../etc/sqwora_GlobalVar.cfg
#You can change this default on all your environnement if you set this variable
#in configuration file $gvsqw_OraBin/../etc_cust/sqwora_GlobalVar.cfg

$gvsqw_OraBin/sqwora_PhysicalColdBackup.ksh -I $ORACLE_SID -AddMail 'mymail1@mydomaine.com,mymail2@mydomaine.com' -Exec
#Add the mail list to the default address managed by the variable gvsqw_GlobalMail

$gvsqw_OraBin/sqwora_PhysicalColdBackup.ksh -I $ORACLE_SID -SendReport -Exec
#Send the log by email at the end of the treatment even if there is no error

$gvsqw_OraBin/sqwora_PhysicalColdBackup.ksh -I $ORACLE_SID  -NoMail -Exec
#Disables sending an email on error to $gvsqw_GlobalMail (by default, send on error)

$gvsqw_OraBin/sqwora_PhysicalColdBackup.ksh -I $ORACLE_SID -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_sqwora_PhysicalColdBackup=<NumericValue>
#in configuration file $gvsqw_OraBin/../etc_cust/sqwora_GlobalVar.cfg