Agent configuration variables

/AgentSetup/

MSSQL_SERVER.AgentHostName.

defaultAccount

• If this variable is modified, you must restart the Agent. 
  Stores the credentials of the standard security user. 
  This account is used to open the user-level channel. 
  See the PATROL Agent Online documentation for more information.
  Create this variable using only one of the following menu commands:

• KM Commands > KM Admin > Setup/Configure KM > 
  SQL Server Instance Setup (stores the sa password)

• KM Commands > KM Admin > SQL Config Set up
  (does not stores the sa password)

/AgentSetup/

MSSQL_SERVER.AgentHostName.

OSdefaultAccount

If this variable is modified, you must restart the Agent. 
Stores the credentials of the integrated security user. 
This account is used to open the user-level channel. 
See the PATROL Agent Online documentation for more information.
Create this variable using only one of the following menu commands:

KM Commands > KM Admin > Setup/Configure KM > 
SQL Server Instance Setup (stores the sa password)

KM Commands > KM Admin > SQL Config Set up
(does not stores the sa password)

/AgentSetup/

MSSQL_SERVER.SQLServerInstanceName\\

IntegratedStandard

For use with PATROL Configuration Manager only. 
Stores the type of PATROL login account, whether Standard or Integrated.

Values:

I = Integrated

S = Standard

/AgentSetup/

MSSQL_SERVER.ADMIN.

SQLServerInstanceName\\IntegratedStandard

For use with PATROL Configuration Manager only.

Stores the type of SQL Server login account with system 
administrator privileges, whether Standard or Integrated.

Values:

I = Integrated

S = Standard

/AgentSetup/

MSSQL_SERVER.AgentHostName.

OSdefaultAccountAppliesToCmds

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

Flag indicating whether OSdefaultAccount is used to 
execute the OS commands.

See the PATROL Agent Online documentation for more information.

Create this variable using only one of the following menu commands:

• KM Commands > KM Admin > Setup/Configure KM > 
  SQL Server Instance Setup
• KM Commands > KM Admin > SQL Config Set up

/AgentSetup/

MSSQL_SERVER_ADMIN.AgentHostName.

defaultAccount

If this variable is modified, you must restart the Agent. 
Stores the credentials of the standard security user. 
This account is used to open the admin-level channel.

See the PATROL Agent Online documentation for more information.

Create this variable using only one of the following menu commands:

• KM Commands > KM Admin > Setup/Configure KM > 
  SQL Server Instance Setup
• KM Commands > KM Admin > SQL Config Set up

/AgentSetup/

MSSQL_SERVER_ADMIN.AgentHostName.

OSdefaultAccount

If this variable is modified, you must restart the Agent. 
Stores the credentials of the integrated security user. 
This account is used to open the admin-level channel. 

See the PATROL Agent Online documentation for more information.

Create this variable using only one of the following menu commands:

• KM Commands > KM Admin > Setup/Configure KM > 
  SQL Server Instance Setup
• KM Commands > KM Admin > SQL Config Set up

/AgentSetup/

MSSQL_SERVER_ADMIN.AgentHostName.

OSdefaultAccountAppliesToCmds

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

Flag indicating whether OSdefaultAccount is used to 
execute the OS commands. 

See the PATROL Agent Online documentation for more information.

Create this variable using only one of the following menu commands:

• KM Commands > KM Admin > Setup/Configure KM > 
  SQL Server Instance Setup
• KM Commands > KM Admin > SQL Config Set up

Click /MSSQLServer to display the following variables:

/MSSQLServer/

DebugDir

Stores the location of the directory on PATROL Agent host where 
debugs are saved.

If the /MSSQLServer/SaveDebugInFile pconfig variable is set to 
1 and the /MSSQLServer/DebugDir is not set to any value, 
debugs will be saved in C:\.

If you create the /MSSQLServer/DebugDir pconfig variable 
through the wpconfig utility, then value of this variable should not 
have spaces or other special characters such as ., (, or ).

To create or modify this variable, use the KM Commands > KM Admin > 
DEBUG menu command from the Server application.

MSSQLServer/

DEBUG_DISC_STAT

Changes to this variable are detected by the ConfigUpdates parameter. 
Flag indicating whether DEBUG is turned on during discovery

