SQWareProduction:teradata:bin:sqwter NetBackup.ksh

Presentation

Script $gvsqw_TerBin/sqwter_NetBackup.ksh :

backup with NetBackup dump/backup files

Online help

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

Sourcing sqwter_Global.lib v2024.07 SQWareProduction for Teradata (dbSQWare) ... 

Usage: sqwter_NetBackup.ksh [-h] -I <instance> -Policy <policy> -Schedule <schedule> [+ options]

DESCRIPTION
   sqwter_NetBackup.ksh backup with NetBackup dump/backup files
SUPPORT
   All rdbms type and version

PARAMETERS
     -I  instance       : Target instance.
     -Policy policy     : Policy name.
     -Schedule schedule : Schedule name.
OPTIONS
     -h                 : Display the full usage.
     -s                 : Display samples of usage.
     -FRT       code    : Force return code value on error.
     -NoMail            : Deactivate sendmail on error pmexpdba@gmail.com (by default, send on error).
     -Locale    locale  : Force Locale for help display (fr,en).
     -AddMail   email   : Email address to add at 'pmexpdba@gmail.com'.
     -SendReport        : Send execution log report.
     -Exec              : Run backup (by default, display generated commands).

Error management

Errors passing arguments

This type of message is generated:

Lack instance parameter, Usage: sqwter_NetBackup.ksh [-h] -I <instance> -Policy <policy> -Schedule <schedule> [+ options]
For full help : sqwter_NetBackup.ksh -h

If you are connecting through a terminal, no mail will be sent and you will have more this kind of message:

Begining     : 2020-11-29 20:10:43
End          : 2020-11-29 20:10:43
Duration     : 00:00:00 

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

Usage examples

Sourcing sqwter_Global.lib v2024.07 SQWareProduction for Teradata (dbSQWare) ... 

#Standard generic help for script sqwter_NetBackup.ksh:

$gvsqw_Ter/sqwgen_NetBackup.ksh -h
#Display online help for this script

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

$gvsqw_Ter/sqwgen_NetBackup.ksh -s
#Display usage examples for this script

$gvsqw_Ter/sqwgen_NetBackup.ksh -I <Instance> -Policy <Policy> -Schedule <Schedule>
#Display all the generated commands by the script, whithout executing them

$gvsqw_Ter/sqwgen_NetBackup.ksh -I <Instance> -Policy <Policy> -Schedule <Schedule> -Exec
#Use NetBackup to backup files's instance <Instance> using policy <Policy> and schedule <Schedule>

$gvsqw_Ter/sqwgen_NetBackup.ksh -I <Instance> -Policy <Policy> -Schedule <Schedule> -Exec -AddMail 'mymail1@mydomaine.com,mymail2@mydomaine.com'
#Add the mail list to the default address managed by $gvsqw_GlobalMail (only this time)

$gvsqw_Ter/sqwgen_NetBackup.ksh -I <Instance> -Policy <Policy> -Schedule <Schedule> -Exec -SendReport
#Send the log by email at the end of the treatment even if there is no error (by default, send on error)

$gvsqw_Ter/sqwgen_NetBackup.ksh -I <Instance> -Policy <Policy> -Schedule <Schedule> -Exec -NoMail
#Disables sending an email on error to $gvsqw_GlobalMail (by default, send on error)

$gvsqw_Ter/sqwgen_NetBackup.ksh -I <Instance> -Policy <Policy> -Schedule <Schedule> -Exec -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_sqwgen_NetBackup=<NumericValue>
#in configuration file $gvsqw_Ter/../etc_cust/sqwgen_GlobalVar.cfg