Using the environment checker utility

The environment checker utility is a tool that helps you identify the connectivity issues between the PATROL Agent, the communication channel, and the JAVA process. This utility communicates with the JAVA process without the need to connect to a PATROL Agent.

When you face issues while connecting to the DB2 environment, it is difficult to identify the exact problem. It takes some time to understand if the issue is related to the PATROL Agent and the channel between the PATROL Agent and the JAVA process, or the issue is related to the JAVA process and the connection between the monitoring environment.

The environment checker tool acts like a JAVA client and connects directly to the DB2 environment. When you provide the connection details to this utility, it tries to connect and discover the DB2 system. Based on the result you can know if the issue was related to the environment configuration or the PATROL Agent.

The environment checker utility is located at:

• <<Patrol home>>/Patrol3/pso/envChecker.sh (UNIX)

• <<Patrol home>>\Patrol3\pso\envChecker.bat (Windows)

Using the environment checker utility

• Before you begin
• DB2 remote UNIX monitoring
• DB2 remote Windows monitoring
• DB2 local monitoring
• DB2 JDBC monitoring

Before you begin

• Ensure that the PATROL_HOME environment variable is defined
• Ensure that the JAVA_HOME environment variable is defined and set to JRE 1.6 and later versions

1. Open command prompt or shell
2. Run the script <<Patrol home>>\Patrol3\pso\envChecker.bat (Use .sh script file for UNIX)
3. Provide the inputs to connect to the DB2 system

DB2 remote UNIX monitoring

1. Monitor Type <1 = Instance/2 = Database <default 1 = Instance>>: Select the option as per your monitoring requirements. To monitor an instance and all the databases within the instance, select 1. To monitor a single database, select 2. 
2. Connection Vendor <1 = Windows/2 = UNIX/3 = Local <default 3 = Local>>: Select the connection vendor as per your requirements. 
3. Host/IP: Enter a valid remote hostname or an IP address. BMC recommends providing only alphanumeric characters in environment name. Each environment can contain a single unique host name.
4. Port <default 22>: Enter the SSH remote port number. The remote port number is a 2 digit number. Default port number is 22.
5. SSH Username: Enter the name of a user with permissions to run DB2 commands. The user should have SYSMON user with DATAACCESS privileges.
6. SSH Password: Enter a password to connect to the remote host.
7. Instances List separated by comma <default all instances>: Enter a comma-separated list of database instance names which you want to monitor.
8. DB2 Installation location <default /opt/ibm/db2/v10.5>: Enter the path to the installation base directory. Files are installed in the following directories under the installation base. For example, C:\Program Files\IBM\SQLLIB (Windows) and /opt/ibm/db2/V10.5 (UNIX)
   
9. DB Username <default SSH Username>: Enter the name of a user to connect to the DB2 environment. If this field is left blank, then the Remote SSH connection details user and password will be used.
   
   

DB2 remote Windows monitoring

1. Monitor Type <1 = Instance/2 = Database <default 1 = Instance>>: Select the option as per your monitoring requirements. To monitor an instance and all the databases within the instance, select 1. To monitor a single database, select 2. 
2. Connection Vendor <1 = Windows/2 = UNIX/3 = Local <default 3 = Local>>: Select the connection vendor as per your requirements. 
3. Host/IP: Enter a valid remote hostname or an IP address. BMC recommends providing only alphanumeric characters in environment name. Each environment can contain a single unique host name.
4. Port <default 5985>: Enter the Power Shell remote port number. Default port number is 5985.
5. PShell Username: Enter the name of a user with permissions to run DB2 commands. The user should have SYSMON user with DATAACCESS privileges.
6. PShell Password: Enter a password to connect to the remote host.
7. Protocol Connection <1 = HTTP/2 = HTTPS <default 1 = HTTP>: Select the protocol that will be used for connection. By default, HTTP protocol is used for connection.
8. Auth Type <1 = Negotiate/2 = Basic/ 3 = Kerberos <default 1 = Negotiate>>: Select an authentication protocol to connect to the remote host:
   1. Negotiate - Negotiate authentication automatically selects between the Kerberos protocol and NTLM authentication, depending on availability.
   2. Basic - Basic authentication sends a Base64-encoded string that contains a username and password for the client. Base64 is not a form of encryption and should be considered the same as sending the username and password in clear text. If a resource needs to be protected, strongly consider using an authentication scheme other than basic authentication.
   3. Kerberos - The Kerberos protocol is used if it is available; otherwise, NTLM is tried. Kerberos authentication significantly improves upon NTLM. Kerberos authentication is both faster than NTLM and allows the use of mutual authentication and delegation of credentials to remote machines.
      
9. Instances List separated by comma <default all instances>: Enter a comma-separated list of database instance names which you want to monitor.
10. DB2 Installation location <default C:\Program Files\IBM\SQLLIB>: Enter the path to the installation base directory. Files are installed to the following directories under the installation base. For example, C:\Program Files\IBM\SQLLIB (Windows) and /opt/ibm/db2/V10.5 (UNIX)
11. DB Username <default PShell Username>: Enter the name of a user to connect to the DB2 environment. If this field is left blank, then the Remote Power Shell connection details user and password will be used.
12. Operation Timeout <defualt 5 min>: Ignore this field. 
13. Open Session-Timeout <default 1 min>: Ignore this field. 
    
    

DB2 local monitoring

1. Monitor Type <1 = Instance/2 = Database <default 1 = Instance>>: Select the option as per your monitoring requirements. To monitor an instance and all the databases within the instance, select 1. To monitor a single database, select 2. 
2. Connection Vendor <1 = Windows/2 = UNIX/3 = Local <default 3 = Local>>: Select the connection vendor as per your requirements. 
3. Instances List separated by comma <default all instances>: Enter a comma-separated list of database instance names which you want to monitor.
4. DB2 Installation location <default /opt/ibm/db2/v10.5>: Enter the path to the installation base directory. Files are installed to the following directories under the installation base. For example, C:\Program Files\IBM\SQLLIB (Windows) and /opt/ibm/db2/V10.5 (UNIX)
5. DB Username: Enter the name of a user to connect to the DB2 environment.
   
6. DB2 Password: Enter a password to connect to the host.
   
   

DB2 JDBC monitoring

1. Monitor Type <1 = Instance/2 = Database <default 1 = Instance>>: Select the option as per your monitoring requirements. To monitor an instance and all the databases within the instance, select 1. To monitor a single database, select 2. 
2. Host/IP: Enter a valid remote hostname or an IP address. BMC recommends providing only alphanumeric characters in environment name. Each environment can contain a single unique host name.
3. Port <default 50000>: Enter the port number. The remote database port number is a 5 digit number. Default port number is 50000.
4. Username: Enter the name of a user with permissions to run DB2 commands. The user should have SYSMON user with DATAACCESS privileges.
5. Password: Enter a password to connect to the host.
6. DB Name: Enter a unique name for the database. BMC recommends you to provide only alphanumeric characters in the database name.