0 = DEBUG is turned off during discovery

1 = DEBUG is turned on during discovery

To create or modify this variable, use the KM Commands > KM Admin > 
DEBUG menu command from the Server, User, or Database application.

/MSSQLServer/

DEBUG_PRE_DISC_STAT

Changes to this variable are detected by the ConfigUpdates 
parameter. Flag indicating whether DEBUG is turned on during prediscovery.

0 = DEBUG is turned off during pre- discovery

1 = DEBUG is turned on during pre- discovery

To create or modify this variable, use the KM Commands > KM Admin > 
DEBUG menu command from the Server, User, or Database application.

/MSSQLServer/

SaveDebugInFile

Enables you save a debug in a file. 
If this pconfig variable is set to 1, then the debug is saved in a file.

To create or modify this variable, use the KM Commands > KM Admin > 
DEBUG menu command from the Server application.

/MSSQLServer/
SpecialOSQLPath

Flag indicating whether special characters, such as parentheses 
are allowed in the OSQL path.

0 = special characters are not allowed in the OSQL path
1 = special characters are allowed in the OSQL path

Create or modify this variable using the wpconfig utility.

/MSSQLServer/
SQLServersExcludedFromDiscovery

Lists the SQL Servers excluded from discovery. 
You must enter this variable manually. It does not appear otherwise.

Enter the pconfig variable followed by the names of the SQL Servers 
that you want to exclude from monitoring, with a vertical pipe (|) 
character separating the names of the SQL Servers, as in the following example:

ABC\SQL8_TEST|MSSQLServer|MSSQL-SQL8DATA|
ABC\SQL8_PROD

This example excludes the following SQL Servers:

• With the SQL Server name ABC\SQL8_TEST and ABC\SQL8_PROD, 
  where ABC is the host name
• With the Windows service name MSSQLServer for SQL Server 
  with a default instance name

/MSSQLServer/VirtualServerName\\
SQLServerInstanceName/failover_alarm_on_off

Enables you to set the Failover parameter to go into an alarm

You should set this variable to 1 if you want the Failover parameter 
to go into an alarm.

Create or modify this variable using the wpconfig utility.

/MSSQLServer/SQLServerInstanceName/
PubInst

Use this variable when the SQL Server instance that you are monitoring 
is configured for Replication such that the Publisher and Distributor 
are on different instances.

List the SQL Server instance names that are configured as Publishers 
with Distributor residing on SQLServerInstanceName.

You must enter this variable manually. It does not appear otherwise.

When you want to monitor Replication where Publishers are residing 
on different SQL Server instances, enter the pconfig variable followed by 
the names of the SQL Servers where Publisher resides with a vertical pipe (|) 
character separating the names of the SQL Servers, 
as in the following example:

ABC\SQL8_TEST|MSSQLServer|MSSQL-SQL8DATA|
ABC\SQL8_PROD

The above example includes the SQL Server instance 
names which contains Publisher:

• With the SQL Server name ABC\SQL8_TEST, 
  and ABC\SQL8_PROD, where ABC is the host name
• With the Windows service name MSSQLServer for SQL 
  Server with a default instance name

/MSSQLServer/SQLServerInstanceName/
SQLServerNamePublisher1.defaultAccount

Use this variable when the SQL Server instance that you are monitoring 
is configured for Replication such that the

Publisher and Distributor are on different instances.

Stores the credentials of the SQL Server account that has 
system administrator privileges, where,

• SQLServerInstanceName is the Distributor instance name
• SQLServerNamePublisher1 is the Publisher instance name

You must enter this variable manually. It does not appear otherwise.

When you want to monitor Replication where Publishers are residing 
on different SQL Server instances, enter the

pconfig variable as in the following example:

• /MSSQLServer/SQLServerInstanceName/
  ABC\\SQL8_TEST.defaultAccount
• /MSSQLServer/SQLServerInstanceName/
  MSSQLServer.defaultAccount
• /MSSQLServer/SQLServerInstanceName/
  ABC\\SQL8_PROD.defaultAccount

where,

• ABC\\SQL8_TEST and ABC\\SQL8_PROD are SQL Server 
  names, with ABC as the host name
