SQWareProduction:sybase:bin:sqwsyb GatherIndicators.ksh

From Wiki_dbSQWare
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

Presentation

Script $gvsqw_SybBin/sqwsyb_GatherIndicators.ksh :


Gather Sybase indicators and put them in SQWareRepository
Summary of collection:

  • Volumetry (use, free) of dataserver
  • Volumetry (use, free) of databases
  • Volumetry of tables
  • Volumetry (use, free) of FS
  • Version, options, configuration, ... of dataserver



Online help

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

Sourcing sqwsyb_Global.lib v2025.05 SQWareProduction for Sybase (dbSQWare) ... 

Usage: sqwsyb_GatherIndicators.ksh [-h] -I <dataserver> [+ options]

DESCRIPTION
   sqwsyb_GatherIndicators.ksh gather DBA indicators
SUPPORT
   Sybase supported versions: 12.0 <= v <= 16.0

PARAMETERS
     -I  dataserver     : Target dataserver.
OPTIONS
     -h                 : Display the full usage.
     -s                 : Display samples of usage.
     -FRT       code    : Force return code value on error.
     -Dist              : For distant connection to database (change $gvsqw_DbaUser to $gvsqw_DistDbaUser ).
     -AddMail   email   : Email address to add at 'demo-sqwarebox@dbsqware.com'.
     -SendReport        : Send execution log report.
     -Locale    locale  : Force Locale for help display (fr,en).
     -NoMail            : Deactivate sendmail on error demo-sqwarebox@dbsqware.com (by default, send on error).

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 'dataserver' parameter, Usage: sqwsyb_GatherIndicators.ksh [-h] -I <dataserver> [+ options]
For full help : sqwsyb_GatherIndicators.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 'dataserver' 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_sybase : " (See help customize this variable).

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

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


Usage examples

Sourcing sqwsyb_Global.lib v2025.05 SQWareProduction for Sybase (dbSQWare) ... 

#Standard help for script sqwsyb_GatherIndicators.ksh:


$gvsqw_SybBin/sqwsyb_GatherIndicators.ksh -h
#Display online help for this script

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

$gvsqw_SybBin/sqwsyb_GatherIndicators.ksh -s
#Display usage examples for this script

$gvsqw_SybBin/sqwsyb_GatherIndicators.ksh -I $DSQUERY
#Gather indicators for target instance 

$gvsqw_SybBin/sqwsyb_GatherIndicators.ksh -I $DSQUERY -Dist
#Gather Sybase indicators for the non-local instance $DSQUERY with distant connection
#You need to register credentials to use for distant connection to the instance (user and so on) in file $gvsqw_DistPasswdFile

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

$gvsqw_SybBin/sqwsyb_GatherIndicators.ksh -I $DSQUERY -SendReport
#Send the log by email at the end of the treatment even if there is no error

$gvsqw_SybBin/sqwsyb_GatherIndicators.ksh -I $DSQUERY -NoMail
#Disables sending an email on error to $gvsqw_GlobalMail (by default, send on error)

$gvsqw_SybBin/sqwsyb_GatherIndicators.ksh -I $DSQUERY -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_sqwsyb_GatherIndicators=<NumericValue>
#in configuration file $gvsqw_SybBin/../etc_cust/sqwsyb_GlobalVar.cfg

Note:
To be sure the examples are accurate, refer directly to the online help script -s option.