Agent configuration variables

Set the level of detail required in the DB2 logs.

Valid values:

• INFO
• DEBUG

(Optional)

Every 30 seconds, the KM checks if the file registered in this pconfig variable exists or not.

• If the file exists, the KM willshutdownand destroy all the environments below the DB2 icon in the console. 
• If the file does not exist, the KM will discover the environments.

Note: The shutdown file must be located on the PATROL Agent machine.

Lists the DB2 environment names added for monitoring.

Describes the selected type of monitoring.

• Availability=1
• DB2 system controlled=2
• Customer collection data Selection=3

Lists the monitored DB2 group numbers.

Comma separated list.

Example:

If you insert number 1, 2, then DB2 group number 1 and 2 will be monitored. Each group exists in its respective directory at Patrol3/pso/xml.

(Optional) Set this value to true to enable monitoring of SQL Queries response time.

(Optional) Disables the creation of the instance on the PATROL tree view.

(Optional) Disables the creation of the instance on the PATROL tree view.

(Optional) Generates diagnostic report.

0 = Do not generate the report

1 = Generates report

(Optional) Log level for the DB2 Java collector.

Valid values are:

• 3 = Info (default)
• 4 = Fine
• 5 = Finest

Describes the monitoring type of DB2 environment.

Valid values are:

• Local: local monitoring
• UNIX: remote unix monitoring
•  Windows: remote windows monitoring

(Optional) Path to the monitored db2 installation home directory.

Valid values are:

• Full DB2 path
• DB2PATH environment variable
• Leave blank

If the DB2PATH is not defined as an environment variable in your DB2 system or if this field is left blank, the KM will monitor the default DB2 installation home if it exists in the XML file and your DB2 system, Patrol3/pso/conf/xml/defaultDB2InstallationHomeList.xml.

(Optional) Lists the monitored DB2 instances.

Comma separated list. Regular expressions are not supported.

If this field is left blank, the KM will monitor all the DB2 instances in the environment.

Stores theuser namethat will be used to monitor the DB2 instances using JDBC connection.

In local monitoring the user name will be the user that runs the DB2 clp command. This variable is mandatory for local monitoring and optional for remote monitoring.

In remote monitoring, if this field is left blank, the KM will use the remoteHostUser details.

/SecureStore/DB2_MAIN/<<environment name>>_db2Password_Pass

Stores the DB2 user password used to monitor the DB2 instances.

The value must be entered in the following format:

DB2_MAIN;DB2_ENVIRONMENT;DB2_SETUPWIN;DB2_SETUPUNIX;DB2_SETUPLOCAL;DB2_SETUPJDBC/<<The db2 user password that will be used to monitor the db2 instances>>

Indicates the change in the DB2 password.

Valid values are:

• 1 = indicates that the DB2 password is changed.
• 0 = indicates that the DB2 password is not changed.

Stores the user name that is used to connect to the remote host.

/SecureStore/DB2_MAIN/<<environment name>>_remoteHostPassword_Pass

The value must be entered in the following format:

 DB2_MAIN;DB2_ENVIRONMENT;DB2_SETUPWIN;DB2_SETUPUNIX;DB2_SETUPLOCAL;DB2_SETUPJDBC/<<The remote host user's password that will be used to connect to remote host>>

Indicates the change in the remote DB2 host password.

Valid values are:

• 1 = indicates that the remote DB2 host password is changed.
• 0 = indicates that the remote DB2 host password is not changed.

The remote host port number of the monitored DB2 environment. This field must be used only in remote UNIX or remote Windows monitoring.

Example:

In UNIX environment with SSH client, this field can be SSH port 22.

Stores the remote host authentication details for power shell windows connection. This field must be used only in remote Windows monitoring.

Valid values:

• Negotiate = 1
• Basic = 2
• Kerberos = 3

Stores the remote host connection details. This field must be used only in remote windows monitoring.

Valid values:

1 = False