• MSSQLServer is the Windows service name for SQL Server 
  with a default instance name

/MSSQLServer/SQLServerInstanceName/
RepLatencySleep

This variable is used to set the sleep value that helps 
the token to be correctly propagated to the Subscriber. 
Default value: 10 seconds

/MSSQLServer/SQLServerInstanceName/
database_name/OldestUnsentTransaction

This variable is used to set the threshold value (in minutes) 
for transaction lag between the principal server and the 
mirror server.

Default value: 10 minutes

/MSSQLServer/SQLServerInstanceName/

ConfiguredWithGroup

Flag indicating whether the SQL Server instance is configured 
with Windows group

A value 1 indicates that the SQL Server instance is configured 
with Windows group.

To create or modify this variable, use the 
KM Commands > KM Admin > Setup/Configure KM > 
Configure SQLServer using Windows Group.

/MSSQLServer/SQLServerInstanceName/

ConfiguredGroupName

Stores the configured Windows group name.

To create or modify this variable, use the 
KM Commands > KM Admin > Setup/Configure KM > 
Configure SQLServer using Windows Group.

/MSSQLServer/SQLServerInstanceName/

ExcludedDbs

Stores the list of databases excluded from monitoring when 
Auto Discovery is set on.

To create or modify this variable, use the 
KM Commands > KM Admin > Setup/Configure KM > 
Set DB Auto-Discovery command.

/MSSQLServer/SQLServerInstanceName/SQL
ERRORLOG/

EXCLUDED_ERRORLOG_STRINGS

Stores the list of strings to be excluded from monitoring.

To create or modify this variable, use the 
KM Commands > KM Admin > Exclude Errorlog String from 
Monitoring command from the SQLERRORLOG application class.

/MSSQLServer/SQLServerInstanceName/

ExcludedLogins

Stores the list of SQLServer logins SQLAgent jobs owned by these 
logins are excluded from monitoring.

To create or modify this variable, use the 
KM Commands > KM Admin > Exclude SQLAgent jobs 
from monitoring command from the Availability application class.

/MSSQLServer/SQLServerInstanceName/

PubInst

Use this variable when the SQL Server that you are 
monitoring is configured for replication such that the 
Publisher and Distributor are on different instances.

You must enter this variable manually. 
It does not appear otherwise.

Set the value to Publisher instance name. 
This name will be used while connecting to the Published 
instance to calculate latency.

/MSSQLServer/SQLServerInstanceName/

PubInst.defaultAccount

Use this variable when the SQL Server that you 
are monitoring is configured for replication such that the 
Publisher and Distributor are on different instances.

You must enter this variable manually. 
It does not appear otherwise.

Set the value to Publisher instance sa user name 
and password. 

This name will be used while connecting to the 
Published instance to calculate latency.

MSSQLServer/SQLServerInstanceName/

ResetJobFailureAlarm

Enables you to clear the SQLAgentJobFailures 
parameter alarm automatically at the start of each 
polling cycle. You need to create this variable and set 
its value to 1.

If you set the value to 1, at the start of each 
polling cycle, the value of the SQLAgentJobFailures 
parameter is set to 0 and then set to a value depending 
on whether any jobs failed after last polling cycle. 
If any jobs failed after the last polling cycle, events 
are generated even if you have reset the alarm from the KM menu.

/MSSQLServer/A_DBSPMB_ENABLED

This variable is not present by default. If it is set to 1, the 
command DBCC showfilestats is used for space

Calculation instead of sp_spaceused.

/MSSQLServer/ SQLServerInstanceName/

UserExListBlocked

Contains the list of Users excluded from monitoring 
of blocked processes.

/MSSQLServer/ SQLServerInstanceName/

UserExListIdle

Contains the list of Users excluded from monitoring 
of idle processes.

/MSSQLServer/ SQLServerInstanceName/

blocked_waittime

The processes having waittime greater than this variable are 
considered for the parameter NumBlockedProcesses.
The default value of this pconfig variable is 100 ms.

/MSSQLServer/SQLServerInstanceName/

JobStepFailFlag

Checks a job step failure if the value of this variable is set to 1.

However, PATROL for Microsoft SQL Server ignores a job step 
failure if the Quit with success option is set for that job step.

