cc/td/doc/product/rtrmgmt/info_ctr/1_0
hometocprevnextglossaryfeedbacksearchhelp
PDF

Table of Contents

Info Center Mediators

Info Center Mediators

This chapter describes the Mediators provided with the Cisco Info Center product.

This chapter contains the following sections:

HP Network Node Manager Mediator

Introduction to HP Network Node Manager Mediator

Quickstart Guide


Table 3-1: HP NNM (UNIX) Info Mediator Quickstart Guide

Info Mediator Target

HP Network Node Manager

Info Mediator Executable Name

nco_p_nnm3 for NNM Version 3.x

nco_p_nnm4 for NNM Version 4.x

nco_p_nnm5 for NNM Version 5.x

Info Mediator Supported on

NNM Version 3: Solaris 2

NNM Version 4: Solaris 2

NNM Version 5: Solaris2

Properties file

$OMNIHOME/probes/solaris2/nnm3.props for nco_p_nnm3

$OMNIHOME/probes/solaris2/nnm4.props for nco_p_nnm4

$OMNIHOME/probes/solaris2/nnm5.props for nco_p_nnm5

Rules file

$OMNIHOME/probes/solaris2/nnm3.rules for nco_p_nnm3

$OMNIHOME/probes/solaris2/nnm4.rules for nco_p_nnm4

$OMNIHOME/probes/solaris2/nnm5.rules for nco_p_nnm5

Requirements

HP NNM trapd process.

Data Acquisition

The HP Network Node Manager Info Mediator acquires event data by connecting to a running HP Network Node Manager system and capturing traps to form alerts.

The Info Mediator connects to the trapd process which HP Network Node Manager uses. It acquires its events directly from that process. The Info Mediator does not work when the trapd process does not exist.

Startup Requirements

The HP Network Node Manager Mediator requires that the HP Network Node Manager is running to generate a real-time stream of events. Different Info Mediators exist for versions 3.x, 4.x, and 5.x of the Network Node Manager. Apart from using different executables, they all operate in the same way.

Properties and Command Line Options

Command Line Syntax

The command line option specific to the NNM Info Mediators is:

nco_p_nnmn -<manager-string>

where <manager-string> is the management application name.

See Also

See Appendix A, "Generic Info Mediator Properties", and Appendix B "Default Info Mediator Command Line Options", for the properties and command line options available with all Mediators.

Elements

Static Elements


Table 3-2:
Element Name Element Description

$Node

Node name or IP address.

$community

SNMP community string.

$enterprise

SNMP enterprise string.

$generic-trap

SNMP generic trap integer value.

$specific-trap

SNMP specific trap integer value.

$IPaddress

IP address of the device.

$Sequence

Indicates the number of times the Info Mediator has been run.

HP NNM (UNIX) Mediator Static Elements

Dynamic Elements

The other elements are created on-the-fly and are entirely dependent on the traps sent by the network elements. They are mapped into $<n> and $OID<n> elements, where <n> is a sequence number.

Generic Trap Handling

The generic traps are handled at the end of the rules file. The handling of each is detailed below.

Generic trap-type 0 - Cold Start

Summary field set to Cold Start, AlertGroup field set to Generic, Severity field set to 4.

Generic trap-type 1 - Warm Start

Summary field set to Warm Start, AlertGroup field set to Generic, Severity field set to 4.

Generic trap-type 2 - Link Down

Summary field set to Link Down, AlertKey field set to the $1 varbind (which is <ifIndex>), AlertGroup field set to Generic, Severity field set to 5, Identifier field set to <Nodename> plus <Agent> plus <generic-trap> plus <specific trap> plus <ifIndex>.

Generic trap-type 3 - Link Up

Summary field set to Link Up, AlertKey field set to the $1 varbind (which is ifIndex), AlertGroup field set to Generic, Severity field set to 2, Identifier field set to <Nodename> plus <Agent> plus <generic-trap> plus <specific trap> plus <ifIndex>.

Generic trap-type 4 - Authentication

By default, Authentication traps are discarded

Generic trap-type 5 - EGP Neighbor Loss

