×
 
 
  •  
$helper.renderConfluenceMacro('{bmc-global-announcement:$space.key}')
BMC PATROL for Microsoft SQL Server 9.6 Getting started

Agent configuration variables

'The configuration variables described in this section are Microsoft SQL Server variables that are set in the PATROL Agent.

For more detailed information, see the following BMC documentation products:

  • For summary information about the wpconfig utility, see the PATROL Console for Microsoft Windows User Guide—Customizing PATROL, Volume 3.
  • For detailed information about how to use the PATROL configuration variables, see the PATROL Agent Online documentation.
  • For detailed information about how to use the PATROL Configuration Manager, see the PATROL Configuration Manager User Guide, version 1.4.01 or later.

Warning

When you use the wpconfig utility or PATROL Configuration Manager to add, modify, or remove variables, no validations are performed.

Agent configuration variables

VariableDescription

/MSSQLServer/ConfigData/EnvironmentsList/<<environment name>>/availIntervalMin

Set availability collection interval in minutes for the environment

  • Minimum value-2
  • Maximum value-60
  • Default-2

/MSSQLServer/ConfigData/EnvironmentsList/<<environment name>>/dataIntervalMin

Set data collection interval in minutes for the environment

  • Minimum value-10
  • Maximum value-60
  • Default-15

/MSSQLServer/ConfigData/EnvironmentsList/<<environment name>>/debugEnv

Enables or disables the environment debug. Set this variable to 1 to enable the debug and set to 0 to disable the debug.

  • 0-No
  • 1-Yes

/MSSQLServer/ConfigData/EnvironmentsList/<<environment name>>/I2D

If this variable is modified, you must restart the PATROL Agent. 

Set device mapping to consolidate the configured devices at device level

  • 0-No
  • 1-Yes
  • Default value: 1
/MSSQLServer/ConfigData/EnvironmentsList/<<environment name>>/queryTimeoutSec

Sets the number of seconds allowed for a query to complete before going into timeout.

  • Minimum value-15
  • Maximum value-32767
  • Default-30
/MSSQLServer/ConfigData/EnvironmentsList/<<environment name>>/envNameSets a unique name for the environment
/MSSQLServer/ConfigData/EnvironmentsList/<<environment name>>/hostsList/<<host name>>/hostNameSets FQDN or IP Address on which SQL Server is installed
/SecureStore/MSSQLServer/ConfigData/EnvironmentsList/<<environment name>>/OSCredentials

Sets Windows user credentials. These credentials are used for discovery and to collect host related data, such as disk size or SQL Server service status.

User Name should also contain the domain name (DOMAIN_NAME\USER_NAME) 

For more details on how to use secure store, see Support for virtual secure store and secure key store Open link .

/SecureStore/MSSQLServer/ConfigData/EnvironmentsList/<<environment name>>/SqlCredentials

(Optional) Sets MS SQL Server login to be used for monitoring.
If you want to use the above Windows user credentials (Integrated Security) as MS SQL Server login credentials, do not apply this rule.

For more details on how to use secure store, see Support for virtual secure store and secure key store Open link .

"/MSSQLServer/ConfigData/EnvironmentsList/<<environment name>>/hostsList/<<host name>>/sqlInstsList/<<MS SQL Server (regex)>>/DBsFilteringType

Sets databases filtering mode

  • 0-None
  • 1-Include
  • 2-Exclude
/MSSQLServer/ConfigData/EnvironmentsList/<<environment name>>/hostsList/<<host name>>/sqlInstsList/<<MS SQL Server (regex)>>/blockerProcsLimit

Sets the amount of time in minutes a process has been blocked by the blocking process before it is considered as blocking process.

  • Minimum value-2
  • Maximum value-120
  • Default-3
/MSSQLServer/ConfigData/EnvironmentsList/<<environment name>>/hostsList/<<host name>>/sqlInstsList/<<MS SQL Server (regex)>>/hungJobsLimit

Sets the amount of time in minutes a job has been running before it is considered as hung job

  • Minimum value-2
  • Maximum value-120
  • Default-10
/MSSQLServer/ConfigData/EnvironmentsList/<<environment name>>/hostsList/<<host name>>/sqlInstsList/<<MS SQL Server (regex)>>/idleProcsLimit

Sets the amount of time in minutes the time process has not been consuming any resources before it is considered as an idle process.

  • Minimum value-2
  • Maximum value-120
  • Default-20
/MSSQLServer/ConfigData/EnvironmentsList/<<environment name>>/hostsList/<<host name>>/sqlInstsList/<<MS SQL Server (regex)>>/ignoreAutogrowth

Sets this variable to ignore File 'Autogrowth' Configuration for Space Used Percentage Metrics

  • 0-No
  • 1-Yes
/MSSQLServer/ConfigData/EnvironmentsList/<<environment name>>/hostsList/<<host name>>/sqlInstsList/<<MS SQL Server (regex)>>/includeExcludeDatabases

Sets include/Exclude of databases from monitoring (regex).

This entry depends on 'DBsFilteringType' entry

/MSSQLServer/ConfigData/EnvironmentsList/<<environment name>>/hostsList/<<host name>>/sqlInstsList/<<MS SQL Server (regex)>>/LastRunFailedJobs

Sets job considered as failed as long as its last run was failed. This variable is available in the PATROL for Microsoft SQL Server 9.6.30 version and later.

  • 0-No
  • 1-Yes

/MSSQLServer/ConfigData/EnvironmentsList/<<environment name>>/hostsList/<<host name>>/sqlInstsList/<<MS SQL Server (regex)>>/includeExcludejobsByCategories

Sets include/Exclude of jobs by categories from monitoring (regex).

This entry depends on 'entryjobsByCategoriesFilteringType'.