The default value is 0, meaning PATROL for Microsoft SQL Server 
addresses a job step failure as a job failure even if the Quit with 
success option is set.

/MSSQLServer/SQLServerInstanceName/

ExcludedJobCategories

Stores the list of SQLServer Agent job categories that are 
excluded from monitoring.

To create or modify this variable, use the KM Commands > 
Exclude SqlAgent jobs by Job Category command from the 
Availability application class.

/MSSQLServer/SQLServerInstanceName/

ExcludedSQLServerJobNames

Stores the list of SQLServer Agent job names that are excluded 
from monitoring.

To create or modify this variable, use the KM Commands > 
Exclude SqlAgent jobs by JobNames command from the 
Availability application class.

/MSSQLServer/SQLServerInstanceName/

GENUSERFLAG

Determines whether Product Short is configured for general 
user monitoring.

The value of GENUSERFLAG must be one character long.

• If the value is 0, the product is configured for sa user monitoring.
• If the value is 1, the product is configured for general user monitoring.
• If the value is null, or other than 1 or 0, the product is not configured 
  for general user monitoring.

To create or modify this variable, use the KM Commands > KM Admin > 
SQL Config Set up command.

/AgentSetup/

VirtualServerName

Stores the virtual server name.

This variable is required for Veritas cluster discovery.

When running SQL Server on a Veritas cluster, set the virtual 
server name in this variable.

/AgentSetup/VirtualServerName should be the same as the 
virtual server name assigned to the

PATROL_VIRTUALNAME_port. This name is case sensitive.

/AgentSetup/

Veritas_sql_server_group

Stores the SQL Server group name.

This variable is required for Veritas cluster discovery.

When running SQL Server on a Veritas cluster, set the SQL 
Server group name in this variable.
/AgentSetup/Veritas_sql_server_group should be the same as 
the SQL Server group name.

/AgentSetup/
Veritas_sql_server_service

Stores SQL Server service name if the cluster is a Veritas cluster.

/AgentSetup/
isVeritasCluster

Stores information about the Veritas cluster

This variable is required for Veritas cluster discovery.

When running SQL Server on a Veritas cluster, the value 
for this variable must be equal to 1.

Click /MSSQL_SERVER/AgentHostName to display the following variables:

/MSSQL_SERVER/AgentHostName/

BlockAutoLaunch

Changes to this variable are detected by the 
ConfigUpdates parameter.

Flag indicating whether or not a user instance is created for 
users or sessions that are blocking other sessions

• Yes = user instances are created
• No = user instances are not created

To create or modify this variable, use the KM Commands > KM Admin > 
User Monitoring Admin > Configure Auto User Monitoring menu 
command from the Server

application. For more information, see Monitoring-users-and-processes.

/MSSQL_SERVER/AgentHostName/

BlockedTime

Changes to this variable are detected by the ConfigUpdates 
parameter.

Indicates the amount of time a process can block another 
process before raising an alarm

The value for this variable is the amount of time in seconds 
entered as the blocked detection time. The default is 180 seconds.

To create or modify this variable, use the KM Commands > 
KM Admin > User Monitoring Admin > ConfigureAuto User 
Monitoring menu command from the Server application.

For more information, see Monitoring-users-and-processes.

/MSSQLServer/AgentHostName\\InstanceNa
me/DBCC_PSS_Disabled

If this variable is modified, you must restart the Agent. 
You must enter this variable manually, it does not appear 
automatically.

Turns off SQL Snapshot (DBCC output with trace)

• 1 disables the retrieval of the SQL query text by the 
  recovery actions.
• Any value other than 1 enables the retrieval of the 
  SQL query text.

/MSSQL_SERVER/AgentHostName/
IdleAutoLaunch

Changes to this variable are detected by the ConfigUpdates 
parameter.

Flag indicating whether or not a user instance is created 
for users or sessions that are idle

• 0 = user instance is not created
• 1 = user instance is created

To create or modify this variable, use the KM Commands > 
KM Admin > User Monitoring Admin > Configure Auto User 
Monitoring menu command from the Server application. 

For more information, see Monitoring-users-and-processes.

/MSSQL_Server/AgentHostName/
idle_procs_monitoring_enabled

