SQWareProduction:oracle:bin:sqwora GenerateStatspack.ksh

Presentation

Script $gvsqw_OraBin/sqwora_GenerateStatspack.ksh :

generate Statspack report

Online help

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

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

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

DESCRIPTION
   sqwora_GenerateStatspack.ksh Statspack reports generation
SUPPORT
   Oracle supported versions: 9iR2 <= v <= 11gR2

PARAMETERS
     -I  instance       : Target instance to generation
OPTIONS
     -h                 : Display the full usage.
     -s                 : Display samples of usage.
     -F  FileName       : Config file with date for generated reports.
     -Pdb    pdb_name   : pdb_name for multitenant.
     -Snaps  begin-end  : Generate report between the two snaps. 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.
     -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.
     -Force             : Bypass version check.
     -Locale    locale  : Force Locale for help display (fr,en).
     -NoMail            : Deactivate sendmail on error to pmexpdba@gmail.com (by default, send on error).

Error management

Errors passing arguments

This type of message is generated:

Lack instance parameter, Usage: sqwora_GenerateStatspack.ksh [-h] -I <instance> [+ options]
For full help : sqwora_GenerateStatspack.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-12-15 21:22:24
End          : 2020-12-15 21:22:24
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_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.07 SQWareProduction for Oracle (dbSQWare) ... 

#Standard help for script sqwora_GenerateStatspack.ksh:

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

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

$gvsqw_OraBin/sqwora_GenerateStatspack.ksh -I $ORACLE_SID
#Generate Statspack report

$gvsqw_OraBin/sqwora_GenerateStatspack.ksh -I $ORACLE_SID -DIR <DirExport>
#Specify a directory to store reports for instance $ORACLE_SID

$gvsqw_OraBin/sqwora_GenerateStatspack.ksh -I $ORACLE_SID -Dist
#Generate Statspack report with distant connection on non-local instance $ORACLE_SID
#You need to register credentials to use for distant connection to the instance (user and so on) in file $gvsqw_DistPasswdFile

$gvsqw_OraBin/sqwora_GenerateStatspack.ksh -I $ORACLE_SID -Detail 
#loop on all pdb in multitenant to get details from

$gvsqw_OraBin/sqwora_GenerateStatspack.ksh -I $ORACLE_SID -NoDel
#Don't remove local reports

$gvsqw_OraBin/sqwora_GenerateStatspack.ksh -I $ORACLE_SID -snaps
#Generate report between the two snaps. Break in -NoDel and -Local automatically

$gvsqw_OraBin/sqwora_GenerateStatspack.ksh -I $ORACLE_SID -Local
#Don't copy reports on $gvsqw_WebDbaUser

$gvsqw_OraBin/sqwora_GenerateStatspack.ksh -I $ORACLE_SID -PdbList 'PDBPROD_HR_SAGE,PDBTEST_HR_SAGE'
#Specify a list of pugable database name '<PdbList>' for multitenant environnements

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

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

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

$gvsqw_OraBin/sqwora_GenerateStatspack.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_GenerateStatspack=<NumericValue>
#in configuration file $gvsqw_OraBin/../etc_cust/sqwora_GlobalVar.cfg