You must first install and configure the IBM® WebSphere® Simple Network Management Protocol (SNMP) Capability on IBM WebSphere Application Server to enable the collection of performance metrics.
Before you install the IBM WebSphere SNMP Capability, confirm that WebSphere Application Server Version is 8.5 or above is installed with a stand-alone thin client.
The IBM WebSphere Snmp Agent files are located in the <WAS_HOME>/optionalLibraries/IBM/SNMPAgent directory:
The IBM WebSphere Snmp Agent must be created as a generic server using the provided template configuration archive file, which is <WAS_HOME>/optionalLibraries/IBM/SNMPAgent/templateSnmpAgentServer.car.
To install the IBM WebSphere Snmp Agent, perform the following steps:
One or more IBM WebSphere Snmp agents can be created as generic servers connecting to different application servers and administration servers, such as deployment manager, NodeAgent and AdminAgent.
Configure the IBM WebSphere Snmp Agent by modifying three xml files: agentConfig.xml, jmxConfig.xml and trapConfig.xml. These xml files are located in the WebSphere configuration repository under the cells/<tcell name>;/nodes/<tnode name>/servers/<server name> directory.
Before you configure the three xml files, you must first enable Performance Monitoring Infrastructure (PMI) monitoring from the administrative console on the required server.
<!--sample agentConfig.xml -->
<agentConfig name="WsSNMPAgent" logFile="log/WsSNMP.log"
registryPort = "1107" agents = "WsSNMP">
<metadata
mibsFolder = "mibs"
mibs="nh-smi.smi,rfc1213-mib.mib,rmon-mib.mib,snmpv2-tc.mib,websphere-mib.mib” />ok
<WsSNMP ipAddress = "localhost" snmpPort = "161"
views="V1"
Behaviors="getScalars,getCollection" jmxConfigFile="jmxConfig.xml" user="nick2" authMode="MD5" password="password">
<V1
jmacfgFiles = "oid.out"
trapConfig = "config/trapConfig.xml"/>
<getScalars
oid = "1.3.6.1.4.1.1977.22.10.1.0"
class = "com.ibm. ws.pmi.snmp.behaviors.GetScalarsBehavior"/>
<getCollection
oid = "1.3.6.1.4.1.1977.22.10.10.1.2"
class = "com.ibm. ws.pmi.snmp.behaviors.GetCollectionBehavior"/>
<…..>
</WsTSNMP>
</agentConfig>
Attribute Name | Description |
---|---|
registryPort | The port number to register the bootstrap agent
with the Java RMI service registry.
This attribute is present in the <agentConfig> tag. Note: Specify
a port number above 1024 to avoid using reserved ports.
|
ipAddress | The address of the host on which the IBM WebSphere Snmp Agent runs. The same value
should be set in SNMP monitoring software to communicate with the IBM WebSphere Snmp Agent. This attribute is
present in the <agent> tag. Note: Specify the fully qualified hostname/IP
address instead of the default value: localhost.
|
snmpPort | The port number on which the WebSphere Snmp Agent listens for the snmp packets. The same value should be set in SNMP monitoring software to communicate with the IBM WebSphere Snmp Agent. This attribute is present in the <agentConfig> tag. |
user | The name of the user authorized to connect to
the IBM WebSphere Snmp Agent. The same value should
be set in SNMP monitoring software to communicate with the IBM WebSphere Snmp Agent. This attribute is
present in the <agent> tag. Note:
![]() ![]() |
authMode | The authentication mode used for communicating with the IBM WebSphere Snmp Agent. The same value should be set in SNMP monitoring software to communicate with the IBM WebSphere Snmp Agent. This attribute is present in the <agent> tag. |
password | The password of the authorized user defined in the ‘user’ attribute. The same value should be set in SNMP monitoring software to communicate with the IBM WebSphere Snmp Agent. This attribute is present in the <agent> tag. |
This configuration file contains information about the Mbean server from which the PMI data must be collected. You must set all of the attributes that are specified in this file.
All nodes and attributes, except those under <Mbean>, are static (that is, they can be configured only before starting the IBM WebSphere Snmp Agent). However, the nodes and attributes under <Mbean> can be modified even when the IBM WebSphere Snmp Agent is running.
In the following table, the only attributes that can be configured when security is enabled are: Security, User, Password, connectorSOAPconfig/connectorRMIconfig, sslRMIConfig, trustStore, tsPassword, keyStore and ksPassword.
Attribute name | Description |
---|---|
connectorType | You can only specify the following values as
the connector type:
Note: If you specify any other value, IBM WebSphere Snmp
Agent uses SOAP by default.
|
Security | Specifies whether WebSphere Application Server security is
enabled. You can only specify the following values:
Note: If you specify any other value, IBM WebSphere Snmp
Agent uses no by default.
|
Address | Specifies the Hostname or IPAddress of the WebSphere Application Server. |
Port | Specifies the SOAP_CONNECTOR port for SOAP connection and the BOOTSTRAP for RMI connection. |
sampleInterval | Specifies the interval (number of seconds) in which the WebSphere Snmp Agent should retrieve PMI data. This value should be at least 60. |
User | If you have enabled the security attribute,
set the username required to![]() ![]() |
Password | If you have enabled the security attribute,
set the password required to ![]() ![]() |
connectorSOAPconfig/connectorRMIconfig | If security is enabled, and the username or
password (or both) are not specified, the WebSphere Snmp Agent looks for the username
and password in the file that this attribute points to. Note: The
files, soap.client.props and sas.client.props respectively,
are present with the WebSphere Application
Server installation, and are located in the </was_profile>/properties directory.
Modify the value to point to the location on your system.
|
sslRMIConfig | If you choose the RMI connection, the SSL handshake
is performed when this security attribute is enabled. You can use
the default ssl.client.props file, which is located in the </was_profile>/properties directory,
or you can modify it according to the instructions contained in the
file. Note: For connectorRMIConfig and sslRMIConfig, the path name
should be preceded by file. For example: sslRMIConfig="file:/opt/IBM/Websphere/AppServer/profiles/Dmgr01/properties/ssl.client.props".
|
trustStore | Specifies the location of the truststore file on the host on which the WebSphere Snmp Agent is running. You can use the default truststore or create your own. If you use the default truststore, make sure this value reflects the corresponding path on your machine. |
tsPassword | Specifies the password required to access the truststore. |
keyStore | Specifies the location of the keystore file
on the host on which the WebSphere Snmp
Agent is running. You can use the default truststore or create your
own. If you use the default truststore, make sure this value reflects
the corresponding path on your machine. The truststore and keystore files perform the SSL handshake for SOAP when security is enabled. |
ksPassword | Specifies the password required to access the keystore. |
Mbean | Specifies the Mbeans that must be monitored.
This node can have any number of collection children nodes. Each collection
node has three attributes:
|
<?xml version="1.0" encoding="UTF-8"?>
<tns:TrapDestinations
xmlns:tns="http://www.ibm.com/schema/WsT/SNMPSchema/TRAPConfig/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.ibm.com/schema/WsT/SNMPSchema/TRAPConfig/TrapConfig.xsd ">
<TrapDestination community="public" index="2" name="abcdom"
protocol="2" status="3" version="1">
<HostName>127.0.0.1</HostName>
<Port>163</Port>
</TrapDestination>
</tns:TrapDestinations>
where: