SQWareProduction:mssql:bin:sqwmsq GatherIndicators.ksh
Contents
Presentation
Script $gvsqw_MsqBin/sqwmsq_GatherIndicators.ksh :
Gather MsSql indicators and put them in SQWareRepository
Summary of collection:
- Volumetry (use, free) of instance
- Volumetry (use, free) of databases
- Volumetry (use, free) of files
- Version, options, configuration, ... of instance
Online help
The online help is available for most scripts with the -h option.
Ex: $gvsqw_MsqBin/sqwmsq_GatherIndicators.ksh -h
Content of this assistance :
Sourcing sqwmsq_Global.lib v2024.07 SQWareProduction for MsSql (dbSQWare) ...
Usage: sqwmsq_GatherIndicators.ksh [-h] -I <FreeTdsAlias> [+ options]
DESCRIPTION
sqwmsq_GatherIndicators.ksh gather DBAs indicators
SUPPORT
MsSql supported versions: 2000 <= v <= 2022
PARAMETERS
-I Instance : Target instance (freeTds alias) to gather indicators.
OPTIONS
-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.
-h : Display the full usage.
-s : Display samples of usage.
Error management
Errors passing arguments
This type of message is generated:
Lack 'FreeTdsAlias' parameter, Usage: sqwmsq_GatherIndicators.ksh [-h] -I <FreeTdsAlias> [+ options] For full help : sqwmsq_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 'FreeTdsAlias' 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_mssql : " (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_mssql (See help customize this variable). The subject line will always start by "$gvsqw_MailMsg_mssql : " (See help customize this variable).
Usage examples
Sourcing sqwmsq_Global.lib v2024.07 SQWareProduction for MsSql (dbSQWare) ... #Standard help for script sqwmsq_GatherIndicators.ksh: $gvsqw_MsqBin/sqwmsq_GatherIndicators.ksh -h #Display online help for this script $gvsqw_MsqBin/sqwmsq_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_MsqBin/sqwmsq_GatherIndicators.ksh -s #Display usage examples for this script $gvsqw_MsqBin/sqwmsq_GatherIndicators.ksh -I $Alias #Gather indicators for target instance $gvsqw_MsqBin/sqwmsq_GatherIndicators.ksh -I $Alias -AddMail 'mymail1@mydomaine.com,mymail2@mydomaine.com' #Add the mail list to the default address managed by the variable gvsqw_GlobalMail $gvsqw_MsqBin/sqwmsq_GatherIndicators.ksh -I $Alias -SendReport #Send the log by email at the end of the treatment even if there is no error $gvsqw_MsqBin/sqwmsq_GatherIndicators.ksh -I $Alias -NoMail #Disables sending an email on error to $gvsqw_GlobalMail (by default, send on error) $gvsqw_MsqBin/sqwmsq_GatherIndicators.ksh -I $Alias -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_sqwmsq_GatherIndicators=<NumericValue> #in configuration file $gvsqw_MsqBin/../etc_cust/sqwmsq_GlobalVar.cfg
