SQWareProduction:oracle:bin:sqwora GenerateAwr.ksh

From wiki_dbSQWare
Jump to: navigation, search

Presentation

Script $gvsqw_OraBin/sqwora_GenerateAwr.ksh :


Generate automatically AWR reports
Copy them in SQWareWeb and insert indicators in SQWareRepository
You can also choose:

  • a different configuration file to generate reports
  • a different directory to store reports
  • to generate locally (don't copy reports on SQWareWeb and don't insert indicators in SQWareRepository)
  • no delete local reports



Online help

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

Sourcing sqwora_Global.lib v4.0.09 SQWareProduction for Oracle (dbSQWare) ... 

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

DESCRIPTION
   sqwora_GenerateAwr.ksh AWR reports generation
SUPPORT
   Oracle supported versions: 10gR2 <= v <= 12cR1

PARAMETERS
     -I  instance       : Target instance for generation
OPTIONS
     -h  help           : Display the full usage.
     -s                 : Display samples of usage.
     -F  FileName       : Config file with date for generate reports.
     -PdbList    list   : list of pdb_name for multitenant to have detail.
     -Snaps  begin-end  : Generate report between the two naps. Break in -NoDel and -Local automatically.
     -DIR  directory    : Directory to store reports.
     -FRT return_code   : Force return code value on error.
     -AddMail email     : Email Address to add at 'pmexpdba@gmail.com'.
     -SendReport        : Send execution log report.
     -Detail            : loop on all pdb for multitenant to have detail.
     -Local             : Don't copy reports on dbsqware@SQWareWebHost.
     -Dist              : For distant connection to database (change $gvsqw_DbaUser to $gvsqw_DistDbaUser@$ORACLE_SID ).
     -NoDel             : Don't remove local reports.
     -NoMail            : Desactivate sendmail on error to pmexpdba@gmail.com (by default, send on error).

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_GenerateAwr.ksh [-h] -I <instance> [+ options]
For full help : sqwora_GenerateAwr.ksh -h

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

No send 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_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.


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 v4.0.09 SQWareProduction for Oracle (dbSQWare) ... 

#Standard help for script sqwora_GenerateAwr.ksh:


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

$gvsqw_OraBin/sqwora_GenerateAwr.ksh -I $ORACLE_SID -NoMail
#Desactivate sendmail on error to $gvsqw_GlobalMail (by default, send on error)

$gvsqw_OraBin/sqwora_GenerateAwr.ksh -I $ORACLE_SID -FRT <NumericValue>
#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_GenerateAwr=<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.