Disables and enables idle process monitoring.

You must enter this variable manually. 
It does not appear automatically.

• 0 disables idle process monitoring
• Any value other than 0 enables idle process 
  monitoring

/MSSQL_Server/AgentHostName/
blocked_procs_monitoring_enabled

Disables and enables blocked process monitoring

You must enter this variable manually. 
It does not appear automatically.

• 0 disables blocked process monitoring
• Any value other than 0 enables blocked process 
  monitoring

/MSSQL_SERVER/AgentHostName/
StoppedTime

Changes to this variable are detected by the ConfigUpdates parameter.
indicates the idle detection time

The value for this variable is the amount of time in seconds entered 
as the idle detection time. The default is 20 minutes.

which displays as 1200 seconds.

To create or modify this variable, use the KM Commands > 
KM Admin > User Monitoring Admin > Configure Auto User 
Monitoring menu command from the Server

application. For more information, see Monitoring-users-and-processes.

/MSSQL_SERVER/AgentHostName/
UserActive

Changes to this variable are detected by the ConfigUpdates 
parameter.

Flag indicating whether or not a user instance is created 
for users or sessions that are idle

• 1 = a user instance is created
• 0 = a user instance is not created

To create or modify this variable, use the KM Commands > 
KM Admin > User Monitoring Admin > Configure Auto User 
Monitoring menu command from the Server application.

For more information, see Monitoring-users-and-processes.

Click /MSSQLServer to display the following variables:

/charts/AgentHostName/name of chart

Changes to this variable are detected by the 
ConfigUpdates parameter.

Lists the parameters included in a user-defined parameter charts.

The value of this parameter is a list of parameter names
separated by a new line character.

To create or modify this variable, use the KM Commands > 
KM Admin > Reports > Parameter Charts > Custom Charts 
menu command from the Server application.

For more information, see Creating-customized-parameter-charts.

Click /MSSQLServer/AgentHostName to display the following variables:

/MSSQLServer/AgentHostName/
araAction

Changes to this variable are detected by the ConfigUpdates 
parameter.

Indicates the automatic recovery actions selected in the ARA 
Default Actions dialog box. See Using-automatic-recovery-actions.

To create or modify this variable, use the KM Commands > 
KM Admin > Setup/Configure KM > ARA Settings > 
Set Default Actions menu command from the Server application.

/MSSQLServer/AgentHostName/
araSendTo

Changes to this variable are detected by the ConfigUpdates parameter.

Lists the computer names and IP addresses to which you want 
the araSendTo option to send a message whenever one of several 
key parameters goes into an alert state

Computer names and IP addresses are separated by a new 
line character.

To create or modify this variable, use the KM Commands > 
KM Admin > Setup/Configure KM > ARA Settings > Set Send 
To Names menu command from the Server application.

For more information, see Using-automatic-recovery-actions.

/MSSQLServer/AgentHostName/
blackout

Changes to this variable are detected by the ConfigUpdates parameter.

Indicates the time periods (blackout periods) when the PATROL 
Agent does not set off any parameter alarms for the instance Values 
are expressed as follows:

• <server_name>
• <day of the week>
• <starting time in seconds after midnight>
• <duration expressed in minutes>

For example, if you set a blackout period on a server called 
SQLServer1 for Monday, starting at 1:00 a.m. for a duration of 
60 minutes, the following value would displays:

SQLServer1 Mon 3600 60

Blackout periods are separated by a new line character.

To create or modify this variable, use the KM Commands > 
KM Admin > Set Blackout menu command from the Server application.

/MSSQLServer/AgentHostName/
DBAutoDisc

Changes to this variable are detected by the ConfigUpdates parameter.

Flag indicating whether auto discovery for user monitoring is on or off

• 0 = auto discovery is off
• 1 = auto discovery is on

To create or modify this variable, use the KM Commands > 
KM Admin > User Monitoring Admin > Set DB Auto-Discovery 
menu command from the Server application.

For more information, see Monitoring-databases.

/MSSQLServer/AgentHostName/
dbInstances

Changes to this variable are detected by the ConfigUpdates parameter.

Lists the databases that you selected to monitor in the DB Autodiscovery 
dialog box Database names are separated by a new line character.

