Download - Amlib Templ Ist Am Fs
HP TeMIP Software<Equipment Manufacturer> <MIBName> SNMP AM
Functional Specification
This document is the specification for the Information Model and the SNMP trap processing implemented in TeMIP IST (Internet SNMP Toolkit) Access Module for <Equipment Manufacturer> <MIB Name>.
Please check Preface for instructions to begin using this template (to be removed)
Revision/Update Information: V1.0
Software Version: HP TeMIP Software V5.0, V6.0,V6.1HP TeMIP Software IST V5.0 and V6.1
© 2012 Hewlett-Packard Development Company, L.P.
Legal Notices
Warranty
The information contained herein is subject to change without notice. The only warranties for HP products and services are set forth in the express warranty statements accompanying such products and services. Nothing herein should be construed as constituting an additional warranty. HP shall not be liable for technical or editorial errors or omissions contained herein.
License Requirement and U.S. Government Legend
Confidential computer software. Valid license from HP required for possession, use or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under vendor's standard commercial license.
Copyright Notices
© Copyright 2012 Hewlett-Packard Development Company, L.P.
Trademark Notices
Adobe®, Acrobat® and PostScript® are trademarks of Adobe Systems Incorporated.
HP-UX Release 10.20 and later and HP-UX Release 11.00 and later (in both 32 and 64-bit configurations) on all HP 9000 computers are Open Group UNIX 95 branded products.
Java™ is a U.S. trademark of Sun Microsystems, Inc.
Microsoft®, Windows® and Windows NT® are U.S. registered trademarks of Microsoft Corporation.
Oracle® is a registered U.S. trademark of Oracle Corporation, Redwood City, California.
UNIX® is a registered trademark of The Open Group.
X/Open® is a registered trademark, and the X device is a trademark of X/Open CompanyLtd. in the UK and other countries.
Red Hat and Red Hat Enterprise Linux are registered trademarks of Red Hat, Inc. in the United States and other countries.
Linux is a registered trademark of Linus Torvalds.
All other product names are the property of their respective trademark or service mark holders and are hereby acknowledged.
ii
Revision History
Revision Date Author Description
Contents
Preface........................................................................................................................... ix
Chapter 1 Solution Overview............................................................................................................1
1.1 Solution Components...................................................................................................................................................11.2 Information Model Outline...........................................................................................................................................21.3 Management Capabilities Summary.............................................................................................................................21.3.1 SNMP Traps Support.................................................................................................................................................21.3.2 Commands Support....................................................................................................................................................21.3.3 Alarm Clearance.........................................................................................................................................................2
Chapter 2 Information Model............................................................................................................1
2.1 SNMP Agent Configuration .........................................................................................................................................12.1.1 Relationship between Configuration and Managed Entities........................................................................................12.2 Global Class Hierarchy................................................................................................................................................22.2.1 Class Pruning.............................................................................................................................................................22.3 Standard Directives......................................................................................................................................................22.4 MIB Global Class........................................................................................................................................................32.4.1 Notifications...............................................................................................................................................................32.4.2 Directives...................................................................................................................................................................32.4.3 Attributes....................................................................................................................................................................32.5 MIB Instance-less Child Class......................................................................................................................................32.5.1 Notifications...............................................................................................................................................................32.5.2 Directives...................................................................................................................................................................32.5.3 Attributes....................................................................................................................................................................32.6 Modifications to the Standard Data types.....................................................................................................................42.6.1 New Enumeration Data types.....................................................................................................................................42.6.1.1 XXXSpecificProblems.............................................................................................................................................4
Chapter 3 Information Model: <AM Name> Self Management Interface.......................................1
3.1 Class Hierarchy............................................................................................................................................................13.2 <AM Name>................................................................................................................................................................13.2.1 Attributes....................................................................................................................................................................13.2.2 Directives...................................................................................................................................................................23.2.2.1 DUMP Directive.....................................................................................................................................................23.2.3 Notifications...............................................................................................................................................................33.3 SINK............................................................................................................................................................................33.3.1 Attributes....................................................................................................................................................................33.3.2 Directives...................................................................................................................................................................53.3.2.1 ResetCounters Directive..........................................................................................................................................53.3.3 Notifications...............................................................................................................................................................5
v
Chapter 4 Connectivity...................................................................................................................... 1
4.1 Data Communication Network.....................................................................................................................................14.2 Information Model.......................................................................................................................................................2
Chapter 5 Trap Processing...............................................................................................................1
5.1 Generic Traps Mapping................................................................................................................................................15.1.1 coldStart Trap.............................................................................................................................................................15.1.2 warmStart Trap..........................................................................................................................................................25.1.3 linkDown Trap...........................................................................................................................................................25.1.4 linkUp Trap................................................................................................................................................................25.1.5 authenticationFailure Trap.........................................................................................................................................25.1.6 egpNeighborLoss Trap...............................................................................................................................................25.2 Standard Traps.............................................................................................................................................................35.2.1 Traps List...................................................................................................................................................................35.2.2 <Trap N1 Name>.......................................................................................................................................................35.2.3 <Trap N2 Name>.......................................................................................................................................................35.3 <MIB Name> Enterprise Specific Traps.......................................................................................................................45.3.1 Traps List...................................................................................................................................................................45.3.2 <Trap N1 Name>.......................................................................................................................................................45.3.3 <Trap N2 Name>.......................................................................................................................................................45.4 <MIB Name> Trap Mapping to OSI Alarm.................................................................................................................45.4.1 Managed Object.........................................................................................................................................................55.4.1.1 Additional Classes Adding.......................................................................................................................................55.4.2 Event Type.................................................................................................................................................................55.4.3 Perceived Severity......................................................................................................................................................65.4.4 Probable Cause..........................................................................................................................................................65.4.5 Additional Text...........................................................................................................................................................65.4.6 Specific Problem........................................................................................................................................................65.4.7 Notification Id............................................................................................................................................................65.4.8 Event Time.................................................................................................................................................................65.5 Extended Management Functions.................................................................................................................................65.5.1 Alarm Clearance.........................................................................................................................................................6
Chapter 6 General MIB Package Specifications.............................................................................1
6.1 Packaging.....................................................................................................................................................................16.2 Contents ......................................................................................................................................................................16.3 MIB Limitations...........................................................................................................................................................16.3.1 Minor Syntax Modifications.......................................................................................................................................16.3.2 Major Syntax Modifications.......................................................................................................................................1
Chapter 7 Publications...................................................................................................................... 1
7.1 Specification Documentation........................................................................................................................................17.1.1 <MIB Name> Functional Specification......................................................................................................................17.1.2 <MIB Name> Acceptance Test Specification.............................................................................................................17.2 Miscellaneous Documentation......................................................................................................................................17.2.1 Installation and Configuration Guide.........................................................................................................................1
Appendix A Standard SNMP Global class..........................................................................................1
Appendix A Standard SNMP Global class..........................................................................................1
A.1 Standard Directives.....................................................................................................................................................1A.1 Standard Directives.....................................................................................................................................................1A.1.1 Show 1A.1.1 Show 1A.1.2 Erase 1A.1.2 Erase 1A.1.3 Directory...................................................................................................................................................................1A.1.3 Directory...................................................................................................................................................................1
vi
A.1.4 Register.....................................................................................................................................................................1A.1.4 Register.....................................................................................................................................................................1A.1.5 Deregister..................................................................................................................................................................1A.1.5 Deregister..................................................................................................................................................................1A.1.6 Set 1A.1.6 Set 1A.1.7 GetEvent...................................................................................................................................................................1A.1.7 GetEvent...................................................................................................................................................................1A.1.8 Test 1A.1.8 Test 1A.1.9 Validate......................................................................................................................................................................2A.1.9 Validate......................................................................................................................................................................2A.2 Standard Directives Exceptions...................................................................................................................................2A.2 Standard Directives Exceptions...................................................................................................................................2A.3 Standard Attributes......................................................................................................................................................3A.3 Standard Attributes......................................................................................................................................................3A.3.1 Global Class Standard Attributes...............................................................................................................................3A.3.1 Global Class Standard Attributes...............................................................................................................................3A.4 Standard Events...........................................................................................................................................................4A.4 Standard Events...........................................................................................................................................................4
Appendix B <MIB Name> Specific Traps............................................................................................1
Appendix B <MIB Name> Specific Traps............................................................................................1
B.1 Trap List .....................................................................................................................................................................1B.1 Trap List .....................................................................................................................................................................1B.2 Trap Mapping Table ....................................................................................................................................................1B.2 Trap Mapping Table ....................................................................................................................................................1
Figures
Figure 1-1: Solution Components..................................................................................1
Figure 1-2: Global Class Information Model..................................................................2
Figure 2-3: Information Model .......................................................................................2
Figure 3-4: Information Model - Module Self Management Interface..........................1
Figure 4-5: Solution Components..................................................................................1
Tables
vii
Table 2-1: Standard Directive Support...........................................................................2
Table 2-2: XXXSpecificProblems Enumeration.............................................................4
Table 3-3: <AM Name> Attributes...................................................................................2
Table 3-4: Self Management –Directive Support...........................................................2
Table 3-5: <AM Name> Alarms........................................................................................3
Table 3-6: SINK Attributes...............................................................................................4
Table 3-7: Self Management –Directive Support...........................................................5
Table 5-8: Customized OSI Arguments..........................................................................4
Table 5-9: Added Classes................................................................................................5
Table 5-10: Tables Information........................................................................................5
Table 5-11: TeMIP Event Types........................................................................................6
Table 5-12: New TeMIP Probable Causes.......................................................................6
Table A-13 Standard Directives Exceptions...................................................................2
Table A-14: TeMIP SNMP Global Class Attributes.........................................................3
Table A-15: TeMIP SNMP Global Class Events..............................................................4
viii
Preface
Instructions to Begin Using this Template
Open this file in Word 2000 and turn on hidden text either by selecting the button ¶ or select toggle button in menu Tools Options View Hidden text. The following text formats are used:
Guidelines are written in red color, italic font and as hidden text.Guidelines are used to express what the contents of a chapter or section should be.Guidelines should be removed from the actual document built after this template.
Examples are written in regular font but blue colorExamples illustrate a guideline and shall provide an idea, how certain content can beexplained.
Generic text is written in regular black font.It can be used at is or with limited editing.
Bookmarks are used to enable automatic string substitution all across the document. Edit the bookmark, save and open the document again to make substitution visible. The Bookmarks referenced in this document are grouped in the section “Access Module Context” below. They just have to be edited there to make the changes effective throughout the document.
Access Module Context
Equipment Manufacturer: <Equipment Manufacturer>
Equipment Manufacturer SMI code: <Equipment Manufacturer Code>
Managed Equipment Name: <MIB Name>1
MIB SMI Version: [v1 | v2]
SNMP Agent Version: [v1 | v2c | v3]
AM name (clone AM2): <AM Name>
AM Application Id (clone AM): <AM_ID>
Customization file related to Equipment: <Customization file Name>
Customization file related to MIB-II: <Customization file Name>
IST toolkit version: V50I (HP-UX for Itanium), V50H (HP-UX for PA-RISC), V50M (Tru64 UNIX),V50S (Sun Solaris) or V61L (RHEL)
AM kit name: <EQT>
AM kit version: <100>
Access Module Summary
1 Note that it identifies main AM component, but a single AM may gather several IST customizations2 Note that standard SNMP_AM can be used
Supported Interface and Equipment
Important Note: Both tables are filled in a best-effort mode with the information retrievedfrom the manufacturer and our customers. Sometimes this information is not available ornot exhaustive.
Interface Qualified Version Compatible Version(s)
Equipment Version Domain
Fixed/Transport/Radio
Standard Supported Features
Feature Supported Restrictions / Comments
Alarms Forwarding Yes
Configuration Events Forwarding Yes/No
Network Inventory Yes/No
Alarm correlation based on Notification Id Yes/No
Alarm correlation based on Event Type, Probable Cause and Specific Problem
Yes/No
Alarm Resynchronization Yes/No With Resync FM
Alarm Acknowledgment Yes/No/partially With AAFM
Downward Acknowledgment Yes/No
Upward Acknowledgment Yes/No
Downward Termination Yes/No
Upward Termination Yes/No
Connection surveillance Yes/No
Automatic reconnection Yes/No
SNMP Techno-specific Supported Features
Feature Supported Restrictions / Comments
Enhanced Managed Object Mapping Yes/No use of an() external function(s) forMO mapping
Enhanced Specific Problem Mapping Yes/No use of an() external function(s) forSP mapping
Enhanced Notification Id Mapping Yes/No use of an() external function(s) forNotification Id mapping
Enhanced MIB for Managed ObjectMapping
Yes/No use of 'dummy table(s)' for MOmapping
Enhanced Event Time Mapping Yes/No When applicable, specify the way the Event Time Mapping is implementeduse of an() external function(s) forEvent Time MappingOruse of trap variable of typeDateAndTime
x
Purpose of this Document
This document is the functional specification of the <AM Name> built with <Equipment Manufacturer> MIB(s). It describes the related TeMIP IST (Internet SNMP Toolkit) customization loaded in <AM Name>.
Intended Audience
Prior knowledge of TeMIP, as well as an understanding of the concepts involved in translating and mapping SNMP data, commands and traps onto an object framework, are prerequisites to fully appreciate the contents of this document. This document is aimed at the following parties:
AM developers,
System Integrators,
Telecommunications Network Operations Managers.
Structure of this Document
Chapter 1 - Solution Overview
Presentation of main solution’s characteristics.
Chapter 2 - Information Model
Managed Object’s definitions pertaining to MIB data translated into TeMIP entity model.
Chapter 3 - Information Model: <AM Name> Self Management Interface
Managed Object’s definitions pertaining to the Access Module Management interface.
Chapter 4 - Connectivity
Managed Object’s definitions pertaining to the communication resourcesused to communicate with the agent (configuration).
Chapter 5 - Trap Processing
Description of SNMP traps and their customized elements pertaining to mapping of traps to OSI alarms.
Chapter 6 - General MIB Package Specifications
Provides general information about packaging and kit generation as well as MIB specificities (if any) needing workaround to allow their translation to TeMIP.
Chapter 7 - Publications
List of key documents and their purpose.
Conventions Used in this Manual
The following table explains some conventions used in this document.
Convention Description
[TOKEN] Reference to one of the associated documents mentioned in Preface section
Acronyms Used in this Manual
xi
The following table explains some acronyms used in this document.
AM Access ModuleASN.1 Abstract Syntax Notation One - A machine-independent data description
language. A small subset of ASN.1 is used to define the SNMP protocol.MIB customizationfile
File built on a MIB list, defining the applicable TeMIP model (singleglobal class hierarchy) and mapping rules of SNMP traps to OSI event
Deployment kit Subsets generated by IST that contain MIB customization file andmigration results, ready to be installed on TeMIP (IST specific).
Clone (of snmp_am) snmp_am replica allowing to have IST customs managed separately by aspecific module (fully compliant with snmp_am). on TeMIP (IST specific)
IST Internet SNMP Toolkit (TeMIP specific)MIB Management Information Base, specified in a file written in a subset of
the ASN.1 language.MIB I RFC1156 MIB II MIB I superset: RFC1158 (draft standard) then standard RFC1213 SNMP Variable A specific instance from a class of management information. Each class of
management information is called an object type. An SNMP variable is anobject instance.
MTU MIB Translator Utility (TeMIP specific)MSL Management Specification Language (TeMIP specific)NE Network ElementRHEL Red Hat Enterprise LinuxRFC Request for CommentsSMI Structured Management InformationSMI v1 SMI version defied by RFC1155, extended by RFC1211, 1212, 1215 for
MIB IISMI v2 SMI version defied by RFC1902, 1903, 1904 SMI for SNMP v2 (draft)SNMP Simple Network Management ProtocolSNMPv1 SNMP version defied by RFC1157SNMPv2c Community String Based Version of SNMP defied by RFC1901,
1905,1906SNMPv3 Latest SNMP version with enhanced security, defined in rfc2275, rfc2274
(not supported by IST) whereas message structure is supported (rfc2272)TCP/IP Transmission Control Protocol/Internet ProtocolTFR TeMIP Framework (TeMIP specific)
Terminology Note
This document uses the term “MIB” in a general way to mean the information (ASN1 definitions of objects) contained in a MIB file. Where necessary, these more specific terms are sometimes used:
“MIB file” means the file containing the MIB information.
“MIB module” is the container name of SNMP information in a MIB file. This name should be the first word in the MIB file (Comments excluded). The MIB module name may not necessarily be the same as the MIB file name. For example, the MIB module SNMPv2-SMI is contained in the file rfc1902.mib.
AM Library “MIB kit” means the set (tape file for HP-UX for Itanium and HP-UX for PA-RISC or tar file of setld kit for Tru64 UNIX or tar file of pkgadd kit for RHEL and Sun Solaris) containing the MIB documentation and files as well as Runtime kit.
Referenced Documents
The following documents are referenced in this Functional Specification:
[NExyz] Reference to Equipment Documentation as appropriate.
[MIBICOG] HP TeMIP Software <Equipment Manufacturer> <MIB Name> SNMP AM Installation and Configuration Guide.
xii
[MIBATS] HP TeMIP Software <Equipment Manufacturer> <MIB Name> SNMP AM Acceptance Test Specification
Associated Documents
The following documents contain supplementary information:
[ISTUSE] HP TeMIP Software Internet SNMP Toolkit (IST)Customization Guide.
[ISTCTR] HP TeMIP Software Internet SNMP Toolkit (IST)Configuration and Troubleshooting Guide.
xiii
Chapter 1Solution Overview
This generic SNMP Access Module supports bi-directional management capabilities:
It receives and processes unsolicited messages (SNMP traps).
It generates management commands and receives associated responses.
<AM Name> is addressing trap management (including customized mapping).
1.1 Solution ComponentsThe <MIB Name> is directly interfaced to TeMIP by means of <AM Name>
The <AM Name> is responsible for both the Information Model representing the management capabilities of the equipment and all associated semantic translations between its traps interface and TeMIP data models.
(1) When using Trap Dispatcher (the use of the Trap Dispatcher is mandatory when<AM Name> is a clone AM). See [MIBICOG].
(2) When not using Trap Dispatcher (the use of the Trap Dispatcher is optional if<AM Name> is not a clone AM (SNMP_AM)). See [MIBICOG].
Figure 1-1: Solution Components
TeMIP PM
TeMIP FM
<AMName>
<MIB Name>Agent
TeMIPORB
EventSink
TrapDispatcher
IP Poller FM
(1) (2)
1.2 Information Model OutlineThe <MIB Name> agent is represented by the information Model introduced in Figure 1 -2 below. Details are provided in following chapters.
The figure hereafter is an example illustrating the model:
1.3 Management Capabilities Summary
1.3.1 SNMP Traps Support
The <AM Name> shall handle the following traps (please refer to [NExyz] for further details):
Generic traps (6 types),
Standard traps, defined in RFCs MIBs (m types or none),
Enterprise specific traps, defined in MIB (n types or none).
Each trap types, sent by the SNMP agent, will issue OSI alarms, mapped as detailed inChapter 5.
1.3.2 Commands Support
The following commands are supported:
SNMP V1 basic commands: get, get-next, set request,
SNMP V2 commands: get-bulk request, Report PDU is not supported.
SNMP V3 commands: new header format except security features.
1.3.3 Alarm Clearance
Two processing of clearance exist, given here as an example. Keep only the description forprocessing of clearance used.
Some SNMP traps may have a corresponding clearance trap. The <MIB Name> agent [does not] provide with a specific alarm identifier to allow the correlation of the alarm with its clear message. So, alarm clearing is performed based on some fields in the message, according to ITU-T standards:
The alarm has severity clear; and the Managed Object, Event Type, Probable Cause and Specific Problem fields are the same as a previous alarm.
According to ITU-T standards, the clearance of an alarm can be done based on the following rule:
2 Solution Overview
Figure 1-2: Global Class Information Model
Whatever 1a
Whatever 1aa
<MIB Name>(SNMP MIB Global class)
Whatever 1(Enterprise code)
Whatever 2aWhatever 2 :(other rfc or mib packaged)
The alarm has severity clear; the Managed Object is the same of a previous alarm; and the Correlated Notification Identifier field is the same as the Notification Identifier of the previous alarm.
In order to clear a previous alarm, the <MIB Name> agent on the equipment sends a specific trap (with customization of Notification Identifier mapping on valid SNMP variable). The <AM Name> generates a Notification Identifier in every alarm message, and also in the clear alarm, so the TeMIP Alarm Handling can perform the clear correlation whenever required.
Solution Overview 3
Chapter 2Information Model
This chapter describes the Information Model customized from <MIB Name> SNMP MIB.It provides:
A quick overview of the SNMP agent configuration (also detailed in Chapter 4)
The <MIB Name> model set up in the IST customization file loaded in <AM Name>,with the class hierarchy in TeMIP.
IST toolkit requires a specific agent configuration based on SNMP_CONFIGURATION class. This global class represents the configuration repository that contains description of SNMP agents and their associated contexts. Those agents inherit the default parameters of this global instance.
IST toolkit allows creation of a global class representing the model described in <MIB Name> SNMP MIB. [When no global class is created, the model described in the <MIB Name> SNMP MIB is implemented as an INTERNET_SYSTEM class child.].
2.1 SNMP Agent Configuration SNMP_CONFIGURATION child class "AGENT" represents the agent description and characteristics.
The AGENT class attributes can be organized in two major categories:
SNMP agent configuration attributes (agent name).
Managed Entity identifier attributes (<MIB Name> global class instance).
A <MIB Name>AGENT instance has to be created for each <MIB Name> equipment (orproxy). It requires a <MIB Name> entity (i.e. any other global entity managed by the AM)for its creation. See also section 4.2.
2.1.1 Relationship between Configuration and Managed Entities
The relation between <MIB Name> (i.e. any other global entity managed by the AM) and one of AGENT or PROXY_DEVICE class is a bi-directional one-to-one relationship. A<MIB Name> entity is linked to one and only one AGENT or PROXY_DEVICE entity.
During runtime <AM Name> processing is based on the TeMIP instance creation identifying the agent. A managed entity (e.g. <MIB Name>or any other global entity managed by the AM) is strongly coupled with its associated agent. Once an AGENT is created, then the declared Managed Entity is becoming usable.
The SNMP agent instance is referenced in the IST standard attribute Associated Agent (seeTable A-14).
2.2 Global Class HierarchyThe classes belonging to the Information Model are shown in Figure 2 -3 with their naming relationships.
The following rules are applied: 1. <MIB Name> model is included in a global class defined in the customization file.2. The MIB nodes defined in the <MIB Name> MIBs are mapped to child entities of
<MIB Name> global class.3. MIB variables are mapped to attributes of related child entities.
2.2.1 Class Pruning
When the number of class levels belonging to the Information Model is above 10, the internal limit of TeMIP is reached. When the naming tree depth is larger than this limit, pruning is required.
Pruning of the entity model means that all entities without any attributes are removed. This keeps the entity model compressed and more manageable. However, this can be confusing since the entity model does not exactly match the MIB any more. If the user plans to add a number of MIBs under the same enterprise, then pruning should not be done, to preserve consistency (refer to [ISTUSE]).
2.3 Standard DirectivesStandard directives are supported by the Information Model as outlined in the Table 2 -1 below.
Table 2-1: Standard Directive Support
Class
Reg
iste
r
Der
egis
ter
Dir
ecto
ry
Era
se
Sho
w
Get
Eve
nt
Set
Tes
t
Val
idat
e
MIB Global class
Whatever 1
Whatever 2
The standard directives may raise a number of exceptions as defined in Appendix A section A.2.
2.4 MIB Global ClassAdd screen shot of the class hierarchy in the model.
2 Information Model
Figure 2-3: Information Model
Insert DAP browser screen capture here
2.4.1 Notifications
MIB traps (TRAP-TYPE and/or NOTIFICATION-TYPE for SMIV2) trigger creation of related events on a TeMIP class. This is not the default case but event class can be the global class when such events are moved in the IST custom. Then Notifications are generated against instances of the <MIB Name> global class.
Global class Standard Events are the following two:
IP Reachability Up
IP Reachability Down
Global class Generic Events are the following two:
coldStart
warmStart
2.4.2 Directives
Refer to Standard directives definitions of ISTUSE.
MIB specific directives attributes are generated from the operation items declared in the<MIB Name> MIB.
2.4.3 Attributes
Default standard attributes are defined in Table A-14.
MIB specific attributes are generated from the scalar OBJECT-TYPE declared in the<MIB Name> MIB.
2.5 MIB Instance-less Child ClassAdd screen shot of the class hierarchy in the model.
2.5.1 Notifications
The MIB item defining the current class (node, group) can handle traps (TRAP-TYPE andNOTIFICATION-TYPE). Then default related events are created on the current class. Then, notifications are generated for this class as the managed object.
Instance-less child class events are the 2 following:
Event1
Event2
2.5.2 Directives
Refer to Standard directives definitions of ISTUSE.
No specific directives can be generated from the <MIB Name> MIB.
Set directive is implemented because settable attribute(s) exist.
2.5.3 Attributes
There is no default or standard attributes.
As for the global class, specific attributes are generated from the scalar OBJECT-TYPE declared in the <MIB Name> MIB. The TeMIP access-level (settable or not) is determined with the ACCESS definition in MIB (which can be read-write or read-only).
2.6 Modifications to the Standard Data types
2.6.1 New Enumeration Data types
Information Model 3
In addition to the standard enumeration data types, the following is also defined:
XXXSpecificProblems
2.6.1.1 XXXSpecificProblems
XXXSpecificProblems is a user-defined enumeration to support the OSI alarm argument Specific Problem. The integer values are defined as follows:
The Presentation Name for x values ranging from NeAlarmChangeNotification to NetViewerServerTrapManagerNotify corresponds to either the name of the unique variable, which has a value in the specific trap, or the specific trap name.
The XXXSpecificProblems enumeration can be best viewed in Update the table below. Usually, there is one Specific Problem value per trap name or per pair of trap, in case where the same value is required to allow the automatic clearance correlation.
Table 2-2: XXXSpecificProblems Enumeration
String Value Integer Value
NeAlarmChangeNotification 1
NvSvrNetworkSeverityTrap 2
NvSvrNESeverityTrap 3
NetSvrServerStatusTrap 4
NetViewerServerTrapManagerNotify 5
4 Information Model
Chapter 3Information Model: <AM Name> Self Management
Interface
As with any Management Module within TeMIP, the <AM Name> module is a piece of code that can be managed via TeMIP standard Presentation Modules, just as any other manageable resource – be it an application, a logical resource or a piece of physical equipment. To enable this, the <AM Name> is represented as a series of classes whose characteristics are described in this chapter. These classes comprise the AM Self Management interface.
3.1 Class HierarchyFigure 3 -4 below introduces the classes used to represent and manage the <AM Name>.
MCC is the parent class for all Management Modules classes.
The <AM Name> (197)3class represents the Access Module on which <MIB Name> MIB IST customization is loaded, whereas SINK class represents the sub-system in charge of processing SNMP traps (see Figure 1 -1: Solution Components).
3.2 <AM Name>
3.2.1 Attributes
The <AM Name> attributes are defined in Table 3 -3 below:
3 If standard SNMP_AM not used, Indicate identifier of clone AM registered.
Figure 3-4: Information Model - Module Self Management Interface
MCC <AM Name> SINK
Table 3-3: <AM Name> Attributes
Partition Name
Set
tab
le Description
Characteristics ComponentIdentification
String identifying the AM. This string is: "TeMIP Framework <AM Name>"
LoadedCustomizations
Set of full path names identifying the IST custom files ".cst" currently loaded in AM <MIB Name>.cst (upon AM successful installation)
Componentversion
Version identifying the AM i.e. "V5.0.0"
Available MIBs Set of records containing the list of loaded MIBs per global entity.
( (class=" <MIB Name>", modules = { "<Module(s)4>" }
For SNMP_AM: the last item is corresponding to the new global class related to <MIB Name>. It isappended to the attribute previous value.
SNMP PrivateDictionary
Full path name of SNMP private Dictionary (default is /var/opt/temip/conf/<AM Name>.dat)
When a new dictionary is specified, the previous one is downloaded, and the new one is uploaded.
Status Availabilitystatus
Describes the State of the AM with anEnumeration Set of the 3 exclusive values:
{On / OffDuty / Degraded} OffDuty: when the AM is not able to process
event and Show (ex: initialization phase).
Degraded: When the AM has encountered a SNMP loading problem.
StatusExplanation
Explains reason of the s availability status value mentioned above i.e."SNMP AM is running"
3.2.2 Directives
Directives are supported by the Module Self-Management classes as outlined in Table 3 -4below.
Table 3-4: Self Management –Directive Support
Class Test Show Set GetEvent
<AM Name>
Other directives are: dump and ResetNamingCache
3.2.2.1 DUMP Directive
This action directive is designed to facilitate the maintenance or support of the SNMP AM.
It is based on the fact that most of internal C++ objects are traceable.
This directive has one argument, which is optional: Specified System (Enumerated).
4 Refer to section 6.1 Packaging
2 Information Model: <AM Name> Self Management Interface
By default, all systems are dumped.
Defined Systems are the following:
Naming Service
Configuration
Dictionary
Event Sink
Mapping Directive (Show, Set, etc)
3.2.3 Notifications
By default, each Critical or Major processing error encountered by the Event Sink generates a Processing Error alarm in addition to being logged as described above. Such an alarm alerts the TeMIP administrator to a major degradation in Event Sink service due to some internal error.
This behavior is activated or deactivated with the AM self-management attribute “OSI alarms on Critical/Major errors”.
OSI alarms issued by the SNMP AM can be collected, logged and handled by the TeMIP Alarm Handling and Event Logging applications.
The alarm defined in Table 3 -5 below can be generated against the <AM Name> entity.
Table 3-5: <AM Name> Alarms
Event Type Probable Cause Severity
Additional Text Error Context
Processing Error
softwareError Major SNMP AM error message Internal error on <AM Name>
3.3 SINKThe Event sink is responsible of receiving events traps or inform-request and to translate them into TeMIP event. It is waiting for events from the trap dispatcher. The AM support two distinct translation modes, called here the OSI and not OSI mode (note that "OSI mode" is always active).
In OSI mode, the events are translated by applying the customization rules.
For not OSI mode, the AM is responsible to build from raw trap data the correct TeMIP event.
The self-management of the Sink allows controlling and selecting the mapping mode usedto translate traps into TeMIP events (Not OSI mapping Mode attribute).
3.3.1 Attributes
Attributes of SINK class are defined in Table 3 -6 below.
Table 3-6: SINK Attributes
Partition Name
Set
tab
le Description
Characteristics Not OSI mappingMode
Enables the non-OSI event mapping mode. Default value is: False
Information Model: <AM Name> Self Management Interface 3
Partition Name
Set
tab
le Description
Process no-Authenticated Traps
Enables or disables trap authentication mechanism (valid only for the SNMP v1/v2c security model).Default value is: False
Log Received Traps Activates logging of raw trap data, which isachieved using the TeMIP Security Central Logging facilities. Default value is: False
Alarms On MappingErrors
When set to True, a Quality Of Service alarm is generated whenever a translation problem occurs. Default value is: True
OSI Alarms OnCritical Major Errors Default value is: True
Listening UDP PortNumber
Listening port number. This value is taken into account at Event Sink launch time and after reception of an event. Default = 3000 when the Trap Dispatcher isused, or 162 when it is not used. Note that it is recommended to use a value greater than 1024 when the Trap Dispatcheris used, in order to avoid a conflict with a system port number. Default value is: 3000
No Variable ValueString
Specifies the string displayed when a variable is not available for the Additional Text argument.Default value is: ""
Default Event Type Specifies the default event type. This value
is used when the OSI argument is not specified in the customization.Default value is: CommunicationsAlarm
Default PerceivedSeverity Default Perceived Severity. This value is
used when the OSI argument is not specified in the customization.Default value is: Indeterminate
Default ProbableCause Default Probable Cause. This value is used
when the OSI argument is not specified in the customization.Default value is: unknown
Unknown InstanceInteger This value is used to build a default
instance name.Default value is: 999
Unknown Instance IPAddress Default value is: 127.0.0.1
Unknown InstanceNetwork Address Default value is: 127.0.0.1
Unknown InstanceOid Default value is: { 0 0 }
Unknown InstanceString This value is used to build a default
instance name.Default value is: "unknown"
4 Information Model: <AM Name> Self Management Interface
Partition Name
Set
tab
le Description
Display unknownvariables Default value is: False
Unknown variableseparator Default value is: "/"
AcknowledgeInform-Request Default value is: False
Counters Number DiscardedTraps
Default value is:0 when the SNMP AM is started
<trap-type> TrapsReceived
<trap-type> stands for the following MIBIItrap types values: coldStart, warmStart, linkDown, linkUp, authenticationFailure, egpNeighborLoss, enterpriseSpecific
Total Traps Received Traps received total number (sum up 7 trap-types sub-totals described above).
Counter CreationTime
Event Sink start time
Status (See list indescription)
Standard Status attributes (Non-settable) used are:
sink state, time of last event, type of last event
3.3.2 Directives
Directives are supported by the Module Self-Management classes as outlined in Table 3 -7below.
Table 3-7: Self Management –Directive Support
Class Test Show Set GetEvent
SINK
Other directives are: Start, Stop and ResetCounters.
3.3.2.1 ResetCounters Directive
This action directive initializes the self-management counters (number of traps received bysorted per category).
3.3.3 Notifications
Quality of Service alarm may be generated whenever a translation problem occurs (lost events is detected or when a trap translation problem occurs). The Managed Object is either the global class SNMP_CONFIGURATION or a specific AGENT when it is known.
This behavior is managed by self-management attribute "Alarms on Mapping Errors”.
Potential problems are the following:
Unrequested TeMIP events: a trap is successfully translated and sent to the event manager but there is none of the TeMIP applications that issued a GETEVENT directive to collect this TeMIP event. In that case, the event is said to be lost and the SNMP AM generates an internal alarm on the AGENT matching the SNMP agent that sent trap.
Information Model: <AM Name> Self Management Interface 5
Unsuccessfully translated TeMIP events: If an SNMP trap cannot be translated in TeMIP event, the EVENT SINK logs an error message in the error file. The unsuccessfully translated TeMIP event is said to be lost and the SNMP AM generates a Quality Of Service alarm for troubleshooting purposes.
Unknown sender: the sender of an incoming trap is not defined. The MO is the global configuration Class. This TeMIP event is lost.
Discarded variables: A trap contains either wrongly encoded variable or not defined variables. It such case the SINK is just skipping those variables.
The Quality Of Service Alarm generated has the arguments listed hereafter:
Event Argument Argument Value
Managed Object SNMP_CONFIGURATION (for unknown sender) or a specific AGENT entity when known
Event Type Quality of Service Alarm
Event Time Timestamp
Probable Cause softwareError in case of unsuccessful event translation and unknown senderreceiveFailure in case of unrequested event and discarded variable
Perceived Severity Major in case of unsuccessful event translation and unknown senderWarning in case of unrequested event and discarded variable
Additional Text Translation error message logged in the file
6 Information Model: <AM Name> Self Management Interface
Chapter 4Connectivity
This chapter focuses on the communication aspects involved in interfacing TeMIP with the<MIB Name> agent. It shall initially document the main characteristics of the Data Communication Network (DCN), then list the equipment specific requirements and finallyshall provide a detailed definition of the managed objects used to represent and control thecommunication resources within TeMIP.
4.1 Data Communication Network
(1) When using Trap Dispatcher (the use of the Trap Dispatcher is mandatory when<AM Name> is a clone AM). See [MIBICOG].
(2) When not using Trap Dispatcher (the use of the Trap Dispatcher is optional if<AM Name> is not a clone AM (SNMP_AM)). See [MIBICOG].
4.2 Information ModelThe connectivity to the <MIB Name> agent is handled by TeMIP that inter-works with the<AM Name>.
Figure 4-5: Solution Components
TeMIP PM
TeMIP FM
<AMName>
<MIB Name>Agent
TeMIPORB
EventSink
TrapDispatcher
IP Poller FM
(1) (2)
ClientSide
ManagerSide
As introduced in section 2.1, IST toolkit introduces a specific agent configuration with SNMP_CONFIGURATION class. This global class represents the configuration repositorythat contains description of SNMP agents and their associated contexts.
The Naming Services through synonyms mechanism allows identifying AGENT entity through IP address. One of the AGENT class goals is to be an interface between SNMP global classes (<MIB Name>) and the Naming Services. AGENT entities can be used to populate, to update and to show IP synonyms stored in the Naming services database.
2 Connectivity
Chapter 5Trap Processing
This chapter introduces the processing associated to SNMP traps. It provides:
A commented description of Enterprise specific traps sent by <MIB Name> agent.
The current configuration set up for those traps in IST customization file.
Applicable rules for trap to alarm mappings (default when none specified).
The conventions defined in the table below will be used throughout this section:
Convention
Description
[expression]
SNMP MIB expression (<variable name>, <table name>)
<variable>
Variable
$Variable Trap Variable value
[expression]*
Zero or more occurrence of the expression
.* String wildcard (prefix or suffix) matching anypattern (used in varbind value testing of vendor traps).
o|Of String being either of or Of
t|To String being either to or To
5.1 Generic Traps Mapping
5.1.1 coldStart Trap
OSI Alarm Field Value Description
SEVERITY CriticalEVENT TYPE 2 CommunicationsAlarmPROBABLE CAUSE 58 SnmpTrapColdStartSPECIFIC PROBLEM coldStartMANAGED OBJECT <MIB Name>
ADDITIONAL TEXT A $_trap_name_ was received from $_agent_address_ at $_trap_time_stamp_.Manual clearance is required.
5.1.2 warmStart Trap
OSI Alarm Field Value Description
SEVERITY CriticalEVENT TYPE 2 CommunicationsAlarmPROBABLE CAUSE 59 SnmpTrapWarmStartSPECIFIC PROBLEM warmStartMANAGED OBJECT <MIB Name>
ADDITIONAL TEXT A $_trap_name_ was received from $_agent_address_ at $_trap_time_stamp_.Manual clearance is required.
5.1.3 linkDown Trap
OSI Alarm Field Value Description
SEVERITY CriticalEVENT TYPE 2 CommunicationsAlarmPROBABLE CAUSE 65 SnmpTrapLinkUpDownSPECIFIC PROBLEM linkUpDownMANAGED OBJECT <MIB Name> INTERFACES ifTableADDITIONAL TEXT A $_trap_name_ was received from $_agent_address_ at $_trap_time_stamp_
5.1.4 linkUp Trap
OSI Alarm Field Value Description
SEVERITY ClearEVENT TYPE 2 CommunicationsAlarmPROBABLE CAUSE 65 SnmpTrapLinkUpDownSPECIFIC PROBLEM linkUpDownMANAGED OBJECT <MIB Name> INTERFACES ifTableADDITIONAL TEXT A $_trap_name_ was received from $_agent_address_ at $_trap_time_stamp_
5.1.5 authenticationFailure Trap
OSI Alarm Field Value Description
SEVERITY MajorEVENT TYPE 2 CommunicationsAlarmPROBABLE CAUSE 62 SnmpTrapAuthenticationFailureSPECIFIC PROBLEM authenticationFailureMANAGED OBJECT <MIB Name> SNMPADDITIONAL TEXT A $_trap_name_ was received from $_agent_address_ at $_trap_time_stamp_.
Manual clearance is required.
5.1.6 egpNeighborLoss Trap
OSI Alarm Field Value Description
SEVERITY MajorEVENT TYPE 2 CommunicationsAlarmPROBABLE CAUSE 63 SnmpTrapEgpNeighborLossSPECIFIC PROBLEM egpNeighborLossMANAGED OBJECT <MIB Name> EGP
2 Trap Processing
OSI Alarm Field Value Description
ADDITIONAL TEXT A $_trap_name_ was received from $_agent_address_ at $_trap_time_stamp_.Manual clearance is required.
5.2 Standard Traps
5.2.1 Traps List
The table hereafter shall mention each SNMP trap (with its identifier) of additional standard MIB (RFC) required by <MIB Name>. Those traps (defined in RFC MIBs i.e. notEnterprise MIBs) are not listed in the next or previous section.
SNMP module Trap Oid Trap Name
5.2.2 <Trap N1 Name>
OSI Alarm Field Value Description
SEVERITYEVENT TYPEPROBABLE CAUSESPECIFIC PROBLEMNOTIFICATION IDCORRELATD NOTIFICATION IDMANAGED OBJECTADDITIONAL TEXTEVENT TIME
5.2.3 <Trap N2 Name>
OSI Alarm Field Value Description
SEVERITYEVENT TYPEPROBABLE CAUSESPECIFIC PROBLEMNOTIFICATION IDCORRELATD NOTIFICATION IDMANAGED OBJECTADDITIONAL TEXTEVENT TIME
5.3 <MIB Name> Enterprise Specific Traps
5.3.1 Traps List
The table hereafter (or in Appendix B.1) mentions each SNMP trap of <MIB Name> with its identifier.
SNMP module Trap Oid Trap NameVERILINK_ENTERPRISE_NCMALARM_MIB 1.3.6.x.y.z ncmTrap
5.3.2 <Trap N1 Name>
Trap Processing 3
OSI Alarm Field Value Description
SEVERITYEVENT TYPEPROBABLE CAUSESPECIFIC PROBLEMNOTIFICATION IDCORRELATD NOTIFICATION IDMANAGED OBJECTADDITIONAL TEXTEVENT TIME
5.3.3 <Trap N2 Name>
OSI Alarm Field Value Description
SEVERITYEVENT TYPEPROBABLE CAUSESPECIFIC PROBLEMNOTIFICATION IDCORRELATD NOTIFICATION IDMANAGED OBJECTADDITIONAL TEXTEVENT TIME
5.4 <MIB Name> Trap Mapping to OSI AlarmDefault <AM Name> settings raise OSI Alarms upon traps received from <MIB Name> agent.
The values of most OSI Alarm arguments are customizable in IST customization file as specified below.
The clause is either the value of the named SNMP variable in the received trap or another specified default value. See table below for each OSI argument mapping. Note that depending on the arguments, it can be default only, a variable only or both.
Table 5-8: Customized OSI Arguments
The table below defines the Mapping table format used in B.2
OSI Alarm Field Mapping Description Default Mapping DescriptionManaged Object class selector The entity defining this trap in the TeMIP
dictionaryEvent Type EquipmentAlarm CommunicationsAlarm Perceived Severity Rule or <default-severity> IndeterminateProbable Cause Rule or <default-value>Specific Problem Rule or <default-value>Additional Text ADDITIONAL TEXT formatEvent Time Rule or <default-value>
5.4.1 Managed Object
5.4.1.1 Additional Classes Adding
In order to allow automatic alarm clearance mechanism, the following classes have been added to the TeMIP model:
4 Trap Processing
Table 5-9: Added Classes
Class Name Class Location
The new classes have been obtained by the mapping of the following dummy tables defined in the <VENDOR_EQUIPMENT>-TRAPS-ADDITIONAL-TABLE-MIB MIB. This MIB is contained in file <VENDOR_EQUIPMENT>_traps_additional_tables.mib.
Note that these dummy tables have only been added for the TeMIP mapping, thus the SNMP agent does not use them.
Table 5-10: Tables Information
Table Name Table Index(es)
Typically, these classes are useful for trap mapping when:
The discriminating trap variable type is not numeric: DisplayString, Octet String, IpAddress… thus it can’t be used as Notification ID.
The trap has several discriminating variables that do not allow using an OFFSET in the Notification ID mapping.
In this case, the concerned trap variable(s) will be used as the new table index(es) to correlate the different incoming traps.
5.4.2 Event Type
The Event Type is evaluated according to the trap, the possible values are:
Table 5-11: TeMIP Event Types
Event Type Name Event Type ID
Communications Alarm 2Environmental Alarm 3Equipment Alarm 4Processing Error Alarm 10Quality Of Service Alarm 11
5.4.3 Perceived Severity
5.4.4 Probable Cause
The following probable causes have been added to the defined TeMIP probable causes (refer to [MIBICOG] for more information):
Trap Processing 5
Table 5-12: New TeMIP Probable Causes
Probable Cause Name Probable Cause ID
5.4.5 Additional Text
5.4.6 Specific Problem
Refer to Paragraph 2.6.1.1
5.4.7 Notification Id
5.4.8 Event Time
5.5 Extended Management FunctionsThis section is given as an example to detail Extended Management such as trap clearance.
5.5.1 Alarm Clearance
Refer to 1.3.3 (Alarm Clearance) about processing of clearance selection. The <MIB Name> does or does not provide a specific alarm identifier to allow the correlation of the alarm with its clear message.
The first basic concerned traps can be linkUp and linkDown. Those 2 traps are mapped as events and are customized to clear each other.
The other concerned traps coming from specific MIBs are the following:
2 different cases can exist for MIB specific traps:
SNMP traps having a corresponding clearance trap: a specific trap type clears anothertrap (for instance linkUp is clearing linkDown).
Other traps can provide “self clearance” i.e. an alarm coming from the same trap typeclears previous alarm of same type depending on a variable value, that assign severityfor instance.
6 Trap Processing
Chapter 6General MIB Package Specifications
6.1 PackagingThe MIB is packaged following AMCE standard policy, (refer to [MIBICOG]).
6.2 Contents
Customization File Input MIB file Name(s)<MIB Name>.cst <MIB Name>.mib
[<MIB Name>2.mib]
MIB File Module Name<MIB Name>.mib <MIB Name>-MODULE1
6.3 MIB Limitations<AM Name> has been built on top of the MIB files listed above. While preparing build ofthe AM, some <Equipment Manufacturer> MIB specificities have been met (such asincorrect ASN1 syntax for SMI standard followed). As a workaround to allow theirtranslation to TeMIP, MIB files require some syntax modifications. Such files need to bemodified and renamed with suffix _customized before the .mib extension (or equivalent).
6.3.1 Minor Syntax ModificationsMinor modifications details are listed below.
File (MIB) name Modification
6.3.2 Major Syntax ModificationsMajor modifications details are listed below.
File (MIB) name Modification
Chapter 7Publications
7.1 Specification Documentation
7.1.1 <MIB Name> Functional Specification
Purpose:
Functional specification of the HP TeMIP Access Module for the <MIB Name> from <Equipment Manufacturer>.
Intended Audience:
SNMP MIB developers, Systems Integrators, Telecommunications Network Operations Managers.
Prerequisite Knowledge:
TeMIP, SNMP.
Reference:
[MIBFS]
7.1.2 <MIB Name> Acceptance Test Specification
Purpose:
Describe the functionality being validated for AM Acceptance.
Intended Audience:
HP AM Library, System Integrators.
Prerequisite Knowledge:
SNMP, TeMIP, IST.
Reference:
[MIBATS]
7.2 Miscellaneous Documentation
7.2.1 Installation and Configuration Guide
Purpose:
Describe the installation and configuration procedures for the SNMP <MIB Name> AM.
Intended Audience:
Systems Integrators.
Prerequisite Knowledge:
TeMIP, SNMP, IST
Reference:
[MIBICOG]
2 Publications
Appendix AStandard SNMP Global class
This appendix groups the standard definitions for the SNMP Global class.
A.1 Standard Directives
A.1.1 Show
The SHOW directive is used to retrieve attribute values.
It cannot be used on its own to reveal remote attributes (i.e. attributes maintained on the NE), but it can be mapped onto commands that retrieve these attributes (customization task).
The directives exceptions are listed in section A.2 below.
A.1.2 Erase
The TeMIP standard Configuration Erase directive is used.
A.1.3 Directory
The TeMIP standard Directory directive is used.
A.1.4 Register
The TeMIP standard Register directive is used.
Adding to TeMIP standard Register directive exceptions, two new SNMP specific directiveexceptions are listed in section A.2 below.
A.1.5 Deregister
The TeMIP standard Deregister directive is used.
A.1.6 Set
The SET directive is used to modify (settable) attribute values. When no settable attribute is defined for the class this directive is not defined.
A.1.7 GetEvent
The TeMIP standard GETEVENT directive is used to receive traps. When no event is defined for the class (SNMP group without traps/notifications for SNMP v2), this directiveis not defined.
A.1.8 Test
The Test directive allows testing the IP reachability of an SNMP entity. This test is based on an ICMP request (This behavior is equivalent to querying the IP Reachability synthetic attribute).
A.1.9 Validate
The Validate directive allows detection of possible inconsistencies between the TeMIP Dictionary and the SNMP Dictionary.
A.2 Standard Directives ExceptionsTable A-13 below lists the specialized exceptions raised by the SNMP standard directives.
Table A-13 Standard Directives Exceptions
Directive Exception Description
Register reg_bad_dup Inconsistent duplicate registration: entity already registered, but ID information is inconsistent with existing registration of this or another entity.
Register reg_bad_id The registration name is already used by the class <Registered Entity Class>
Register reg_id_in_use Duplicate registration identifier, identifier already in use by another entity.
Register reg_unrec_id Unrecognized registration name. The namespace name must be a full name, include aleading “”.””.
Register req_argument_missing Required argument is not supplied.
Register req_arg_missing Required argument <Required Class Argument>is not supplied.
Register reg_ns_noaccess Unable to register name, problem while accessing the namespace.
Register reg_ns_nodir Unable to register name, required namespace directory does not exist.
Register reg_ns_prot Unable to register name, protection violation in the namespace.
Show Unable to complete operation
It is used when the AM encountered a SNMP PDU encoding/decoding problem, or when it cannot remove an offending attribute (for example, the error-index is not correct).
Show No Such Entity The AM is not able to find an IP address for processing this request. For example: show snmp all id Or the specified instance is unknown (only in the case of the ID partition).
Show Cannot communicate The AM succeeded in retrieving the agent IP address but it cannot communicate with the agent. This happens when an ICMP request to the agent fails.
Show/Set/ Test
naming service error Problem with Naming Services database.
Show/Set/ Test
not authenticated agent error
The remote agent is not authenticated.
A-2 Standard SNMP Global class
Directive Exception Description
Show/Set/ Test
snmp configuration error
Problem with SNMP Configuration.
Show/Set/ Test
internet communicationerror
Internet communications device error <InetDevError>
Show/Set/ Test
internet information missing
No internet address defined for this entity.
Set set incompleteProblem(s) modifying attribute(s).
Test test unsupported This test is not available for this type of entity.
Show show unsupported group
Unsupported attribute group.
Validate Validate Dictionary Inconsistency
Inconsistency between the TeMIP Dictionary and the SNMP Dictionary.
A.3 Standard AttributesThis section groups the definitions for the SNMP global classes (toolkit originated) standard attributes.
A.3.1 Global Class Standard Attributes
Table A-14: TeMIP SNMP Global Class Attributes
Partition Name
Set
tab
le Description
Identifiers Registered Name Primary name
Full Name. No default
References Reference attributes Standard descriptive attributes: Location, Implementation Desc, Responsible Person, Phone Number, Mail Account, Remarks and Text file.
All Latin1String. No defaults
Naming Address Primary IP Address. Alternative name (related to ASCII Naming Service)
IPAddress. No default
Associated Agent Specify an AGENT or a PROXY_DEVICE entity (related to IP Naming Service)
FullEntityName. No default
Name Synonym. Alternative name (related to ASCII Naming Service)
InternetName. No default
Characteristics snmpTrapOID The authoritative identification of the notification currently being sent
Latin1String. No default
snmpTrapEnterprise
The authoritative identification of the enterpriseassociated with the trap currently being sent
Latin1String. No default
Standard SNMP Global class A-3
Partition Name
Set
tab
le Description
snmpSetSerialNo An advisory lock used to allow several cooperating SNMPv2 entities, all acting in a manager role, to coordinate their use of the SNMPv2 set operation
32-bitInteger. No default
Routing Managing Director Name of the TeMIP director managing the entity.
FullName: No default
Status ipReachabilityup, secondary up, down. Specify if the node isreachable or not. When an agent is reachableonly by one of its secondary addresses, it isdeclared as Secondary Up.
Enumeration: No default
A.4 Standard EventsThe OSI events defined in Table A-15 below can be generated against the <AM Name> entity.
Table A-15: TeMIP SNMP Global Class Events
Event Type Probable Cause Severity
Additional Text Error Context
Processing Error
softwareError Major SNMP AM error message Internal error on <AMName>
A-4 Standard SNMP Global class
Appendix B<MIB Name> Specific Traps
This appendix groups the definitions for the SNMP <MIB Name> Specific TrapsSNMP<MIB Name> MIB enterprise Specific Traps mapping is also detailed.
B.1 Trap List This table shall mention each SNMP trap of <MIB Name> with its identifier.
SNMP module Trap Oid Trap NameVERILINK_ENTERPRISE_NCMALARM_MIB 1.3.6.x.y.z ncmTrap
B.2 Trap Mapping Table SNMP <MIB Name>MIB enterprise specific Traps mapping is detailed in the table below. Table columns shall represent main customized OSI arguments. The customization is already detailed in Chapter 5.
Trap Name Event Type Managed Object SeverityTrap1 EquipmentAlarm mibclass WarningTrap2 CommunicationsA
larm[DEFAULT]mibclass Warning
Trap3 (not customized)