2 = True

Stores the DB2 diag log filter list of a DB2 environment.

For PATROL for IBM DB2 9.6.10 and earlier, separate names by using the newline character (\n).

For PATROL for IBM DB2 9.6.10.01 and later, separate names by using <BMC_SEP>.

Valid format:

[<state: Either of these values (PRUNE,INFORMATION,WARN,ALARM])> <filter: Can contain anything the IBM db2diag tool support>]

Example:  

WARN -lastlines 100 -l Warning

On applying this filter the specific state is displayed in the DiagLogOK parameter and an annotation is displayed in the parameter graph.

For PATROL for IBM DB2 9.6.10 and earlier, separate names by using the newline character (\n).

For PATROL for IBM DB2 9.6.10.01 and later, separate names by using <BMC_SEP>.

Valid format:

[<state: Either of these values (PRUNE,INFORMATION,WARN,ALARM])> <filter: Can contain anything the IBM db2diag tool support>]

Example:

WARN -lastlines 100 -l Warning

On applying this filter the specific state will be displayed in the DiagLogOK parameter and an annotation will be displayed in the parameter graph.

Stores DB2 collector cycle, for each collector existing in <<Patrol installation home>>/Patrol3/pso/conf/xml/collectors.xml.

(Optional) Set this value to true to add the collector output to the cache thread.

If this variable is false, the collector will send the output directly to PATROL Agent without caching the data. This variable is defined in the $PATROL_HOME/Patrol3/pso/conf/pso.properties file.

Note: BMC recommends that you do not modify this variable without assistance from BMC customer support.

Valid values:

• True or 1
• False or 0

Stores the list of tablespace state values in hexadecimal.

Note: The TblspState parameter of any tablespace related to the specific instance will be in warn state if its value exists in the list defined in this pconfig variable. Hex values are integer values. You can add the prefix '0x' to any value. Example for the stateWarnList is '2,0x8,0xc'.

Stores the list of tablespace state values in hexadecimal.

Note: The TblspState parameter of any tablespace related to the specific instance will be in alarm state if its value exists in the list defined in this pconfig variable.Hex values are integer values. You can add the prefix '0x' to any value. Example for the stateAlertList is '2,0x8,0xc'.

Comma separated list.
Example: SQL1116N,SQL1035N,SQL1032N

If failed to connect to the database, the KM will check for the error code that is equal to the SQL code defined in the list. If the error code matches any of the SQL code, the value of the parameter will be set to warn state.

It defines SQL code list and the ConnToDBOK parameter will not be set to an alarm state.

/PSO/DB2/<<environment name>>/<<DB2 instance name>>/<<DB2 database name>>/tableSpaces/stateWarnList

Stores the list of tablespace state values in hexadecimal.

 Note: The TblspState parameter of any tablespace related to the specific instance will be in alarm state if its value exists in the list defined in this pconfig variable.Hex values are integer values. You can add the prefix '0x' to any value. Example for the stateAlertList is '2,0x8,0xc'.

/PSO/DB2/<<environment name>>/<<DB2 instance name>>/<<DB2 database name>>/tableSpaces/stateAlertList

Stores the list of tablespace state values in hexadecimal.

Note: The TblspState parameter of any tablespace related to the specific instance will be in alarm state if its value exists in the list defined in this pconfig variable.Hex values are integer values. You can add the prefix '0x' to any value. Example for the stateAlertList is '2,0x8,0xc'.

Stores the list of tablespace state values in hexadecimal.

Note: The TblspState parameter of any tablespace related to the specific instance will be in alarm state if its value exists in the list defined in this pconfig variable.Hex values are integer values. You can add the prefix '0x' to any value. Example for the stateAlertList is '2,0x8,0xc'.

Stores the list of tablespace state values in hexadecimal.

Note: The TblspState parameter of any tablespace related to the specific instance will be in alarm state if its value exists in the list defined in this pconfig variable.Hex values are integer values. You can add the prefix '0x' to any value. Example for the stateAlertList is '2,0x8,0xc'.