To create or modify this variable, use the 
KM Commands > KM Admin > Setup/Configure KM > Set DB Auto- Discovery 
menu command from the Server application. 

For more information, see Monitoring-databases.

/MSSQLServer/AgentHostName/

ERROR_LOG_DATA_COLLECTION_ACTIO
N

Indicates the action the ErrorLogColl parameter takes when 
a data collection problem occurs 1 = remains in an OK state.

• 2 = goes into a warning state
• 3 = goes into an alarm state
• Any other value or null = remains in OK state

/MSSQLServer/AgentHostName/

ERROR_LOG_DATA_COLLECTION_AUTO
RESET

Indicates whether the ErrorLogColl parametter is automatically 
reset to OK when it goes into an alarm or warning state

• 0 = does not automatically reset
• 1 = automatically resets
• Null or any value other than 0 or 1 = does not automatically reset

/MSSQLServer/AgentHostName/

ERROR_LOG_WARN_STRING

List of the error log strings configured to set off a warning

/MSSQLServer/AgentHostName/

ERROR_LOG_ALARM_STRING

List of the error log strings configured to set off an alarm

/MSSQLServer/AgentHostName/

ERROR_LOG_FILE_SIZE_THRESHOLD_AC
TION

Indicates whether the ErrorLogSizeThreshold parameter is set to OK, 
warn, or alarm if error log file size threshold monitoring is active and 
the error log file crosses the userdefined threshold.

• 1 = OK
• 2 = warn
• 3 = alarm
• Null or any value other than 1, 2, or 3 = threshold

Monitoring is disabled and the ErrorLogSizeThreshold parameter is not displayed.

/MSSQLServer/AgentHostName/

ERROR_LOG_FILE_SIZE_THRESHOLD_AM
OUNT

Indicates the error log size threshold in megabytes

• 0, null, or any value other than 1 = error log threshold monitoring is 
  disabled
• A number greater than 0 = error log size threshold in megabytes

/MSSQLServer/AgentHostName/

ERROR_LOG_FILE_SIZE_THRESHOLD_AU
TORESET

Indicates whether the ErrorLogsSizeThreshold parametter is 
automatically reset to OK when it goes into an alarm or warning state.

• 0 = does not automatically reset
• 1 = automatically resets
• Null or any value other than 0 or 1 = does not automatically reset

/MSSQLServer/AgentHostName/

ERROR_LOG_SHOW_FILE_SIZE_IN_MB

Indicates whether file size is displayed in megabytes (MB) or kilobytes (KB)

• 0 = KB
• 1 = MB
• Null or any value other than 0 or 1 = MB

/MSSQLServer/AgentHostName/

ERROR_LOG_FILE_SIZE_THRESHOLD_MO
NITORING

Indicates whether threshold monitoring is active for the size 
of the error log file

• 0 = not active (ErrorLogSizeThreshold parameter is not displayed)
• 1 = active (ErrorLogSizeThreshold parameter is displayed)
• Null or any value other than 0 or 1 = not active

/MSSQLServer/AgentHostName/

ERROR_LOG_FREE_DISK_SPACE_THRESH
OLD_AUTORESET

Indicates whether the ErrorLogDiskSpaceFreeThreshold parameter 
is automatically reset to OK when it goes into an alarm or warning 
state.

• 0 = does not automatically reset
• 1 = automatically resets
• Null or any value other than 0 or 1 = does not automatically 
  reset

/MSSQLServer/AgentHostName/

ERROR_LOG_FREE_DISK_SPACE_THRESH
OLD_MB

Indicates the error log disk space free threshold in megabytes.

• 0, null, or any value other than 1 = error log threshold 
  monitoring is disabled
• A number greater than 0 = error log disk space free 
  threshold in megabytes

/MSSQLServer/AgentHostName/

ERROR_LOG_FREE_DISK_SPACE_THRESH
OLD_MONITORING

Indicates whether threshold monitoring is active for the amount 
of free space on the disk where the error log resides.

• 0 = not active (ErrorLogDiskSpaceFreeThreshold parameter is not displayed)
• 1 = active (ErrorLogDiskSpaceFreeThreshold parameter is displayed)
• Null or any value other than 0 or 1 = not active

