How Robot/CONSOLE Supports SNMP Traps
Introduction
Robot/CONSOLE manages System i messages and supports Simple Network Management Protocol (SNMP) traps.
- SNMP is a popular TCP/IP network management standard, supported by most UNIX-based and NT-based enterprise management tools.
- “Trap” is a generic term that refers to a software packet containing data (such as system messages), stored in a predefined data structure for interpretation and use by enterprise monitor software.
When messages occur on a System i, Robot/CONSOLE can build an SNMP trap using the Robot/CONSOLE Management Information Base (MIB) structure (see the figures on the following pages). Robot/CONSOLE can create SNMP traps when it receives a message on the System i, or when a message has received a reply.
The trap is passed to the enterprise monitor, which collects it, interprets its contents based on its copy of the Robot/CONSOLE MIB structure, and displays it in a format determined by the site. This information allows the enterprise monitor administrator to take care of the problem, or pass the information to a knowledgeable source. This communication is one-way: events are sent to the enterprise monitor, but replies cannot be sent to Robot/CONSOLE.
Overview of the Robot/CONSOLE MIB Structure
In the background, Robot/CONSOLE passes data to the enterprise monitor as a numeric sequence—1.3.6.1.4.1.6872.1.4.1, known as a MIB (Management Information Base) definition.
- The first six decimal places—1.3.6.1.4.1—are pre-configured SNMP entries,
- The remaining decimal places—6872.1.4.1—are Help/Systems-specific entries. Whenever Robot/CONSOLE sends an SNMP message trap, the enterprise monitor captures and interprets the data in the trap using the Robot/CONSOLE MIB structure (shown below and on the following pages)
Note: The System i SNMP Manager API also uses a field type identifier. A value of .1.0 or .2.0 should be appended to each field’s object ID to identify the field type as integer or character.
Robot/CONSOLE Trap Types
|
rbcsmColdStart No VarBinds |
rbcsmEventData VarBinds: |
rbcsmEvenData VarBinds: |
Before You Begin
You need the following prerequisites and software to install and use Robot/CONSOLE with SNMP.
Prerequisites
- Be familiar with Robot/CONSOLE and SNMP.
- Have a System i communications expert available to help you implement this interface.
Software Requirements
- Robot/CONSOLE V3M28 or higher installed on your system.
- TCP/IP configured on your System i.
Overview of Installing the SNMP Interface
We recommend you perform your installation and integration in the following order. The actual steps are detailed on the following pages.
- Install or update Robot/CONSOLE on your System i.
- Use FTP to copy the Robot/CONSOLE MIB data structure from your system to the SNMP enterprise monitor.\
- Study the structure and incorporate it into your enterprise monitor (refer to the appropriate documentation for your enterprise monitor).
- Test your results.
Defining and Installing the SNMP Interface on the Enterprise Monitor
Download the Robot/CONSOLE MIB File
To use the Robot/CONSOLE data structure (MIB) to interpret SNMP traps passed from Robot/CONSOLE to your enterprise monitor, you must perform the following steps:
- Download the Robot/CONSOLE MIB file—RBTSYSLIB/RSLMIB.RBCSMMIB—from your System i using the FTP command.
- Incorporate the Robot/CONSOLE MIB structure into your enterprise monitor using the specific procedure(s) for that enterprise monitor (refer to your enterprise monitor documentation).
- Compile the updated MIB structure file on your enterprise monitor.
where: libraryname=RBTSYSLIB, filename=RSLMIB, and member=RBCSMMIB
Review the Robot/CONSOLE Traps
Robot/CONSOLE sends out three SNMP traps to communicate with the enterprise monitor:
- The first trap, type 0 (called rbcsmColdStart), is sent when the main Robot/CONSOLE enterprise monitor communication program starts. This trap indicates that Robot/CONSOLE is active and that communication lines are open between Robot/CONSOLE and the enterprise monitor.
- The second trap, type 1 (called rbcsmSendTrap), is sent whenever Robot/CONSOLE sends any message data to the enterprise monitor. This trap describes the contents of the data being sent. The enterprise monitor captures and displays the data from this trap according to your specifications when you incorporated the Robot/CONSOLE MIB.
- The third trap, type 2 (called rbcsmReplyTrap), is sent whenever Robot/CONSOLE sends a reply for the message data to the enterprise monitor. This trap describes the contents of the data being sent. The enterprise monitor captures and displays the data from this trap according to your specifications when you incorporated the Robot/CONSOLE MIB.
The following tables describe the traps in greater detail. Study these traps closely—you need to understand the information contained within them to determine how you plan to display their data on your enterprise monitor system.
Robot/CONSOLE Trap Types
| Trap Type | Variables | Description |
| rbcsmColdStart | None | The Robot/CONSOLE Enterprise Monitor interface subagent has connected to the System i SNMP agent. This trap is sent one time—when Robot/CONSOLE initiates contact with SNMP. |
| rbcsmSendTrap (see the table, Robot/CONSOLE Events) |
rbcsmSystemName rbcsmMessageCenterName rbcsmMessageQueueLibrary rbcsmMessageQueueName rbcsmJobName rbcsmJobNumber rbcsmUserProfile rbcsmProgramName rbcsmMessageDate rbcsmMessageTime rbcsmMessageFileLibrary rbcsmMessageFileName rbcsmMessageID rbcsmMessageSeverity rbcsmMessageType rbcsmMessageStatus rbcsmMessageText rbcsmMessageKey rbcsmValidReplies rbcsmMessageMilliseconds |
The Robot/CONSOLE SNMP subagent is providing message data. This trap is sent anytime Robot/ CONSOLE communicates message event information to SNMP. |
| rbcsmReplyTrap | rbcsmReplyTrap rbcsmReplyMessageKey rbcsmReplySystemName rbcsmReplyMessageCenterName rbcsmReplyMessageQueueLibrary rbcsmReplyMessageQueueName rbcsmReplyJobName rbcsmReplyJobNumber rbcsmReplyUserProfile rbcsmReplyMessageDate rbcsmReplyMessageTime rbcsmReplyValue |
The Robot/CONSOLE SNMP subagent is providing message reply data. This trap is sent anytime Robot/CONSOLE communicates message reply information to SNMP. |
Robot/CONSOLE Events RBCSMMIB Definition—Robot/CONSOLE Event Data
| Field Name | Size | Type | Syntax | Description |
| rbcsmSystemName | 10 | Char | DisplayString | System on which message was received |
| rbcsmMessageCenterName | 10 | Char | DisplayString | Robot/CONSOLE Message Center on which message was received |
| rbcsmMessageQueueLibrary | 10 | Char | DisplayString | Library in which the Message Queue resides |
| rbcsmMessageQueueName | 10 | Char | DisplayString | Message Queue which received the message |
| rbcsmJobName | 10 | Char | DisplayString | Job name from which message came from |
| rbcsmJobNumber | 6 | Char | DisplayString | Job number from which message came from |
| rbcsmUserProfile | 10 | Char | DisplayString | User profile from which message came from |
| rbcsmProgramName | 10 | Char | DisplayString | Program name from which message came from |
| rbcsmMessageDate | 8 | Char | DisplayString | Date from which message was received (YY/MM/DD) |
| rbcsmMessageTime | 8 | Char | DisplayString | Time which message was received (HH:MM:SS) |
| rbcsmMessageFileLibrary | 10 | Char | DisplayString | Library in which the message file exists |
| rbcsmMessageFileName | 10 | Char | DisplayString | Message file which defines the message |
| rbcsmMessageID | 7 | Char | DisplayString | System i message identifier |
| rbcsmMessageSeverity | 2 | Char | DisplayString | Severity of System i messages (00-99) |
| rbcsmMessageType | 2 | Char | DisplayString | System i message type |
| rbcsmMessageStatus | 2 | Char | DisplayString | Robot/CONSOLE Message Status: WT = Waiting for a reply RS = Response required, waiting for a reply MC = Received reply from message center MS = Received reply from message set IN = Informational Message OC = Received reply from outside of Robot/CONSOLE RA = Received reply from Robot/ALERT |
| rbcsmMessageText | 256 | Char | DisplayString | Formatted message text |
| rbcsmMessageKey | 4 | Char | DisplayString | Message Key |
| rbcsmValidReplies | 160 | Char | DisplayString | Valid relies for message |
| rbcsmReplyMessageKey | 4 | Char | DisplayString | Message key being replied to |
| rbcsmReplySystemName | 10 | Char | DisplayString | System that answered message |
| rbcsmReplyMessageCenterName | 10 | Char | DisplayString | Reply message center name |
| rbcsmReplyMessageQeueuLibrary | 10 | Char | DisplayString | Reply message queue library |
| rbcsmReplyMessageQeuueName | 10 | Char | DisplayString | Reply message queue |
| rbcsmReplyJobName | 10 | Char | DisplayString | Reply job name |
| rbcsmReplyJobNumber | 6 | Char | DisplayString | Reply job number |
| rbcsmReplyUserProfile | 10 | Char | DisplayString | Reply user |
| rbcsmReplyMessageDate | 8 | Char | DisplayString | Message reply date (YY/MM/DD) |
| rbcsmReplyMessageTime | 8 | Char | DisplayString | Message reply time (HH:MM:SS) |
| rbcsmReplyValue | 132 | Char | DisplayString | Message reply value |
| rbcsmMessageMilliseconds | 6 | Char | DisplayString | Time, in milliseconds, when message was received |
Defining and Installing the SNMP Interface on the System i
- Connect the SNMP system and the Robot/CONSOLE System i via TCP/IP. Use the following command to set up the interface (the port number defaults to 161):
- When you create a message set, use the OPAL operation SNDSNMPMSG to send notification of a message to the Trap Manager.
- When you create a message set to forward the reply to the Trap Manager, press function key 15 to display the Reply OPAL Maintenance panel and enter the OPAL operation SNDSNMPRPY.
CHGSNMPA TRPMGR((trap_mgr_ip community_name translate_name))
where:
trap_mgr_ip is the decimal IP address of your trap manager.
community_name is the SNMP community that your trap manager manages; usually ‘public.’
translate_name specifies whether the community name should be translated to ASCII; usually *YES.
Note: If you need to troubleshoot TCP/IP on the System i, enter the command NETSTAT. Select option 3 from the Work With TCP/IP Network Status menu to see the TCP/IP connection statuses. The normal status for SNMP should be equal to *UDP; it defaults to port 161. To verify this, press function key 14, Display port numbers.