Summary field set to EGP Neighbor Loss, AlertGroup field set to Generic, Severity field set to 3.

Error Level Messages

See Appendix E, "Error Messages", for details of the generic error messages produced by all Info Mediators.


Error Message   Select(): <reason>

Error Message   Dstrval(&DS)

Refer to your support contract for more information about contacting the help desk.

Fatal Level Messages

See Appendix E, "Error Messages", for details of the generic error messages produced by all Info Mediators.


Error Message   Cannot malloc memory for enterprise oid

Refer to your support contract for more information about contacting the help desk.

ProbeWatch Events

See Appendix E, "Error Messages", for details of the generic error messages produced by all Info Mediators.


Error Message   Dstrval(&DS)

Refer to your support contract for more information about contacting the help desk.


Error Message   Overror - An unexpected msg/condition - ignored

Error Message   Could not get the sequence number: err code <number>

The Info Mediator cannot save the sequence number.

Check that the file /var/adm/.nnm_seqno exists and the permissions are set correctly.

Cisco Syslog Mediator

Quickstart Guide


Table 3-3:

Mediator Target

None - Info Mediator for UNIX syslogd

Mediator Executable Name

nco_p_syslog

Mediator Supported on

Solaris 2

Properties file

$OMNIHOME/probes/solaris2/syslog.props

Rules file

$OMNIHOME/probes/solaris2/syslog.rules

Requirements

The Syslog Info Mediator requires that a FIFO can be created and syslogd is configured to write to that FIFO.

Cisco Syslog Mediator Quickstart Guide

Data Acquisition

The Syslog Info Mediator acquires event data from syslogd, the UNIX system message logger, by reading from a FIFO into which syslogd has been configured to write its messages.


Note FIFO: First In First Out. Also known as a named pipe. FIFO allows a program to write to a file and another process to read what has been written without the file expanding.

Installation

The /etc/syslog.conf file needs to be modified to send all messages to the FIFO. By default, with no FIFO settings in the properties or on the command line, the Info Mediator creates and reads a FIFO called /var/adm/nco. To set syslogd to write to this file, add the following line to the /etc/syslog.conf file:

*.debug /var/adm/nco


Note This line must not be the first line of the /etc/syslog.conf file. When it is, it activates a bug in syslogd, where it attempts a check on the first file in the first entry in the /etc/syslog.conf file, and this makes the syslog system unstable. Also note, some implementations of syslogd are limited to twenty entries in the /etc/syslog.conf file.

The line specified writes all syslog messages to the FIFO. It is also possible to configure syslog to only write particular messages to the file. Refer to the UNIX online manual pages for syslog.conf for more details. The syslogd process does not need to be restarted; when the Info Mediator is started, it automatically triggers a re-reading of the syslog.conf file.

Startup Operation

When the Info Mediator starts, it attempts to open (or create) the FIFO specified in the properties or command line. It is recommended you do not set this property so the Info Mediator defaults to its standard /var/adm/nco FIFO location. When, for some reason (for example, /var/adm does not exist or a FIFO has been incorrectly specified), the Info Mediator falls back to using /tmp/nco as its emergency FIFO.

The Info Mediator then locates the syslogd process and send it a signal prompting it to re-read its configuration file. This allows you to make changes to the syslog.conf file. Any changes you do make only come into effect when the Info Mediator is restarted.

Once it is reading the FIFO, the Info Mediator detects any messages written to the FIFO and processes them, one line at a time, as events.

Properties and Command Line Options

Command Line Syntax

There are four command line options specific to the Syslog Mediator:

nco_p_syslog -fifo <string> -offset0 <numeric> -offset1 <numeric> -offset2 <numeric>

Properties and Command Line Parameters


Table 3-4:
Property Name Property Parameter Command Line Option Description

FifoName

string

-fifo <string>

Filename of FIFO to create and read syslog messages from.

OffsetZero

numeric

-offset0 <numeric>

Parse from character position.

OffsetOne

numeric

-offset1 <numeric>

Number of token elements to create.

OffsetTwo

