SQWareProduction:oracle:bin:sqwora RmanBackup.ksh

From Wiki_dbSQWare
Jump to: navigation, search

Presentation

Script $gvsqw_OraBin/sqwora_RmanBackup.ksh :


Makes RMAN backups
You can choose backup type:

  • incremental level 0 (i0)
  • incremental level 1 (i1)
  • archivelog (log)


Backup can be made online or offline (hot, cold)
The script can also:

  • use the option 'skip readonly'
  • autostart sqwarchmon when hot backup (if lvsqw_RmanAutoStartSqwArchmon=enable)
  • makes freeze/unfreeze of cluster ressources when cold backup
  • makes blackout disable/enable of supervision when cold backup


This script use configuration file $gvsqw_RootCfg/sqwora_Rman.cfg



Online help

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

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

Usage: sqwora_RmanBackup.ksh [-h] -I <instance> -T <Type> [+ options]

DESCRIPTION
   sqwora_RmanBackup.ksh execute RMAN backup
SUPPORT
   Oracle supported versions: 9iR2 <= v <= 21c

PARAMETERS
     -I  instance       : Target instance to backup.
     -T  Type           : Backup type (i0, i1, log).
OPTIONS
     -h                 : Display the full usage.
     -s                 : Display samples of usage.
     -O  Type           : cold,hot (by default hot).
     -DG                : For dataguard instances not open.
     -SRO               : Option 'skip readonly' (by default backup all TBS).
     -OPT option        : Option to add to the RMAN command.
     -FRT return_code   : Force return code value on error.
     -AddMail   email   : Email address to add at 'pmexpdba@gmail.com'.
     -SendReport        : Send execution log report.
     -NoCumulative      : Disable cumulative incremental (by default disable).
     -NoDelInput        : Disable 'delete input' when backup archivelog.
     -Cumulative        : Make cumulative incremental (by default disable).
     -SkIna             : Add 'skip inaccessible' for archive backup.
     -Split             : Split backup directories by channel.
     -Force             : Bypass version check.
     -NoArc             : Disable backup of archivelog when type i[0-1] (to make 'section size xxG' option usefull for example).
     -NoZdlra           : Disable backup to ZDLRA (by default Disable).
     -Zdlra             : Enable backup to ZDLRA (by default Disable).
     -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)
Nuvola apps information.png
Note:
To be sure the aid is accurate, refer directly to the online help script -h option.


Error management

Errors passing arguments

This type of message is generated: 

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

Nuvola apps information.png
Note:
Sending mail can be disabled by the option -NoMail for one execution.


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).

Nuvola apps information.png
Note:
Sending mail can be disabled by the option -NoMail for one execution.


Usage examples

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

#Standard help for script sqwora_RmanBackup.ksh:


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

$gvsqw_OraBin/sqwora_RmanBackup.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_RmanBackup.ksh -s
#Display usage examples for this script

$gvsqw_OraBin/sqwora_RmanBackup.ksh -I $ORACLE_SID -T <Type>
#Generate commands but don't execute them !

$gvsqw_OraBin/sqwora_RmanBackup.ksh -I $ORACLE_SID -T <Type> -Exec
#Makes RMAN backups

$gvsqw_OraBin/sqwora_RmanBackup.ksh -I $ORACLE_SID -T <Type> -O <BackupType> -Force -Exec
#Force execution generated commands

$gvsqw_OraBin/sqwora_RmanBackup.ksh -I $ORACLE_SID -T <Type> -DG <DGname> -Exec
#Gather Oracle indicators for dataguard instances not OPEN

$gvsqw_OraBin/sqwora_RmanBackup.ksh -I $ORACLE_SID -T <Type> -Cumulative -Exec
#Make cumulative incremental (-NoCumulative : Disable cumulative incremental)

$gvsqw_OraBin/sqwora_RmanBackup.ksh -I $ORACLE_SID -T <Type> -NoDelInput -Exec
#Disable 'delete input' when backup archivelog

$gvsqw_OraBin/sqwora_RmanBackup.ksh -I $ORACLE_SID -T <Type> -SkIna -Exec
#Add 'skip inaccessible' for archive backup

$gvsqw_OraBin/sqwora_RmanBackup.ksh -I $ORACLE_SID -T <Type> -Split -Exec
#Split backup directories by channel

$gvsqw_OraBin/sqwora_RmanBackup.ksh -I $ORACLE_SID -T <Type> -NoArc -Exec
#Disable backup of archivelog when type i[0-1]

$gvsqw_OraBin/sqwora_RmanBackup.ksh -I $ORACLE_SID -T <Type> -Zdlra -Exec
## (exist -NoZdlra)

$gvsqw_OraBin/sqwora_RmanBackup.ksh -I $ORACLE_SID -T <Type> -Freeze -Exec
#Freeze the database during an Offline backup

$gvsqw_OraBin/sqwora_RmanBackup.ksh -I $ORACLE_SID -T <Type> -Blackout -Exec
#Blackout supervision when offline back

$gvsqw_OraBin/sqwora_RmanBackup.ksh -I $ORACLE_SID -T <Type> -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_RmanBackup.ksh -I $ORACLE_SID -T <Type> -SendReport -Exec
#Send the log by email at the end of the treatment even if there is no error

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

$gvsqw_OraBin/sqwora_RmanBackup.ksh -I $ORACLE_SID -T <Type> -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_RmanBackup=<NumericValue>
#in configuration file $gvsqw_OraBin/../etc_cust/sqwora_GlobalVar.cfg
Nuvola apps information.png
Note:
To be sure the examples are accurate, refer directly to the online help script -s option.


Retrieved from "https://wiki.dbsqware.com/index.php?title=SQWareProduction:oracle:bin:sqwora_RmanBackup.ksh&oldid=18260"