BCM50 Release 3.0 SNMP Readme File
==================================

Zip File Overview
-----------------

This zip file contains the following files:

- readme.txt    : this file
- manifest	    : include, one per line, a list of the MIB files provided in
                  this zip file
- supported	    : include a list of leaf OID names and dot values, one per line,
                  supported 
- changes	    : any MIB files have changed (added, deleted, name change or OID
                  context change) 
- oidchanges    : OID files have changed (added, deleted, or name change) 
- compilerorder : list of MIB names, one per line, in the order the MIBs need to
                  be compiled and loaded 
- mib files	    : the minimum mandatory MIBs required for all Enterprise Devices

This MIB archive has the following changes:

MIB file names have changed, they are now named:

RFC1213-MIB.mib
SNMP-FRAMEWORK-MIB.mib
ENTITY-MIB.mib
HOST-RESOURCES-MIB.mib
IF-MIB.mib
SMALLSITE-COMMON-MIB.mib
SMALLSITE-EVENTS-MIB.mib

In addition, the following files which are included by others were added to the
archive:
SNMPv2-MIB.mib
IANAifType-MIB.mib

A complete list of MIB file name changes can be found in the changes file.

NOTE: Due to the MIB file name changes you should not extract these MIB files to
the same location (i.e. directory) as a previous version and then recompile. 
This will result in two MIB files with the same OIDs, which will produce compile
conflicts.

If you are using a tool that imports MIB files by name (i.e. HP Openview) then
you must remove the previous definition before importing the new MIB file.


Management Information Base (MIB) System
----------------------------------------

This ReadMe file describes BCM50 management information bases (MIB). 
The MIB is a virtual information store that contains a collection of objects
that are managed using Simple Network Management Protocol (SNMP). The MIB is the
software that defines the data reported by a computing or network device and the
extent of control over that device. 

This chapter provides the following information:
* SNMP MIBs 
* Third-Party Fault Management Systems 
* MIB File Descriptions 
* MIB File Compilation andInstallation 
* Small Site Event MIBs  

Note that this document focusses on the MIBs supported by the BCM50 main unit,
exclusive of the optional integrated router.  The integrated router supports MIB
II as defined in RFC-1213 and RFC-1215. 

SNMP MIBs
---------

An MIB enables access to the managed objects of a system through a virtual
information store termed the management information base or MIB. BCM50 supports
a number of MIBs.

Note that BCM MIBs may be used only for monitoring the element, and may not be
used for configuring it. This means that read-only access is provided for all
supported MIB objects.

The BCM50 MIB files can be accessed from the BCM50 Web page under the selection
?Administrator Applications?.

MIB files are also available as a zipped file from the Nortel Support and
Training site at www.nortel.com as follows:
* Click Support and Training -> Technical Support
* Click Browse Product Support
* Click Product Families
* Click BCM
* Click the BCM Software link
* Click Filter and Sort, and select Software Type MIB, then click the "Go >>"
button.
* Select and download the BCM 50 Release 2 MIB link.
MIB Browsers allow the MIB information to be loaded so that the MIB structure
can be browsed. An example of a utility is Microsoft MOM.

Third-Party Fault Management Systems 
------------------------------------

The BCM Small Site and BCM Small Site Event MIBs can be integrated into
standards-based SNMP management frameworks in order to receive BCM50 alarms via
SNMP.

MIB File Descriptions
---------------------

The BCM MIBs are organized into two sections: 
* Standard MIBs: includes SNMPv2-MIB, MIB-II (RFC1213), SNMP Framework MIB
(RFC2261), IANAifType-MIB, ENTITY-MIB (RFC2737), HOST-MIB (RFC2790), IF-MIB
(RFC2863)
* Nortel MIBS: includes BCM Small Site MIB and BCM Small Site Events MIB. The
Events MIB defines the events (traps) which are usable by any SmallSite product
or component.

Refer to Tables 1, and 2 for file names and files descriptions of each of the
MIBs.

Table 1: Standard MIBs files descriptions
-----------------------------------------

MIB                File name                 Comments
---                ---------                 --------

SNMPv2-MIB         SNMPv2-MIB.mib            This MIB defines basic SMI types
                                             and structures used by other MIBs.

MIB-II             RFC1213-MIB.mib           This MIB defines the Management
                                             Information Base (MIB-II) for use 
                                             with network management protocols
                                             in TCP/IP-based internets.
                                             