numeric

-offset2 <numeric>

Number of tokens into string to create Details element.

Syslog Mediator Properties and Command Line Options

See Also

See Appendix A, "Generic Info Mediator Properties", and Appendix B, "Default Info Mediator Command Line Options", for the properties and command line options available with all Info Mediators.

Fatal Level Messages

See Appendix E, "Error Messages", for details of the generic error messages produced by all Info Mediators.


Error Message   Failed to open FIFO <FIFO file name>

The properties or command line options for the FIFO file are pointing to a file which cannot be opened.

Check the command line options and properties and set them to refer to the correct FIFO file that has been created.

Error Level Messages

See Appendix E, "Error Messages", for details of the generic error messages produced by all Info Mediators.


Error Message   Can't create <FIFO file name>

The Info Mediator is unable to create the specified FIFO.

Check that the file specified can be created, then check the properties and command line options.

Warning Level Messages

See Appendix E, "Error Messages", for details of the generic error messages produced by all Info Mediators.


Error Message   Not found: <FIFO file name>

The Info Mediator did not find the specified FIFO.


Error Message   Temporary FIFO created: <FIFO file name>

Error Message   Using temporary FIFO: <FIFO file name>

The Info Mediator has fallen back to using the temporary named FIFO.

Check the properties, command line options, and that the file can be written to.


Error Message   FIFO created: <FIFO file name>

The named FIFO has been created.


Error Message   Not a FIFO: <file name>

The file specified as a FIFO already exists and is not a FIFO.

Check the properties and command line options.

Trapd Mediator

Quickstart Guide


Table 3-5:

Mediator Target

SNMP Events

Mediator Executable Name

nco_p_trapd

Mediator Supported on

Solaris 2

Properties file

$OMNIHOME/probes/solaris2/trapd.props

Rules file

$OMNIHOME/probes/solaris2/trapd.rules

Requirements

See Section "Other Requirements" on next page.

Trapd Quickstart Guide

Data Acquisition

The Trapd Mediator is a direct SNMP monitoring Mediator. The Info Mediator acquires event data by acting as a trap daemon and monitoring SNMP traps and events.

Other Requirements

The Trapd Mediator must not be run on a machine where another trapd process (for example, HP NNM or SunNet Manager) is running, unless a different SNMP port is specified on the command line or in the properties.

The Info Mediator must be run by a root user or by a user with write access to the /var/adm directory and the SNMP port.

Properties and Command Line Options

Command Line Syntax

There are three command line options specific to the Trapd Mediator:

nco_p_trapd -mibfile <string> -port <numeric> -socketsize <numeric>

Properties and Command Line Parameters


Table 3-6:
Property Name Property Parameter Command Line Option Description

MIBFile

string

-mibfile <string>

Set the name of the MIB file. The default is:

$OMNIHOME/probes/arch/mib.txt

Port

numeric

-port <numeric>

Sets the port to listen for SNMP traffic.

Defaults to the standard SNMP port.

SocketSize

numeric

-socketsize <numeric>

The input buffer size in bytes. The default is 4096. See note below.

Trapd Mediator Properties and Command Line Options

See Also

See Appendix A, "Generic Info Mediator Properties", and Appendix B, "Default Info Mediator Command Line Options", for properties and command line options available with all Info Mediators.

Note, the minimum value for the SocketSize property is 128 bytes, the default is 4096 bytes. In the majority of cases, the default size is the best size to use. You should only change it when you are instructed to do so by technical support. When you do increase the size, the Info Mediator is less likely to miss traps when there is a sudden burst of them, however, you do use up RAM needlessly the rest of the time. When you decrease the size, the Info Mediator may lose events.

Elements

Static


Table 3-7:
Element Name Element Description

$Node

Node name or IP address when the name can not be resolved.

$IPaddress

IP address.

$community

SNMP community string.

$enterprise

SNMP enterprise string.

$generic-trap

SNMP generic trap integer value.

$specific-trap

SNMP specific trap integer value.

$UpTime

SNMP Uptime.

$ReqId

SNMP request ID.

$EventCount

The number of traps processed during the current execution of the Info Mediator.

$Sequence

A value unique to each execution of the Info Mediator. The first time the Info Mediator is run, this value is set to 1, it is then incremented by one each time the Info Mediator is run.

Trapd Mediator Static Elements

Dynamic

The other elements are created on-the-fly and are entirely dependent on the network devices.

The varbinds that are generated by SNMP are mapped to elements called $1, $2, $3, and so on up to $9.

For each varbind, the object ID is placed in a corresponding element called $OID1, $OID2, $OID3, and so on up to the number of varbind elements.

Generic Trap Handling

The generic traps are handled at the end of the rules file. The handling of each is detailed below.

Generic trap-type 0 - Cold Start

Summary field set to Cold Start, AlertGroup field set to Generic, Severity field set to 4.

Generic trap-type 1 - Warm Start

Summary field set to Warm Start, AlertGroup field set to Generic, Severity field set to 4.

Generic trap-type 2 - Link Down

Summary field set to Link Down, AlertKey field set to the $1 varbind (ifIndex), AlertGroup field set to Generic, Severity field set to 5, Identifier field set to <node name> plus <Agent> plus <generic-trap> plus <specific trap> plus <ifIndex>.

Generic trap-type 3 - Link Up

Summary field set to Link Up, AlertKey field set to the $1 varbind (ifIndex), AlertGroup field set to Generic, Severity field set to 2, Identifier field set to <node name> plus <Agent> plus <generic-trap> plus <specific trap> plus <ifIndex>.

Generic trap-type 4 - Authentication

By default, Authentication traps are discarded.

Generic trap-type 5 - EGP Neighbor Loss

Summary field set to EGP Neighbor Loss, AlertGroup field set to Generic, Severity field set to 3.

ProbeWatch Events

As the Info Mediator exits, a ProbeWatch event message is generated that contains the unique sequence number of the Info Mediator and the number of traps processed during its execution.

See Appendix E, "Error Messages", of the ProbeWatch events produced by all Info Mediators.

Cisco StrataView+ Mediators

The Cisco StrataView+ (SV+) 8.4 management application that manages the Cisco WAN equipment, forwards the traps received from the network element to two destinations as shown in Figure 3-1.


Figure 3-1: SV+ Mediator Event Mechanism


The Cisco SV+ Mediator consists of the HP Network Node Manager Mediator and the Trapd Mediator. These two Mediators together form the Cisco SV+ Mediator and collect events passed by SV+ to the HP Network Node Manager and the Service View Agent. The SV+ Mediator must run on the Cisco StrataView+ machine.

The Trapd Mediator for the Cisco SV+ Mediator, registers with the Robust Trap Mechanism Proxy Agent by passing the IP address of the machine on which the Mediator runs, which is the Cisco SV+ machine, and the port it is running on. By default, the Trapd Mediator runs on port 162, however, as this port is used by HP Network Node Manager Trapd, the Trapd Mediator is configured to run on port 4000. The registration process registers the Trapd Mediator with the Service View Agent and monitors the registration. When for any reason, the RTMProxy process is not running, or the Trapd Mediator is unable to register, the registration process sends an SNMP trap to the Trapd Mediator. The registration script is started in the process control as follows

$OMNIHOME/utils/trapd/start_trapd <IP Address> <Port>

See Appendix G, Section "Micromuse Specific Traps", for more information.

As both the HP Network Node Manager and the Trapd Mediator receive traps, the elements created by both of these Mediators are the same (see the Static and Dynamic Elements Sections for NNM and Trapd Mediators). Both of these Mediators use a common rules file, /opt/Omnibus/probes/solaris2 called cisco.rules. The installation and configuration script on installing the Cisco SV+ Mediators, configures the properties for the HP Network Node Manager Mediator and the Trapd Mediator to include the cisco.rules file.

It is likely the HP Network Node Manager Mediator and the Trapd Mediator may receive identical traps from Cisco SV+ and therefore, a discard functionality has been implemented whereby duplicate traps are discarded from the HP Network Node Manager.