Stores list of the databases that are included in the data collection.

Stores list of the databases that are excluded from data collection.

Note: If the pconfig variable includedDatabases is defined then this pconfig variable is not relevant.

Stores the list of partitions numbers that will not be collected.

Note: If the pconfig variable includedPartitions of the instance is defined then this pconfig variable is not relevant.

/PSO/DB2/<<environment name>>/CustomSQL/<<id>>/id

Stores the id name of the custom SQL query.

/PSO/DB2/<<environment name>>/CustomSQL/<<id>>/instanceName

Stores the instance name of the DB2 server that you want to configure for custom SQL queries.

/PSO/DB2/<<environment name>>/CustomSQL/<<id>>/dbName

Stores the database name of the DB2 server that you want to configure for custom SQL queries.

/PSO/DB2/<<environment name>>/CustomSQL/<<id>>/queryName

Stores the custom SQL query that will be used for execution.

/PSO/DB2/<<environment name>>/CustomSQL/<<id>>/cycle

Stores the collection cycle time in minutes of the DB2 SQL query.

/PSO/DB2/<<environment name>>/CustomSQL/<<id>>/update

Updates the custom query.

Valid value:

1 = when creating a new custom sql query from PCM.

/PSO/DB2/<<environment name>>/i18n/lang

Stores the locale of DB2 environment in the format, <language>_<country>.

Example:

For EN_US, if you do not insert this pconfig variable, then the current locale of the Java collector will be used. If the current locale from java is not retrieved, then the default locale EN_US will be used.

/PSO/DB2/<<environment name>>/javaHome

Stores the Java home path that will be used to run the Java collector.

JAVA_HOME environment variable is supported.

/PSO/DB2/<<environment name>>/localUser

Stores the localuser namedetails. These details will be used to run the Java collector.

/SecureStore/DB2_MAIN/<<environment name>>_localPassword_Pass

Stores the local user password details. These details will be used to run the Java collector.

The value must be entered in the following format:

DB2_MAIN;DB2_ENVIRONMENT;DB2_SETUPWIN;DB2_SETUPUNIX;DB2_SETUPLOCAL;DB2_SETUPJDBC/<<The local user's password that will be used to run the java collector>>

/PSO/DB2/<<environment name>>/isLocalPasswordChange

Indicates if the DB2 local password has been changed.

Valid values

• 1 = indicates that the local password is changed.
• 0 = indicates that there is no change to the local password.

Every 1 minute, the KM checks if the file registered in this pconfig variable exists or not.

If the file exist,

• The km will shutdowna specific DB2 instance instance name that appears in the pconfig variable path
• This specific DB2 instance will be discovered as expected

Note: The shutdown file must be located on the DB2 machine.

(Optional) The securityMechanism used to connect to database.

• Mention 13 as the value to support ENCRYPTED_USER_PASSWORD_AND_DATA_SECURITY.
• Leave the value empty to connect with the default securityMechanism, use this variable ONLY if you use IBM JDK 6 and above

(Optional) Set this variable to 1 or true if you do not want to discover remote databases.

 Valid values:

• True or 1 = will not discover remote databases
• False or 0 = will discover remote databases

Valid values:

• 0 – Remote HADR databases are discovered
• 1 – Remote HADR databases are not discovered

/PSO/DB2/<<environment name>>/isPConfigDestroyTree

(Optional) Set this variable to 1 or true if you want to destroy the DB2 environment and rebuild it from the beginning

Note: Use this variable when you want to delete pconfigvariable like filters, shutdownpath and other variables.

 Valid values:

• True or 1 = will destroy the DB2 environment

(Optional)

Set the timeout needed to read from the channels in seconds.

Note: Restart the PATROL Agent to apply these changes.
BMC recommends that you do not modify this variable without assistance from BMC customer support.