SNPM-FRAMEWORK-MIB SNMP-FRAMEWORK-MIB.mib    This is the SNMP Management
                                             Architecture MIB. This standard MIB
                                             displays parameters related to the
                                             SNMP Agent on the BCM.
                                             
ENTITY-MIB         ENTITY-MIB.mib            This MIB defines physical and 
                                             logical system components on the
                                             BCM and associations between these
                                             components.
                                             
IANAifType-MIB     IANAifType-MIB.mib        This MIB defines types which are
                                             used by IF-MIB
                                             
HOST-MIB           HOST-RESOURCES-MIB.mib    This MIB is for use in managing
                                             host systems. It is useful for
                                             monitoring resource usage, system
                                             performance, etc...
                                             
IF-MIB             IF-MIB.mib                This MIB describes generic objects 
                                             for network interface sub-layers.

Table 2: Nortel MIBs files descriptions
---------------------------------------

MIB                   File name                 Comments
---                   ---------                 --------

SMALLSITE-COMMON-MIB  SMALLSITE-COMMON-MIB.mib  This MIB defines the upper-level
                                                hierarchy of an
                                                enterprise(1).nortel(562)
                                                sub-branch called smallsite.
                                                This Nortel Networks MIBN is the
                                                basis for several Nortel
                                                Networks smallsite products. In
                                                the BCM, this MIB is a
                                                prerequisite for the Small Sites
                                                Events MIB.
                                                
SMALLSITE-EVENTS-MIB  SMALLSITE-EVENTS-MIB.mib  This MIB defines the events 
                                                (traps) that can be used by the
                                                Small Site product or component.
                                                This MIB describes the events
                                                generated by the BCM. This MIB
                                                contains fields such as eventId,
                                                eventSource, eventTime, and
                                                EventDescr.
                                                
MIB File Compilation and Installation
-------------------------------------
Each MIB browser has its own MIB compilation tool. Compile the . 


The following are the possible problems that can be encountered during
compilation and installation.

* BCM files are created and released within a MicroSoft Windows environment so
that when these files are copied or transferred to a UNIX environment the last
carriage return can be deleted. In this case you can get an ?END is not found?
error message during the compilation. Open the MIB file with a UNIX text editor
and add a carriage return at the end of the word ?END?.

Small Site MIB
The device sysObjectID (s) are defined in the BCM Small Site MIB. sysObjectID(s)
are defined for the BCM50 main unit, as well as the ADSL and Ethernet integrated
routers. The following table summarizes the sysObjectID assignments:

Model      Main unit sysObjectID          Integrated Router sysObjectID
-----      ---------------------          -----------------------------

BCM50      1.3.6.1.4.1.562.37.1.4         -
BCM50a     1.3.6.1.4.1.562.37.1.4         1.3.6.1.4.1.562.37.1.5
BCM50e     1.3.6.1.4.1.562.37.1.4         1.3.6.1.4.1.562.37.1.6

Small Site Event MIB
--------------------

The trap format is specified in the BCM Small Site Event MIB. BCM traps can be
captured and viewed through any standard SNMP fault monitoring framework or trap
watcher.   SNMP Traps are generated by the BCM50 if the Alarm Settings have been
configured to ?Enable SNMP? for a given BCM50 alarm.  This can be done using
BCM50 Element Manager by selecting Alarm Settings under the General folder on
the Administration Tab while connected to a specific BCM50. 

The following are the BCM-specific SNMP trap fields for the Small Site Event
MIB:

* Enterprise: OID identifies the product
(iso.org.dod.internet.private.enterprises.nortel.smallsite.common.events
[1.3.6.1.4.1.562.37.3.1])
* Agent address: IP address of one of the BCM interfaces
* Generic trap type: 6, for Enterprise-specific traps
* Specific trap type: 
1 = eventInfo trap type
2 = eventWarning trap type
3 = eventError trap type
* Time stamp: system up time

The following are the BCM-specific SNMP variables: 
* eventID - contains the corresponding alarm ID
* OID: 1.3.6.1.4.1.562.37.3.1.1.0
* eventSource - contains the name of the software component that generated the
alarm (trap).  This is in the 3 part DN format defined in the Nortel Networks
Common Alarm Framework.  The 3 part DN is in the format of: 
* systemId=BCM, entityId=System Name, subEntityId=Component Name
OID: 1.3.6.1.4.1.562.37.3.1.2.0
* eventTime - contains the alarm (trap) Date and Time
* OID: 1.3.6.1.4.1.562.37.3.1.3.0
* eventDescr - contains the alarm (trap) problem description
* OID: 1.3.6.1.4.1.562.37.3.1.4.0