An SNMP trap Protocol Data Unit (PDU) received by the HP Network Node Manager Mediator and the Trapd Mediator consists of the following fields:


Table 3-8:

Manager Address

Enterprise ID

Agent Address

Generic Trap

Specific Trap

TimeStamp

VarBind1

VarBind2

Other VarBinds.

SNMP Trapd Protocol Data Unit

where the VarBinds consist of a group of Object Identifier, Type, and Value and the number of VarBinds depends upon the trap. For example:


Table 3-9:

171.22.24.67

.1.3.6.1.4.1.9

171.22.24.88

2

0

133333

.1.3.6.1.1.2.5, integer 11

SNMP Trap Example

When this trap is received by either the HP Network Node Manager Mediator or the Trapd Mediator, the following elements are generated


Table 3-10:
Element Name Element Description

$Node

171.22.24.88

$enterprise

.1.3.6.1.4.1.9

$generic-trap

2

$specific-trap

0

$OID1

.1.3.6.1.1.2.5

$1

11

SV+ Mediators Token Generation

The VarBinds elements are assigned to elements $OID[<n>] and $[<n>] where <n> is the position of the VarBind in the SNMP PDU, as in the above example.

$OID1 = .1.3.6.1.1.2.5
$1 = 11

Skeleton of the Cisco SV+ Mediators Rules File

This section describes the skeleton of the rules file for the HP Network Node Manager and Trapd Mediators. See Appendix G, "SV+ Mediator Rules File", for more information.

The first section must have any settings for lookups when defined. For example:

table discards = 
"/opt/Omnibus/probes/solaris2/discards.lookup"
table NEAddress = 
"/opt/Omnibus/probes/solaris2/node_ip_addr.lookup" 
 

The next section is the body of the rules file that deals with the Info Mediator Watch and Event mappings.

The Probe Watch messages are generated by the Mediators and is an internal property of the Mediators. These messages are usually generated during startup and shutdown. The following section deals with the Info Mediator Watch messages within the main loop of the rules file.

switch(@Manager)

