Configuration and Discovery

The following sections describe how to configure and discover IBM MQ messaging systems for monitoring by SL1 using the IBM: MQ PowerPack:

Prerequisites for Monitoring IBM MQ

To configure the SL1 system to monitor IBM MQ messaging systems using the IBM: MQ PowerPack, you must first perform the following:

Install the IBM MQ PowerShell Snap-in for Monitoring on Windows Servers
Give all SSH credential users the "mqm" group permission

Installing the IBM MQ PowerShell Snap-In for Monitoring on Windows Servers

NOTE: Users monitoring MQ on Linux servers do not need to perform these steps.

NOTE: On 64-bit versions of Microsoft Windows, both 32-bit and 64-bit versions of Windows PowerShell are installed. SL1's collection processes using Windows PowerShell will default to using the version of powershell.exe whose folder exists first in the PATH environment variable. Because this will vary from system to system, these steps ensure the WebSphereMQ.dll file is registered for both Windows PowerShell environments.

Download the Windows PowerShell library package (mo74.zip) for IBM MQ.
Extract the contents of the zip file to your Windows server, and find the "manual" subfolder from the extracted files (under the mo74_v2.0.1_x86_x64 folder). Create a new folder on your desktop and move the files in the "manual" subfolder to that folder.
Register the IBM WebSphere MQ library for use by both 32-bit and 64-bit Windows PowerShell. To do this:

Start a 32-bit Windows PowerShell console window (this will be the Windows PowerShell (x86) application if running on a 64-bit version of Microsoft Windows) using "Run as adminstrator", run the following:

%WINDIR%\Microsoft.NET\Framework\v4.0.30319\installutil <Directory where WebsphereMQ.dll resides>\WebSphereMQ.dll

Start a 64-bit Windows PowerShell console window (this will be the Windows PowerShell application without (x86) in its program name on a 64-bit version of Microsoft Windows) using "Run as adminstrator" and run the following:

%WINDIR%\Microsoft.NET\Framework64\v4.0.30319\installutil <Directory where WebsphereMQ.dll resides>\WebSphereMQ.dll

Open your Windows PowerShell console and add the WebSphere MQ for PowerShell snap-in by running the following command:

Add-PSSnapin IBM.PowerShell.WebSphereMQ

Disabling Concurrent SSH Collection

Be advised, concurrent SSH collection is not supported with this PowerPack and should not be enabled. Concurrent SSH collection is disabled by default.

To disable concurrent SSH collection:

Go to the Process Manager page (System > Settings > Processes).
Find the "Data Collection: SSH Collector" process and select its wrench icon ().
Set the Operating State to Disabled.
Save your change.
Wait 10 minutes for all collection processes to complete.

Creating a Credential for IBM: MQ Guided Discovery

To allow SL1 to discover IBM MQ messaging systems with guided discovery, you must first create a IBM: MQ credential. This credential allows the Dynamic Applications in the IBM: MQ PowerPack to connect with an IBM MQ system.

NOTE: This IBM: MQ credential should only be used with IBM: MQ guided discovery.

To configure a credential to access an IBM: MQ system for guided discovery:

Go to the Credentials page (Manage > Credentials).
Click the Create New button and select Create Ibm mq Credential. The Create Credential modal page appears.
Enter values in the following fields:

Name. Type a name for the credential.
All Organizations. Toggle on (blue) to align the credential to all organizations, or toggle off (gray) and then select one or more specific organizations from the What organization manages this service? drop-down field to align the credential with those specific organizations. This field is required.
Hostname/IP. Type the Hostname or IP address where the database resides. This field is required.
Port. Type the Port number associated with the database you want to access with this credential. This field is required.
Username. Type the username for a user with administrator access to the IBM: MQ messaging system.
Password. Type the password for the IBM: MQ system account username.

Click Save & Close.

Creating a PowerShell Credential for IBM MQ on Windows Systems