/MSSQLServer/ConfigData/EnvironmentsList/<<environment name>>/hostsList/<<host name>>/sqlInstsList/<<MS SQL Server (regex)>>/includeExcludejobsByLogins

Sets include/Exclude of jobs by logins from monitoring (regex).

This entry depends on 'jobsByLoginsFilteringType'.

/MSSQLServer/ConfigData/EnvironmentsList/<<environment name>>/hostsList/<<host name>>/sqlInstsList/<<MS SQL Server (regex)>>/includeExcludejobsByNames

Sets include or exclude jobs by names from monitoring (regex).

This entry depends on 'jobsByNamesFilteringType'.

/MSSQLServer/ConfigData/EnvironmentsList/<<environment name>>/hostsList/<<host name>>/sqlInstsList/<<MS SQL Server (regex)>>/includeInstances

Sets MS SQL Server instance name (regex)

/MSSQLServer/ConfigData/EnvironmentsList/<<environment name>>/hostsList/<<host name>>/sqlInstsList/<<MS SQL Server (regex)>>/jobsByCategoriesFilteringType

Sets jobs by categories filtering mode:

  • 0-None
  • 1-Include
  • 2-Exclude

/MSSQLServer/ConfigData/EnvironmentsList/<<environment name>>/hostsList/<<host name>>/sqlInstsList/<<MS SQL Server (regex)>>/jobsByLoginsFilteringType

Sets jobs by logins filtering mode:

  • 0-None
  • 1-Include
  • 2-Exclude

/MSSQLServer/ConfigData/EnvironmentsList/<<environment name>>/hostsList/<<host name>>/sqlInstsList/<<MS SQL Server (regex)>>/jobsByNamesFilteringType

Sets jobs by names filtering mode:

  • 0-None
  • 1-Include
  • 2-Exclude

/MSSQLServer/ConfigData/EnvironmentsList/<<environment name>>/hostsList/<<host name>>/sqlInstsList/<<MS SQL Server (regex)>>/longRunTransLimit

Sets the much time in minutes that a transaction takes to run before it is considered as long running transaction.

  • Minimum value-2
  • Maximum value-120
  • Default-10

/MSSQLServer/ConfigData/EnvironmentsList/<<environment name>>/hostsList/<<host name>>/sqlInstsList/<<MS SQL Server (regex)>>/monitorDBFileGroups

Sets if only files and file groups are monitored.

  • 0-No
  • 1-Yes

/MSSQLServer/ConfigData/EnvironmentsList/<<environment name>>/hostsList/<<host name>>/sqlInstsList/<<MS SQL Server (regex)>>/monitorOnlyAvail

Sets if to monitor availability only.

  • 0-No
  • 1-Yes

/MSSQLServer/ConfigData/EnvironmentsList/<<environment name>>/hostsList/<<host name>>/sqlInstsList/<<MS SQL Server (regex)>>/monitorOnlyDBs

Sets if to monitor databases only.

  • 0-No
  • 1-Yes

/MSSQLServer/ConfigData/EnvironmentsList/<<environment name>>/hostsList/<<host name>>/sqlInstsList/<<MS SQL Server (regex)>>/perfmonMonitoringLevel

Sets the perfmon monitoring level.

  • 0-None
  • 1-Most Important
  • 2-Full
  • 3-Custom

/MSSQLServer/ConfigData/EnvironmentsList/<<environment name>>/hostsList/<<host name>>/sqlInstsList/<<MS SQL Server (regex)>>/customQueriesList/<<custom query name>>/queryName

Sets SQL query name.

/MSSQLServer/ConfigData/EnvironmentsList/<<environment name>>/hostsList/<<host name>>/sqlInstsList/<<MS SQL Server (regex)>>/customQueriesList/<<custom query name>>/queryToPerform

Sets the SQL query to perform

/MSSQLServer/ConfigData/EnvironmentsList/<<environment name>>/hostsList/<<host name>>/sqlInstsList/<<MS SQL Server (regex)>>/customQueriesList/<<custom query name>>/queryIntervalMin

Sets the SQL query collection interval in minutes.

  • Minimum value-2
  • Maximum value-60
  • Default-10
/MSSQLServer/ConfigData/EnvironmentsList/<<environment name>>/generateDetailedEventsLongRunningTransGenerates detailed events for long running transactions. This variable is available in the PATROL for Microsoft SQL Server 9.6.40 version and later. It has either of the following values:
  • 0-No
  • 1-Yes
/MSSQLServer/ConfigData/EnvironmentsList/<<environment name>>/generateDetailedEventsSQLAgentHungJobsGenerates detailed events for hung jobs. This variable is available in the PATROL for Microsoft SQL Server 9.6.40 version and later. It has either of the following values:
  • 0-No
  • 1-Yes
/MSSQLServer/ConfigData/EnvironmentsList/<<environment name>>/generateDetailedEventsSQLAgentJobFailuresGenerates detailed events for failed jobs. This variable is available in the PATROL for Microsoft SQL Server 9.6.40 version and later. It has either of the following values:
  • 0-No
  • 1-Yes
Was this page helpful? Yes No Submitting... Thank you
Last modified by Shreya Gurukiran on Aug 24, 2021

Comments

Log in or register to comment.

Architecture
Monitor types and attributes
© Copyright 2013 - 2017, 2019, 2021 BMC Software, Inc.
Legal notices

Powered by Atlassian Confluence and Scroll Viewport

© Copyright 2005-2023 BMC Software, Inc. Use of this site signifies your acceptance of BMC’s Terms of Use . BMC, the BMC logo, and other BMC marks are assets of BMC Software, Inc. These trademarks are registered and may be registered in the U.S. and in other countries.