/MSSQLServer/AgentHostName/

ERROR_LOG_GENERAL_ALARM_WARNI
NG_EVERY_TIME

Indicates whether the ErrorLogUpdates parameter generates a warning 
or an alarm only the first time each user-defined string is detected or 
every time a a userdefined string is detected, no matter how often the 
same strings are detected.

• 0 = only the first time
• 1 = every time
• Null or any value other than 0 or 1 = only the first time

/MSSQLServer/AgentHostName/

ERROR_LOG_STRING_MONITORING

Indicates whether the ErrorLogUpdates parameter monitors the 
error log for updated strings

• 0 = does not monitor
• 1 = monitors
• Null or any value other than 0 or 1 = does not monitor

Regardless of this setting, the ErrorLogUpdates parameter is displayed.

/MSSQLServer/AgentHostName/
filegroup_monitoring_on_off

Changes to this variable are detected by the ConfigUpdates parameter.

Flag indicating whether filegroup and file monitoring is on or off

• 0 = filegroup and file monitoring are off
• 1 = filegroup and file monitoring are on

To create or modify this variable, use the KM Commands > 
KM Admin > Setup/Configure KM > Monitoring Setup menu 
command from the Server application. 

For more information, see Monitoring-files-and-file-groups.

/MSSQLServer/AgentHostName/
IconLabel

Changes to this variable are detected by the ConfigUpdates parameter.

Lists the name that displays beneath the instance icon.

To create or modify this variable, use the KM Commands > 
KM Admin > Setup/Configure KM > Change Icon Label 
menu command.

For more information, see Changing-the-name-of-a-SQL-Server.

/MSSQLServer/AgentHostName/
object_monitor

Changes to this variable are detected by the ConfigUpdates parameter.

Lists the objects selected for monitoring.

To create or modify this variable, use the KM Commands > 
KM Admin > Object Space Monitor menu command.

For more information, see Monitoring-objects.

/MSSQLServer/AgentHostName/
replication_monitoring_on_off

Changes to this variable are detected by the ConfigUpdates parameter.

Flag indicating whether replication monitoring is on or off

• 0 = replication monitoring is off
• 1 = replication monitoring is on

To create or modify this variable, use the KM Commands > 
KM Admin > Setup/Configure KM > Monitoring Setup.

For more information, see Monitoring-replication.

/MSSQLServer/AgentHostName/

SQL_Server_Agent_monitoring_on_off

Changes to this variable are detected by the ConfigUpdates parameter.

Flag indicating whether SQL Server Agent monitoring is on or off

• 0 = SQL Server Agent monitoring is off
• 1 = SQL Server Agent monitoring is on

To create or modify this variable, use the KM Commands > 
KM Admin > Setup/Configure KM > Monitoring Setup menu command. 

For more information, see Creating-customized-reports.

/MSSQLServer/MSSQL$ service name/

UserDefinedOSQLPath

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

Used to discover the SQL Server.

/MSSQLServer/MSSQL$ AgentHostName/

UserDefinedSQLServerName

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

Lists the names entered for use by PATROL for a SQL 
Server instance.

To create or modify this variable, use the KM Commands > 
KM Admin > Setup/Configure KM > SQL Server Name Used by 
PATROL menu command.

For more information, see Changing-a-server-instance-name.

/MSSQLServer/AgentHostName/

UserExList

Changes to this variable are detected by the ConfigUpdates parameter.

Lists the names of the users that are excluded from blocked or idle 
monitoring.

User names are separated by a new line character.

To create or modify this variable, use the KM Commands > 
KM Admin > User Monitoring Admin > Exclude Specific User 
menu command.

For more information, see Monitoring-users-and-processes.

/MSSQLServer/REGISTRY_PREFIX

The prefix path for the SQL Server installation, which is stored in the Registry

Default value is SOFTWARE\Microsoft\

If SQL Server is running in 32-bit mode on a 64-bit operating system, 
then change the value of this variable as follows:

SOFTWARE\Wow6432Node\Microsoft\

/MSSQLServer/trigger_file_update