To configure SL1 to monitor IBM MQ messaging systems on Windows systems, you must first create a PowerShell credential. This credential allows the Dynamic Applications in the IBM: MQ PowerPack to connect with an IBM MQ system.

The PowerPack includes an example PowerShell credential that you can edit for your own use.

NOTE: If you are using an SL1 system prior to version 11.1.0, the new user interface does not include the Duplicate option for sample credential(s). ScienceLogic recommends that you use the classic user interface and the Save As button to create new credentials from sample credential(s). This will prevent you from overwriting the sample credential(s).

To configure a PowerShell credential to access an IBM MQ system:

Go to the Credentials page (Manage > Credentials).
Locate the IBM MQ PowerShell - Example sample credential, click its Actions icon () and select Duplicate. A copy of the credential, called IBM MQ PowerShell - Example copy appears.
Click the Actions icon () for the IBM MQ PowerShell - Example copy credential and select Edit. The Edit Credential modal page appears.

Supply values in the following fields:

Name. Type a new name for the credential.

Hostname/IP. Keep the default value.

Username. Type the username for a user with administrator access to the IBM MQ messaging system.
Password. Type the password for the IBM MQ system account username.

Click Save & Close.

Creating a PowerShell Credential for IBM MQ on Windows Systems in the Classic SL1 User Interface

The PowerPack includes an example PowerShell credential that you can edit for your own use.

To configure a PowerShell credential to access an IBM MQ system:

Go to the Credential Management page (System > Manage > Credentials).
Locate the IBM MQ PowerShell - Example credential, then click its wrench icon (). The Edit PowerShell Credential modal page appears.

Complete the following fields:

Credential Name. Type a new name for the credential.
Hostname/IP. Keep the default value.

Username. Type the username for a user with administrator access to the IBM MQ messaging system.
Password. Type the password for the IBM MQ system account username.

Click the Save As button.

Creating an SSH/Key Credential for IBM MQ on Linux Systems

To configure SL1 to monitor IBM MQ messaging systems on Linux systems, you must first create an SSH/Key credential. This credential allows the Dynamic Applications in the IBM: MQ PowerPack to connect with an IBM MQ system.

The PowerPack includes an example SSH/Key credential that you can edit for your own use.

To configure an SSH/Key credential to access an IBM MQ system:

Go to the Credentials page (Manage > Credentials).
Locate the IBM MQ SSH - Example sample credential, click its Actions icon () and select Duplicate. A copy of the credential, called IBM MQ SSH - Example copy appears.
Click the Actions icon () for the IBM MQ SSH - Example copy credential and select Edit. The Edit Credential modal page appears.

Supply values in the following fields:

Name. Type a new name for the credential.

Hostname/IP. Keep the default value.

Username. Type the username for a user with administrator access, and who is a member of the "mgm" group, to the IBM MQ messaging system.
Password. Type the password for the IBM MQ system account username.

The private key can have a maximum of 64 characters per line. Therefore, you cannot use keys in the OpenSSH format, because that format uses 70 characters per line. When you attempt to save the credential, SL1 will validate that the private key entered is in the correct format. You will be able to save the credential only if the private key is correctly formatted.

Click Save & Close.

Creating an SSH/Key Credential for IBM MQ on Linux Systems in the SL1 Classic User Interface

The PowerPack includes an example SSH/Key credential that you can edit for your own use.

To configure an SSH/Key credential to access an IBM MQ system:

Go to the Credential Management page (System > Manage > Credentials).
Locate the IBM MQ SSH - Example credential, then click its wrench icon (). The Edit SSH/Key Credential modal page appears:

Complete the following fields:

Credential Name. Type a new name for the credential.
Hostname/IP. Keep the default value.

Username. Type the username for a user with administrator access, and who is a member of the "mgm" group, to the IBM MQ messaging system.
Password. Type the password for the IBM MQ system account username.

Click the Save As button.

Creating a SOAP/XML Credential for IBM MQ on AIX and Linux Systems

