WebSphere MQ Test

This test checks the availability of a WebSphere MQ server to handle connection requests from clients.

Target of the test : A WebSphere MQ server

Agent deploying the test : An internal agent

Outputs of the test : One set of results for every WebSphere MQ server monitored

Configurable parameters for the test
Parameter Description

Test period

How often should the test be executed .

Host

The host for which the test is to be configured.

Port

The port number at which the specified host listens.

User

If you want to login as a specific MQ user to execute this test, then specify a valid user name in the User text box. The test will fail if an invalid user name is specified here. If no such authentication is required, then this parameter can be set to 'none'.

Password

If a specific User is entered, then the password of that user has to be specified in the Password text box.

Confirm Password

Confirm the password by retyping it in the Confirm Password text box.

ServerConnChannel

The name of the server connection channel for the WebSphere MQ server. The default value is "SYSTEM.DEF.SVRCONN". If you prefer not to use this default server connection channel for monitoring purposes, then you can create a custom channel in the WebSphere MQ server and use it for monitoring. The steps for achieving this have been detailed in Creating a Custom Channel topic.

SSL Cipher Spec

This parameter is applicable only if SSL-enabled channel is used for communication to the target MQ server, if not, set this parameter to none.

A cipher suite is a set of cryptographic algorithms that are used before a client application and server exchange information over an SSL/TLS connection. It consist of sets of instructions on how to secure a network through SSL (Secure Sockets Layer) or TLS (Transport Layer Security). In this text box, provide the cipher suite that is allowed for SSL/TLS connection to the target server. By default, this parameter is set to none. To know if SSL-enabled channel is used for communication, refer to Pre-Requisites for Monitoring IBM WebSphere MQ Servers

Two Way SSL

This parameter is applicable only if SSL-enabled channel is used for communication to the target MQ server, if not, set this flag to No.

If two-way SSL authentication is used then set this flag to Yes. Set this flag to No if one-wy SSL communication is used.

Truststore

This parameter is applicable only if SSL-enabled channel is used for communication to the target MQ server, if not, set this parameter to none.

Truststore is used to store certificates from Certified Authorities (CA) that verify and authenticate the certificate presented by the server in an SSL connection. Therefore, the eG agent should have access to the truststore where the certificates are stored to authenticate and connect with the target server and collect metrics. For this, first extract the certificates from the server into the following default location /opt/egurkha/jre/lib/security/egmqsslstore.jks. To know how to create and extract the certificate into the truststore, refer toPre-Requisites for Monitoring IBM WebSphere MQ Servers. Then, provide the truststore file name in this text box. For example: egmqsslstore.jks. However, if you are using a different location to store the certificate then, provide the full path to this file in this text box. By default, none is specified against this text box.

Truststore Password

This parameter is applicable only if SSL-enabled channel is used for communication to the target MQ server, if not, set this parameter to none.

If a Truststore File name or file path is provided, then, in this text box, provide the password that is used to obtain the associated certificate details from the Truststore File.

Confirm Password

This parameter is applicable only if SSL-enabled channel is used for communication to the target MQ server, if not, set this parameter to none.

Confirm the password by retyping it in this text box.

Keystore

This parameter is applicable only if two-way SSL authentication is used, if not, set this parameter to none.

Keystore contains the private keys for the certificates that the client can provide to the server upon request. eG agent requires access to the keystore where client certificate is stored to send that to the server so that the server validates the certificate against the one contained in its trustore. For this purpose, first create the client certificate in the following default location /opt/egurkha/jre/lib/security/egmqsslstore.jks. To know how to create the certificate, refer to Pre-Requisites for Monitoring IBM WebSphere MQ Servers. Then, provide the keystore file name in this text box. For example:egmqsslstore.jks. However, if you are using a different location to store the certificate then, provide the full path to this file in this text box. By default, none is specified against this text box. If you are using one-way SSL authentication, this parameter is set to none.

Keystore Password

This parameter is applicable only if two-way SSL authentication is used, if not, set this parameter to none.

If a Keystore File name or file path is provided, then, in this text box, provide the password that is used to obtain the associated certificate details from the Keystore File.

Confirm Password

This parameter is applicable only if two-way SSL authentication is used, if not, set this parameter to none.

Confirm the password by retyping it in this text box.

Measurements made by the test
Measurement Description Measurement Unit Interpretation

MQ port availability

Reflects whether the port on which the WebSphere MQ server is listening is available for connections.

Percent

This metric takes a value of 100 if the port is available, and 0 if it is not.

MQ connection availability

Indicates whether connection to the MQ server is available for MQ clients or not.

Percent

This metric is 100 if the eG agent is able to connect to the MQ server using the parameters specified (e.g., serverConnChannel). The value of this metric is 0 if the agent is not able to connect to the MQ server. Connection problems can occur if the server is down or unavailable. Invalid user name/password can also result in connection failures.