On Windows Server 2008 and later operating systems, the 
ErrorlogColl collector parameter monitored new inputs after 
delay because the file size of the SQLServer Error log file did not 
get updated, and the ErrorlogColl collector depends on the file size of the 
SQL Server Error log file.

After you update the pconfig variable, the trigger file causes the 
Windows Server 2008 and later operating systems to set the file 
size correctly, and the MSSQL KM.

Triggers the monitoring of the new inputs in the SQL Server 
Error log file, every collection cycle.

/MSSQLServer/SQLServerInstanceName/NO_
LOCK

Stores the value that determines whether to execute the SQL 
queries with the NOLOCK option. SQL_INSTANCE_NAME is the 
name of the SQL instance in which this option will be used.

Default value is 1. SQL queries have the NOLOCK option selected 
by default.

If you want to execute the SQL queries without the NOLOCK 
option (that is, with LOCK), change thevalue of this variable to 0.

Any value other than 0 is considered to be 1.

/MSSQLServer/alarm_on_restoring

Stores the value that determines whether the DatabaseStatus 
parameter must issue a warning when the database is in 
Restoring mode.

Default value is 0. The DatabaseStatus parameter will not issue a 
warning when the database is in Restoring mode.

If you want the DatabaseStatus parameter to issue a warning 
when the database in Restoring mode, change the value of this variable to 1.

Any value other than 1 is considered to be 0.

/MSSQLServer/SQLServerInstanceName
/always_on_monitoring_on_off

It can be used for disabling the AlwaysOn instances monitoring:

• 0 = disable
• 1 = enable

By default monitoring is enabled.

Any value other than 0 is considered to be 1.

For more information, see Monitoring-AlwaysOn-High-Availability.

/MSSQLServer/REGISTRY_PREFIX

The prefix path for the SQL Server installation, which is stored in the Registry.

Default value is SOFTWARE\Microsoft\

If SQL Server is running in 32-bit mode on a 64-bit operating system, 
then change the value of this variable as follows:

SOFTWARE\Wow6432Node\Microsoft\

/MSSQLServer/SQLServerInstanceName
/NO_LOCK

Stores the value that determines whether to execute the SQL 
queries with the NOLOCK option SQLServerInstanceName 
is the name of the SQL instance in which this option will be used. 

Default value is 1. SQL queries have the NOLOCK option 
selected by default. If you want to 

Execute the SQL queries without the NOLOCK option 
(that is, with LOCK), change the value of this variable to 0. 
Any value other than 0 is considered to be 1.

/MSSQLServer/alarm_on_restoring

Stores the value that determines whether the DatabaseStatus 
parameter must issue a warning when the database is in Restoring mode. 

Default value is 0. The DatabaseStatus parameter will not 
issue a warning when the database is in Restoring mode. 

If you want the DatabaseStatus parameter to issue a warning 
when the database in Restoring mode, change the value of this 
variable to 1. 

Any value other than 1 is considered to be 0.

/MSSQLServer/SQLServerInstanceName
/always_on_monitoring_on_off

It can be used for disabling the AlwaysOn instances monitoring:

• 0 = disable
• 1 = enable

By default, monitoring is enabled. Any value other than 0 
is considered to be 1.

/MSSQLServer/trigger_file_update

On Microsoft Windows Server 2008 and later, the 
ErrorlogColl collector parameter monitored new inputs 
after delay because the file size of the SQL Server Error log 
file was not updated, and the ErrorlogColl collector depends on 
the file size of the SQL Server Error log file.

/MSSQLServer/serverInstance/dsquery

/MSSQLServer/serverInstance/column_separator

/MSSQLServer/serverInstance/DefaultDomain

/MSSQLServer/serverInstance/errorlog

/MSSQLServer/serverInstance/home

/MSSQLServer/serverInstance/masterdb

/MSSQLServer/serverInstance/RunawayCPUTime

/MSSQLServer/serverInstance/security

/MSSQLServer/serverInstance/server

/MSSQLServer/serverInstance/SQL_Executive_errorlog

/MSSQLServer/serverInstance/version

/MSSQLServer/serverInstance/DTC_monitoring_on_off

/MSSQLServer/serverInstance/SQLViewer/FullFilePath

/MSSQLServer/serverInstance/FilterIncl

/MSSQLServer/serverInstance/FilterExcl