To configure SL1 to monitor IBM MQ messaging systems on your AIX and Linux systems, you must first create a SOAP/XML credential. This credential allows the Dynamic Applications in the IBM: MQ PowerPack to connect with an IBM MQ system.

NOTE: You are only required to create SOAP/XML credential for your Linux system if you want to utilize the Kornshell and sudo commands.

The PowerPack includes an example SOAP/XML credential that you can edit for your own use.

To configure a SOAP/XML credential to access an IBM MQ system:

Go to the Credentials page (Manage > Credentials).
Locate the IBM MQ SOAP - Example sample credential, click its Actions icon () and select Duplicate. A copy of the credential, called IBM MQ SOAP - Example copy appears.
Click the Actions icon () for the IBM MQ SOAP - Example copy credential and select Edit. The Edit Credential modal page appears.

Supply values in the following fields:

Name. Type a new name for the credential.
Hostname/IP. Keep the default value.
HTTP Auth User. Type the username for a user with administrator access to the IBM MQ messaging system.
HTTP Auth Password. Type the password for the IBM MQ system account username.

HTTP Headers

HTTP Headers. The following headers can be entered to use KornShell and sudo. Create a separate header for each feature:

KORNSHELL
SUDO

For all remaining fields, use the default values.
Click Save & Close .

Creating a SOAP/XML Credential for IBM MQ on AIX and Linux Systems in the Classic SL1 User Interface

The PowerPack includes an example SOAP/XML credential that you can edit for your own use.

To configure a SOAP/XML credential to access an IBM MQ system:

Go to the Credential Management page (System > Manage > Credentials).
Locate the IBM MQ SOAP - Example credential, then click its wrench icon (). The Edit SOAP/XML Credential modal page appears:

Complete the following fields:

Basic Settings

Profile Name. Type a new name for the credential.
URL. Keep the default value.
HTTP Auth User. Type the username for a user with administrator access to the IBM MQ messaging system.
HTTP Auth Password. Type the password for the IBM MQ system account username.

HTTP Headers

HTTP Headers. The following headers can be entered to use KornShell and sudo. Create a separate header for each feature:

KORNSHELL
SUDO

Click the Save As button.

IBM: MQ Guided Discovery

You can use the Guided Discovery Framework process in SL1to guide you through a variety of existing discovery types in addition to traditional SNMP discovery. This process, which is also called "guided discovery", lets you choose a discovery type based on the type of devices you want to monitor. The Guided Discovery workflow includes a button for IBM: MQ.

To run a Guided Discovery:

On the Devices page () or the Discovery Sessions page (Devices > Discovery Sessions), click the Add Devices button. The Select page appears.

Select the IBM button. Then select the IBM: MQ radio button. Additional information about the requirements for device discovery appears in the General Information pane to the right.

Click Select. The Credential Selection page appears.

Only credentials created for guided discovery will display on the Credential Selection page, and you can only use those credentials for guided discovery.

During the guided discovery process, you cannot click Next until the required fields are filled on the page, nor can you skip to future steps. However, you can revisit previous steps that you have already completed.

On the Credential Selection page of the guided discovery process, select the IBM: MQ credential that you configured, and then click Next. The Root Device Details page appears.

Complete the following fields:

Root Device Name. Type the name of the root device for the IBM: MQ root device you want to monitor.
Select the organization to add discovered devices to. Select the name of the organization to which you want to add the discovered device.
Collector Group Name. Select an existing collector group to communicate with the discovered device. This field is required.

Click Next. SL1 creates the IBM: MQ root device with the appropriate Device Class assigned to it and aligns the relevant Dynamic Applications. The Final Summary page appears.

Click Close.

The results of a guided discovery do not display on the Discovery Sessions page (Devices > Discovery Sessions).

Discovering IBM MQ Component Devices

To discover an IBM MQ messaging system:

On the Devices page () or the Discovery Sessions page (Devices > Discovery Sessions), click the Add Devices button. The Select page appears:

