You must assign an instance name to the IBM® Integration Bus agent and configure the agent before it can start monitoring your IBM Integration Bus environment.
Before you begin
Before you can start the
IBM Integration Bus agent,
ensure that the user ID that is used to start and stop the agent belongs to the
mqm and
mqbrkrs user groups.
Important: The
IBM Integration Bus agent requires some WebSphere® MQ) libraries when it
starts to monitor the broker. If you have IBM MQ (WebSphere MQ) installed on the system, add the IBM MQ (WebSphere MQ)
library path to the beginning of the
PATH environment variable. For example, if
the installation path of IBM MQ (WebSphere MQ) is
C:\IBM\WMQ75, add
C:\IBM\WMQ75\bin to the beginning of the
PATH environment
variable of your Windows system.
Remember to restart the
Windows system after you change the environment
variable.
About this task
The IBM Integration Bus agent is a multiple instance agent; you must create the first instance and start the agent manually. You can choose to configure the agent with or without interactions.
Remember: On Windows systems, you can configure
the agent only by editing the silent response file and then running the configuration script.
Important: If you also installed ITCAM Agent for WebSphere Message Broker, which is delivered as one of the
ITCAM for Applications product, on the same system as
the IBM Integration Bus agent, which is delivered in
Performance Management, do not use them to monitor the
same broker on the system.
Procedure
- To configure the agent by editing the silent response file and running the script with no interaction, complete the following steps:
- Open the iib_silent_config.txt file in a text editor.
- install_dir/samples/iib_silent_config.txt
- install_dir\tmaitm6_x64\samples\iib_silent_config.txt
where install_dir is the installation directory of the IBM Integration Bus agent. The default installation directory is as follows:- /opt/ibm/apm/agent
- C:\IBM\APM
- For the agentId parameter, you can specify the agent ID as a short
identifier for the agent. The format is an alphanumeric string with a maximum length of 8
characters.
The managed system name includes the agent ID that you specify, for example,
monitoredbrokername:agentID:KQIB,
where monitoredbrokername is the name of the monitored broker. In the following
circumstances, the agent ID is required for each IBM Integration Bus agent to create a unique managed system
name:
- You are running more than one IBM Integration Bus agent
on the same system.
- You are running more than one monitored broker with the same name on different systems.
- To monitor IBM Integration Bus V10 brokers, specify the installation directory of IBM Integration Bus V10 for the defaultWMBInstallDirectory parameter. Otherwise, the IBM Integration Bus agent cannot automatically discover the version 10 brokers.
The defaultWMBInstallDirectory parameter in the silent
response file is used to monitor version 10 brokers. For brokers of earlier versions, this parameter
is not required.
Remember: You can specify only one installation directory for the
defaultWMBInstallDirectory parameter. If you installed IBM Integration Bus V10 in different directories and you want to monitor them all,
create multiple agent instances and specify one installation directory of IBM Integration Bus V10 for each agent instance.
- Optional: Specify whether you want to use this agent to monitor only some specific brokers.
By default, all brokers that are running on the same host system as the IBM Integration Bus agent are monitored, as determined by
self-discovery. To monitor specific brokers, set the collectNodeData and
WMBInstallDirectory parameters for each broker that you want to monitor.
- collectNodeData
- Specifies whether node definition data is collected for the monitored broker. The syntax is
collectNodeData.brkr_name=NO|YES, where
brkr_name is the name of the broker.
- The default value is NO. It is recommended to use the default value because node definition data
is not supported to be displayed on the Performance Management console.
- WMBInstallDirectory
- The installation directory of the broker to be monitored. The syntax is
WMBInstallDirectory.brkr_name=broker_install_dir,
where broker_install_dir is the installation directory of the broker to be
monitored.
Remember: For a version 10 broker, the WMBInstallDirectory
parameter can override the defaultWMBInstallDirectory parameter that you set in
the previous step.
For example, to monitor only two brokers that are named BK1 and BK2, set the parameters as
follows:
collectNodeData.BK1=NO
collectNodeData.BK2=NO
WMBInstallDirectory.BK1=BK1_install_dir
WMBInstallDirectory.BK2=BK2_install_dir
- To monitor brokers that are earlier than IBM Integration
Bus V10, specify the 64-bit library path of IBM MQ (WebSphere MQ) for the WMQLIBPATH
parameter.
Remember: If your brokers use different versions of queue managers, specify the latest
version of the IBM MQ
(WebSphere MQ) 64-bit library path for this parameter.
- Save and close the iib_silent_config.txt file, and then enter the following command:
- install_dir/bin/iib-agent.sh config instance_name
path_to_responsefile
- install_dir\bin\iib-agent.bat config instance_name
path_to_responsefile
where instance_name is the name of the instance that you configure, and path_to_responsefile is the full path of the silent response file iib_silent_config.txt.
- To start the agent, enter the following command:
- To configure the agent by running the script and responding to prompts, complete the following steps:
- Enter the following command:
install_dir/bin/iib-agent.sh config instance_name
where instance_name is the name that you want to give to the agent
instance.
- When prompted for the Agent Id parameter, press Enter to skip configuring
this parameter or specify an alphanumeric string with a maximum length of 8 characters.
The managed system name includes the agent ID that you specify, for example,
monitoredbrokername:agentID:KQIB,
where monitoredbrokername is the name of the monitored broker. In the following
circumstances, the agent ID is required for each IBM Integration Bus agent to create a unique managed system
name:
- You are running more than one IBM Integration Bus agent
on the same system.
- You are running more than one monitored broker with the same name on different systems.
- To monitor brokers of IBM Integration Bus V10, when
prompted for the IIB version 10 Install Directory parameter, specify the
installation directory of IBM Integration Bus V10. Otherwise,
the IBM Integration Bus agent cannot automatically discover
the brokers of version 10.
Remember: You can specify only one installation directory for the IIB version
10 Install Directory parameter. If you installed IBM Integration Bus V10 in different directories and you want to monitor them all, create
multiple agent instances and specify one installation directory of IBM Integration Bus V10 for each agent instance.
- Optional: Use the Monitored Broker Settings section to specify whether you want to
use this agent to monitor only some specific brokers.
By default, all brokers that are running on the same host system as the IBM Integration Bus agent are monitored, as determined by
self-discovery. If you want the agent to monitor some specific brokers, specify the name of the
broker that you want to monitor and set the Collect Node Data setting to No,
which is the default value, in the Monitored Broker Settings section. There
can be multiple Monitored Broker Settings sections. Each section controls the
monitoring settings for one broker.
Tip: You
can specify more than one
Monitored Broker Settings section. When you edit
the
Monitored Broker Settings section, the following options are available:
- Add: Create a Monitored Broker Settings section to configure for another
broker.
- Edit: Modify the settings of current Monitored Broker Settings
section.
- Del: Delete the current Monitored Broker Settings section.
- Next: Move to the next Monitored Broker Settings section.
- Exit: Exit the Monitored Broker Settings configuration.
- When prompted for the Current WebSphere MQ library path parameter, press
Enter to accept the default value, which is the 64-bit library path of IBM MQ (WebSphere MQ) automatically
discovered by the agent. If no default value is displayed, you must provide the 64-bit library path
of IBM MQ
(WebSphere MQ) before you proceed to the next step.
Remember: If your brokers use different versions of queue managers, specify the latest
version of the IBM MQ
(WebSphere MQ) 64-bit library path for this parameter.
- To start the agent, enter the following command:
install_dir/bin/iib-agent.sh start instance_name
Results
Now, you can verify that the
IBM Integration Bus agent data is displayed in the
Performance Management console.
For
instructions on how to start the Performance Management
console, see Starting the Performance Management console.Remember: Whenever you update or migrate a monitored broker, you must restart
the IBM Integration Bus agent after the broker upgrade or
migration.