{

case "ProbeWatch":
@Summary = @Agent + " on " + @Node + " " + @Summary
@NEName = @Node
@ObjectType = `infocenter.system'
@SubObjectType = `Info Mediator'
@AlertKey = @Agent
switch(@Summary)
{
case "Going Down ...":
@AlertGroup = "ProbeUpDown"
@Type = 1
case "Running ...":
@AlertGroup = "ProbeUpDown"
@Type = 2
default:
}

The Defaults start here for main rules section (non ProbeWatch alerts).

default:
Set up defaults for all the events
@NEName = $2
@NEType = lookup(@NEName, NETypes)
@NEAddress = lookup(@NEName, neaddress)
Configure the events based on generic trap (0 - 6)
switch($generic-trap)
{
Configure the traps for generic trap 6 (this is always followed by a specific trap #)
case "6":
Configure traps for the enterprise (vendor) specific traps.
switch($enterprise)
{
Map Traps for the StrataViewPlus Enterprise

case ".1.3.6.1.4.1.351.1":

switch($specific-trap)

{

case "25000":

Mappings here for this case..
...

case "25001":

Mapping here for this case
...

case "25002":

Mapping here for this case
...

default:

Catch all if none of the above cases match for this specific enterprise
}

case ".1.3.6.1.4.1.351.100":

Map Traps for the StrataView Switch Software

switch($specific-trap)

{

case "1000":

Mappings here for this case
...

case "1001":

Mapping here for this case
...

case "1002":

Mapping here for this case
...

default:

Catch all if none of the above cases match for this specific enterprise

}

case ".1.3.6.1.4.1.351.110":

Map traps for the StrataCom Axis Enterprise

switch($specific-trap)

{

case "50000":

Mappings here for this case
...

case "50001":

Mappings here for this case
...

case "50002":

Mapping here for this case
...

default:

Catch all if none of the above cases match for this specific enterprise

}

case ".1.3.6.1.4.1.351.200.1":

Map traps for the StrataCom Switch Software

switch($specific-trap)
{
case "20001":
Mappings here for this case
...
case "20002":
Mappings here for this case
...
case "200003":
Mapping here for this case
...
default:
Catch all if none of the above cases match for this specific enterprise
}

case ".1.3.6.1.4.1.351.200.1":

Map traps for the VNS DNS enterprise

switch ($specific-trap)

{

case "6000":

Mapping here for this case
...

case "6001":

Mapping here for this case
...

default:

Catch all if none of the above cases match for this specific enterprise
...

}

}

This section deals with SNMP traps 0 - 5

5 - EGP Loss

4 - Authentication

3 - Link Up

2 - Link Down

1 - Warm Start

0 - Cold Start

case "5":

switch($enterprise)

{

case ".1.3.6.1.6.3.1.1.5":
# SNMP_EGP_Down
Mappings here
...
default:
Mappings here

}

case "4":

switch($enterprise)

{

case ".1.3.6.1.6.3.1.1.5":

# SNMP_Authen_Failure

Mappings here

...

default:

Mappings here

}

case "3":

switch($enterprise)

{

case ".1.3.6.1.6.3.1.1.5":

# SNMP_Link_Up

Mappings here

default:

Mappings here

}

case "2":

switch($enterprise)

{

case ".1.3.6.1.6.3.1.1.5":

# SNMP_Link_Down

Mappings here

default:

Mappings here

}

case "1":

switch($enterprise)

{

case ".1.3.6.1.6.3.1.1.5":

# SNMP_Warm_Start

Mappings here

default:

Mappings here

}

case "0":

switch($enterprise)

{

case ".1.3.6.1.6.3.1.1.5":

# SNMP_Cold_Start

Mappings here
...

default:

Mappings here
...

}

This handles the default if non of the above rules match.

default:

@Summary = "Unknown generic trap number " + $generic-trap + " from enterprise " + $enterprise-name
@AlertGroup = "unknown"
@Severity = "1"

}

}

Adding a New Trap to an Existing Enterprise Definition

This section describes the process to add a new specific trap to an existing enterprise.

Add the trap definition within a case statement in the portion of the rules file defined for the enterprise. For example, to add trap 25010 to the .1.3.6.1.4.1.351.1 enterprise in the above example, add the case "25010" anywhere before the default condition that matches the case statement for the enterprise within the specific trap switch within the enterprise.

case ".1.3.6.1.4.1.351.1":

switch($specific-trap)
{
case "25000":
Mappings here for this case.
...
case "25010":
Mappings here and so on..
...
default:
catch all if none of the above matches.
}

Adding a New Enterprise to the Rules File

This section describes the process of adding a new enterprise definition with its specific traps to the rules file.

Add the specific traps for a new enterprise in the loop of the switch on generic trap 6 and within the switch for the enterprise as follows.

For example, to add the traps for vendor Micromuse (.1.3.6.1.4.1.1279) into the above rules skeleton:

#Micromuse Specific Traps

case ".1.3.6.1.4.1.1279":

switch($specific-trap)
{
case "1":
Mappings for Case 1
...
case "2":
Mappings for Case 2
...
default:
Mappings for Default
}

Solution - Adding a New Enterprise to the Rules File

Traps specific to a new enterprise must be added under the switch statement for the $generic-trap and under case "6". A new switch statement must be added anywhere under the case "6" before the SNMP Generic traps:

Configure traps for the enterprise (vendor) specific traps.

switch ($generic-trap)

{

case "6"

switch($enterprise)

{

Map Traps for the StrataViewPlus Enterprise

case ".1.3.6.1.4.1.351.1":

switch($specific-trap)

{

case "25000":

Mappings here for this case..

}

case ".1.3.6.1.4.1.1279":

Micromuse Specific Traps

switch($specific-trap)

{

case "1":

Mappings for Case 1

case "2":

Mappings for Case 2

default:

Catch all if none of the above cases match for this specific enterprise

}


hometocprevnextglossaryfeedbacksearchhelp
Posted: Wed Mar 24 13:47:18 PST 1999
Copyright 1989-1999©Cisco Systems Inc.