Click the Unguided Network Discovery button. Additional information about the requirements for discovery appears in the General Information pane to the right.

Click Select. The Add Devices page appears.
Complete the following fields:

Name. Type a unique name for this discovery session. This name is displayed in the list of discovery sessions on the Discovery Sessions tab.
Description. Optional. Type a short description of the discovery session. You can use the text in this description to search for the discovery session on the Discovery Sessions tab.
Select the organization to add discovered devices to. Select the name of the organization to which you want to add the discovered devices.

Click Next. The Credentials page of the Add Devices wizard appears:

On the Credentials page, locate and select the PowerShell, SOAP/XML, or SSH/Key credential you created for the IBM MQ system.

Click Next. The Discovery Session Details page of the Add Devices wizard appears:

Complete the following fields:

List of IPs/Hostnames. Type the IP addresses for the IBM MQ messaging system.

Which collector will monitor these devices?. Select an existing collector to monitor the discovered devices. Required.
Run after save. Select this option to run this discovery session as soon as you save the session.

In the Advanced options section, click the down arrow icon () to complete the following fields:

Discover Non-SNMP. Enable this setting.
Model Devices. Enable this setting.

Click Save and Run if you enabled the Run after save setting, or Save and Close to save the discovery session. The Discovery Sessions page (Devices > Discovery Sessions) displays the new discovery session.
If you selected the Run after save option on this page, the discovery session runs, and the Discovery Logs page displays any relevant log messages. If the discovery session locates and adds any devices, the Discovery Logs page includes a link to the Device Investigator page for the discovered device.

Discovering IBM Component Devices in the SL1 Classic User Interface

To discover an IBM MQ messaging system:

Go to the Discovery Control Panel page (System > Manage > Classic Discovery).
In the Discovery Control Panel, click the Create button. The Discovery Session Editor page appears.

In the Discovery Session Editor page, complete the following fields:

Name. Type a name for the discovery session.
IP Address/Hostname Discovery List. Type the IP address for the IBM MQ messaging system.

Other Credentials. Select the PowerShell or SSH/Key credential you created for the IBM MQ messaging system.
Discover Non-SNMP. Select this checkbox.
Model Devices. Select this checkbox.

Optionally, you can enter values in the other fields on this page. For more information about the other fields on this page, see the Discovery & Credentials section.
Click the Save button to save the discovery session and then close the Discovery Session Editor window.
The discovery session you created appears at the top of the Discovery Control Panel page. Click its lightning-bolt icon () to run the discovery session.
The Discovery Session window appears. When the cluster root device(s) are discovered, click the device icon () to view the Device Properties page for each device.

Verifying Discovery and Dynamic Application Alignment

To verify that SL1 has automatically aligned the correct Dynamic Applications during discovery:

After discovery has completed, click the device icon for the IBM MQ device (). From the Device Properties page for the IBM MQ device, click the Collections tab. The Dynamic Application Collections page appears.
All applicable Dynamic Applications for the device are automatically aligned during discovery.

It can take several minutes after the discovery session has completed for Dynamic Applications to appear in the Dynamic Application Collections page.

You should see the following Dynamic Applications aligned to the IBM MQ root device:

IBM: MQ Discovery

You should see the following Dynamic Applications aligned to the IBM MQ server:

IBM: MQ Queue Manager Discovery

You should see the following Dynamic Applications aligned to the IBM MQ queue managers:

IBM: MQ Cluster Channel Configuration

NOTE: For Windows users, in the "IBM: MQ Cluster Channel Configuration" Dynamic Application, when a channel is configured with a cluster and that cluster is deleted, the status for that cluster cannot be returned.

NOTE: For Windows users, in the "IBM: MQ Cluster Channel Configuration" Dynamic Application, the "CLUSSDRA" and "CLUSSDRB" are shown as "CLUSSDR".

IBM: MQ Channel Configuration
IBM: MQ Queue Discovery

NOTE: For Windows users, the "IBM: MQ Discovery" Dynamic Application currently does not return "Connections", "Parent Queue Manager", or "Start Date" metrics. On some MQ installations, SL1 may be unable to collect the "Standby Host" property.

IBM: MQ Queue Manager Configuration

NOTE: For Windows users, the "IBM: MQ Queue Manager Configuration" Dynamic Application currently does not return "Connections", "Parent Queue Manager", or "Start Date" metrics.

You should see the following Dynamic Applications aligned to the IBM MQ queues:

IBM: MQ Queue Configuration
IBM: MQ Queue Performance

If the listed Dynamic Applications have not been automatically aligned during discovery, you can align them manually. To do so, perform the following steps:

Click the Action button and then select Add Dynamic Application. The Dynamic Application Alignment page appears:
In the Dynamic Applications field, select the Dynamic Application you want to align.
In the Credentials field, select the appropriate IBM: MQ credential.
Click the Save button.
Repeat steps 1-4 for the other unaligned Dynamic Applications.

Configuring the IBM: MQ Queue Discovery Snippet

The "IBM: MQ Queue Discovery" Dynamic Application snippet allows you to customize the list of queue names and types of queues that SL1 will discover. Up to 20 queue names can be specified, and those names will be discovered under each queue manager where they are found.

For specifying queue types, an integer can be specified as one item in the list, and the allowed values for type are:

1 : Dead letter queue will be discovered

2 : Transmission queues will be discovered

To edit the snippet:

Go to the Dynamic Applications Manager page (System > Manage > Applications).
Find the "IBM: MQ Queue Discovery" Dynamic Application and click its wrench icon ().
In the Dynamic Applications Properties Editor, click the Snippets tab.
In the Dynamic Applications Snippet Editor & Registry page, click the wrench icon () of the "Discover-Queues" snippet.
The content of the snippet will appear. Add the following text to the snippet to customize the list of queue names and queue types that can be discovered:

QUEUES_TO_DISCOVER = ['<queue name>','<queue name>','<queue type>']

Use commas to separate queue names and queue types.

Configuring the IBM: MQ Error Log Configuration Snippet

By default, only some errors are monitored and alerted in SL1. The IDs of the errors supported can be found in the snippet of the "IBM: MQ Error Log Configuration" Dynamic Application. You can add other error messages by adding the alert ID to the ALERT_ID_LIST list in the snippet.

To edit the snippet:

Go to the Dynamic Applications Manager page (System > Manage > Applications).
Find the "IBM: MQ Error Log Configuration" Dynamic Application and click its wrench icon ().
In the Dynamic Applications Properties Editor, click the Snippets tab.
In the Dynamic Applications Snippet Editor & Registry page, click the wrench icon () of the "Get-ErrorLogRecords" snippet.
The content of the snippet will appear. Add the alert IDs you want added to the ALERT_ID_LIST in the snippet:

Viewing IBM MQ Component Devices

In addition to the Devices page, you can view the IBM MQ system and all associated component devices in the following places in the user interface:

The Device Investigator Map page (click Map in the Device Investigator page) displays a map of a particular device and all of the devices with which it has parent-child relationships. Double-clicking any of the listed devices reloads the page to make the selected device the primary device

The Device Components page (Devices > Device Components) displays a list of all root devices and component devices discovered by SL1 in an indented view, so you can easily view the hierarchy and relationships between child devices, parent devices, and root devices. To view the component devices associated with a Kubernetes cluster, find the cluster device and click its plus icon (+).

The Component Map page (Classic Maps > Device Maps > Components) allows you to view devices by root node and view the relationships between root nodes, parent components, and child components in a map. This makes it easy to visualize and manage root nodes and their components. SL1 automatically updates the Component Map as new component devices are discovered. SL1 also updates each map with the latest status and event information. To view the map for a Kubernetes cluster, go to Classic Maps > Device Maps > Components, and select the map from the list in the left NavBar. To learn more about the Component Map page, see the section on Views.