0% found this document useful (0 votes)
2K views18 pages

IP10 MIB Reference

ceragon ip10 mib

Uploaded by

afrizzoni
Copyright
© Attribution Non-Commercial (BY-NC)
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
2K views18 pages

IP10 MIB Reference

ceragon ip10 mib

Uploaded by

afrizzoni
Copyright
© Attribution Non-Commercial (BY-NC)
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 18

FibeAir® IP-10

MIB
Reference Guide

Version 2.0
January 2009
Notice
This document contains information that is proprietary to Ceragon Networks Ltd.
No part of this publication may be reproduced, modified, or distributed without prior written authorization of
Ceragon Networks Ltd.
This document is provided as is, without warranty of any kind.

Registered TradeMarks
Ceragon Networks® is a registered trademark of Ceragon Networks Ltd.
FibeAir® is a registered trademark of Ceragon Networks Ltd.
CeraView® is a registered trademark of Ceragon Networks Ltd.
Other names mentioned in this publication are owned by their respective holders.

TradeMarks
CeraMapTM, PolyViewTM, EncryptAirTM, ConfigAirTM, CeraMonTM, EtherAirTM, and MicroWave FiberTM, are
trademarks of Ceragon Networks Ltd.
Other names mentioned in this publication are owned by their respective holders.

Statement of Conditions
The information contained in this document is subject to change without notice.
Ceragon Networks Ltd. shall not be liable for errors contained herein or for incidental or consequential damage in
connection with the furnishing, performance, or use of this document or equipment supplied with it.

Information to User
Any changes or modifications of equipment not expressly approved by the manufacturer could void the user’s
authority to operate the equipment and the warranty for such equipment.
Copyright © 2009 by Ceragon Networks Ltd. All rights reserved.

Corporate Headquarters: European Headquarters:


Ceragon Networks Ltd. Ceragon Networks (UK) Ltd.
24 Raoul Wallenberg St. 4 Oak Tree Park, Burnt Meadow Road
Tel Aviv 69719, Israel North Moons Moat, Redditch,
Tel: 972-3-645-5733 Worcestershire B98 9NZ, UK
Fax: 972-3-645-5499 Tel: 44-(0)-1527-591900
Email: [email protected] Fax: 44-(0)-1527-591903
www.ceragon.com Email: [email protected]
North American Headquarters: APAC Headquarters
Ceragon Networks Inc. Ceragon Networks (HK) Ltd.
10 Forest Avenue, Singapore RO
Paramus, NJ 07652, USA Level 34 Centennial Tower
Tel: 1-201-845-6955 3 Temasek Avenue
Toll Free: 1-877-FIBEAIR Singapore 039190
Fax: 1-201-845-5665 Tel - + 65 6549 7886
Email: [email protected] Fax: +65 6549 7011

FibeAir® IP-10 MIB Reference Guide 2


Contents

Chapter 1: Introduction ..........................................................................................................................4

About Ceragon MIB......................................................................................................................................... 4

About this Guide.............................................................................................................................................. 4

Terminology..................................................................................................................................................... 5

Chapter 2: Private MIB Structure ..........................................................................................................6

MIB Top Level ................................................................................................................................................. 6

gnEquipUnit Section........................................................................................................................................ 7

GnEquipNetwork Section ................................................................................................................................ 8

gnEquipFault Section ...................................................................................................................................... 8

GnEquipMng Section .................................................................................................................................... 10

Chapter 3: Common Tasks ..................................................................................................................11

General Data ................................................................................................................................................. 11

Current Alarms .............................................................................................................................................. 12

Trap Processing ............................................................................................................................................ 14

FibeAir® IP-10 MIB Reference Guide 3


Chapter 1: Introduction

About Ceragon MIB


The Ceragon Networks® MIB (Management Information Base) is a set of properties within the
device to be managed. Every managed device keeps a database of values for each of the
definitions written in the MIB that can be used by management applications to control FibeAir®
functions via the SNMP-V1 protocol.
The MIB is divided into public and private groups. The private group is owned by Ceragon
Networks® and supplements the public group.
The Ceragon MIB supports the following public MIB standards:

● RFC-1213 (MIB II)

● RMON

About this Guide


This guide describes the Private Ceragon MIB for FibeAir IP-10 and the parts of the standard MIBs
that Ceragon supports.
The guide is divided into the following chapters:

‰ Introduction: Provides a general background of the Ceragon MIB, and lists the terms
used in this guide.

‰ Private MIB Structure: A brief explanation of the structure of the Private Ceragon MIB.

‰ Common Tasks: In this chapter, there is task-oriented detailed explanation, for


example, customer that would like to access the unit Current Alarm table, should look in
the Current Alarm section of this chapter.

Notes:

‰ The Ceragon MIB is documented. This document does not replace the Ceragon MIB file, but
complements it. Application developers should also get and inspect the latest version of
Ceragon MIB file to have a complete and updated understanding on the issues that they
want to access in the network element.

‰ This document only refers to the new generation of Ceragon network elements which are
based on the FibeAir® Family (FibeAir 1500P, 640P, 3200T, and others).

FibeAir® IP-10 MIB Reference Guide 4


Terminology
The following terms are used in this Guide.

Term Meaning
API Application Programming Interface
IDU Indoor Unit
RFU Radio Frequency Unit
MIB A management information base (MIB) is a formal description of a set of network
objects that can be managed using the Simple Network Management Protocol
(SNMP).
NMS Network Management System
ODU Outdoor Unit
OID MIB Object ID, a sequence of integers that uniquely identifies a managed object by
defining a path to that object through a tree-like structure.

FibeAir® IP-10 MIB Reference Guide 5


Chapter 2: Private MIB Structure

MIB Top Level


The Private Ceragon MIB consists of a top level and four primary MIB sections, as follows:

Ceragon Private Top level of the MIB.

gnEquipUnit General API set of the unit.

gnEquipNetwork Contains API sets that define the network connections.

gnEquipFault Contains current alarm and traps configurations.

gnEquipMng Contains API sets for SW management.

The top level and primary units are shown in the following figure.

Ceragon gnEquipUnit
Private
gnEquipNetwork

gnEquipFault

gnEquipMng

The following chapters describe each of the primary MIB sections individually.

FibeAir® IP-10 MIB Reference Guide 6


gnEquipUnit Section

Ceragon gnEquipUnit
Private
gnEquipNetwork

gnEquipFault

gnEquipMng

The gnEquipUnit section includes general system parameters.

genEquipLastCfgTimeStamp This parameter specifies the last configuration change time.


Time is in seconds since January 1, 1970 00:00 UTC.

genEquipRealTimeandDate This parameter specifies the real time and date Format 'YYYY-
MM-DD,HH:MM:SS' (Hexadecimal).

genEquipPMGenTime This value indicates the generation time of the Performance


Monitor file. The value is presented in time_t format.

genEquipInvGenTime This value indicates the generation time of the inventory


information file. The inventory file holds the configuration
information of the unit. The value is presented in time_t format.

genEquipOperation Enables to perform IDC HW reset

FibeAir® IP-10 MIB Reference Guide 7


GnEquipNetwork Section

Ceragon gnEquipUnit
Private
gnEquipNetwork

gnEquipFault

gnEquipMng

The gnEquipNetwork section describes the network connection of the unit.

It contains these Read Only parameters:

genEquipNetworkRemoteIp Indicates the Remote IP address.

genEquipNetworkMateIp Indicates the Mate IP address.

gnEquipFault Section
The gnEquipFault section uses for Fault management.

Ceragon gnEquipUnit
Private
gnEquipNetwork

gnEquipFault CurrentAlarm

gnEquipMng TrapCfg

The gnEquipFault includes the following tables:

genEquipCurrentAlarm Contains the current alarm table

genEquipTrapCfgMgr Trap management table.

FibeAir® IP-10 MIB Reference Guide 8


gnEquipCurrentAlarm Subsection
The following figure shows the gnEquipCurrentAlarm subsection.

Ceragon gnEquipUnit
Private
gnEquipNetwork

gnEquipFault CurrentAlarm

gnEquipMng TrapCfg

genEquipCurrentAlarmLastChangeCounter This counter initialized with random number after


resest, and incremented on each change in the
gnAgnCurrentAlarmTable (either add or remove of
an entery).

genEquipCurrentAlarmTable This table contains the current alarms of the unit. The fields
of this table are described in the "common task" section.

genEquipMostSevereAlarm The severity of the most severe alarm in the system.

gnEquipTrapCfg Subsection
The following figure shows the gnEquipTrapCfg subsection.

Ceragon gnEquipUnit
Private
gnEquipNetwork

gnEquipFault CurrentAlarm

gnEquipMng TrapCfg TrapCfgOption

TrapCfgMgr

genEquipTrapCfgOption Includes General configurations for the traps (CLLI and


Heartbeat).

genEquipTrapCfgMgrTable This table contains the configurations for the traps (manager
IP and filters).

FibeAir® IP-10 MIB Reference Guide 9


GnEquipMng Section

Ceragon gnEquipUnit
Private
gnEquipNetwork

gnEquipFault

gnEquipMng gnEquipMngSw

The gnEquipMng contains genEquipMngSw, parameters for SW management:

genEquipMngSwServerUrl Remote SW Update Server URL where SW updates reside.

genEquipMngSwServeLogin Remote server login.

genEquipMngSwServerPassword Remote server password (will be removed in the next IP-10


release 2.x.x).

genEquipMngSwProxyUrl Proxy server URL.

genEquipMngSwServerUrl Proxy server login.

genEquipMngSwDownloadStatus Download software status.

genEquipMngSwInstallStatus Install software status.

genEquipMngSwCommand Command for activating the download and upgrade of the


SW.

FibeAir® IP-10 MIB Reference Guide 10


Chapter 3: Common Tasks
This chapter provides dipper information over several common integration tasks that are done by
Ceragon customers.
The tasks that are detailed include:
‰ General Data
‰ Current Alarms
‰ Trap Processing

General Data

Standard MIB Information


Some general info about the network element can be retrieved from the supported standard MIB
(RFC1213-MIB):

MIB Name Access Description

sysDescr R/O Textual description of the network element

sysObjID R/O A unique identifier that identifies the product type, current possible
values are:
‰ 1.3.6.1.4.1.2281.1.1: FA 1500 Regenerator
‰ 1.3.6.1.4.1.2281.1.2: FA 1500 Access
‰ 1.3.6.1.4.1.2281.1.3: FA 1500A
‰ 1.3.6.1.4.1.2281.1.5: FA 1500AL
‰ 1.3.6.1.4.1.2281.1.4: FA 1500P
‰ 1.3.6.1.4.1.2281.1.4.1: FA 1500P – Diversity
‰ 1.3.6.1.4.1.2281.1.4.2: FA 640
‰ 1.3.6.1.4.1.2281.1.4.3: FA 3200T using 1500P cards
‰ 1.3.6.1.4.1.2281.1.6.1: FA 3200T
‰ 1.3.6.1.4.1.2281.1.7.1: IP-10

sysUpTime R/O The time (in hundredths of a second) since the network
management portion of the system was last re-initialized.

sysContact R/W The textual identification of the contact person for this network
element.

sysName R/W An administratively-assigned name for the network element.


By convention, this is the node's fully-qualified domain name.

sysLocation R/W The physical location of this node network element.

FibeAir® IP-10 MIB Reference Guide 11


Another imported supported standard MIB (RFC1213-MIB) is the ifTable MIB, this table defines the
interfaces of the network element, important columns of the table are:

MIB Name Access Description

ifIndex R/O A unique value for each interface. This value is used in many places
in Ceragon MIB, to associate data with the interface, one example is
in the current alarm table, the value gnAgnCurrentAlarmIfIndex
contains the ifIndex of the interface where the alarm occurred.

ifDesc R/O A textual string containing information about the interface.

ifType R/O The type of interface, distinguished according to the physical/link


protocol(s) immediately `below' the network layer in the protocol
stack.

ifAdminStatus R/W This entry can be used to enable/disable the interface.

ifOperStatus R/O The current operational state of the interface (Up/Down).

Current Alarms
The current alarm table contains all the currently unit open alarm (i.e., raised alarms). This table
contain most of the fields that are sent in the trap when the alarm situation occurred, thus a
system that is monitors the traps, may use the current alarms table for Alarm Synchronization.

An application that pulls the alarm table should use the MIB
genEquipCurrentAlarmLastChangeCounter. Whenever application pulls the table, it should store
also the value of this MIB, and do the next poll only if this value differs from the value of this MIB
variable in the last poll.

Note that the application must use "differ" (if stored value is different then
genEquipCurrentAlarmLastChangeCounter then do poll) and not "less than", as it is not guaranteed
that the genEquipCurrentAlarmLastChangeCounter will always increase in value.

Note that if an application only needs to know the network element topmost severity (e.g. so it
color the element icon on the application map), than that info can be retrieved from the variable
genEquipMostSevereAlarm.

FibeAir® IP-10 MIB Reference Guide 12


The Ceragon Current Alarm table contains the following entries:

MIB Name Access Description

genEquipCurrentAlarmCounter R/O A running counter of open alarm, the counter is


incremented on every new Raised trap. It is cleared
after reset.

genEquipCurrentAlarmRaisedTi R/O Timestamp of this alarm, this number is the


meT seconds from midnight 1.1.1970.
The time zone used is GMT.
genEquipCurrentAlarmId R/O Entity Id
genEquipCurrentAlarmName R/O The name of the alarm
genEquipCurrentAlarmInstance R/O The instance of the alarm
enEquipCurrentAlarmSeverity
R/O One of: Event, Warning, Minor, Major or Critical

genEquipCurrentAlarmIfIndex R/O Interface index where the alarm occurred, alarms


that are not associated with specific interface will
have the following value:
For IDC related alarms the value is: 65001
The interface index is used to identify the
interface in the ifTable (See more info in the
“Standard MIB Information” section).
genEquipCurrentAlarmModule R/O IDU or RFU

genEquipCurrentAlarmProbableC R/O The alarm probable cause.


ause
genEquipCurrentAlarmCorrective R/O The alarm corrective actions.
Actions

genEquipCurrentAlarmState R/O The state of the alarm (cleared or rasied).

FibeAir® IP-10 MIB Reference Guide 13


Trap Processing
General Description
When an alarm situation occurs in the unit, the unit send a message to the managing computer,
that message is called trap.
The unit can be configured to send traps to up to four managers, it is possible to configure for each
manager which traps will be sent, by severity or by alarm groups.
The unit can send traps for Events, and Alarms, Alarms have duration, and can have different level
of severities, while events do not have duration.

Trap Sending Configuration


The following MIB values let you configure the various trap options:

MIB Name Access Description

genEquipTrapCLLI R/W Common Language Location Identifier


(maximum length 30 characters). This string is
sent in a field in the trap.

genEquipTrapCfgOptionHeartbeatPeriod R/W Configure the element to send heartbeat trap.


The value is in minutes.
Value of 0 disables this feature.
Using the genEquipTrapCfgMgrTable, It is possible to configure up to four manages, to whom, traps
will be sent. It is possible also to define trap filters for each of the managers.
Note that the trap community (the community that is sent with the trap) is common to all the
managers (it is not possible to configure different trap community per manager).
The entries of the genEquipTrapCfgMgrTable are (replace n with the manager number: 1..4):

MIB Name Access Description

genEquipTrapCfgMgrId R/O This value indicates an index of a specific


manager

genEquipTrapCfgMgrIP.n R/W The manager IP address. Value of 0 will disable


that entry.

genEquipTrapCfgMgrGroupMask.n R/W Mask by groups

genEquipTrapCfgMgrSeverityFilter.n R/W This is a bitmask value for masking traps


according to its severity. If the relevant bit is on
(set), then the Agent will send traps with this
severity. You can combine values by using
bitwise OR.

FibeAir® IP-10 MIB Reference Guide 14


MIB Name Access Description

‰ 1 (bit 1): Event.


‰ 2 (bit 2): Warning.
‰ 4 (bit 3): Minor.
‰ 8 (bit 4): Major.
‰ 16 (bit 5): Critical.

genEquipTrapCfgStatusChangeFilter.n R/W When enabled send traps only when the status of
the system changes (i.e. only when most-severe
changes).

genEquipTrapCfgMgrPort.n R/W The port number on which the manager is


listening for traps, the default is 162.

genEquipTrapCfgMgrName.n R/W The manager name that configured to receive the


traps

Trap Format:
In IP-10 all alarms are sent in one trap which is composed of variables that are detailed in the
table below. The variables in the trap are the same as those described in the current alarm section.
The variables include:
• genEquipCurrentAlarmCounter
• genEquipCurrentAlarmRaisedTimeT
• genEquipCurrentAlarmId
• genEquipCurrentAlarmName
• genEquipCurrentAlarmInstance
• genEquipCurrentAlarmSeverity
• genEquipCurrentAlarmIfIndex
• genEquipCurrentAlarmModule
• genEquipCurrentAlarmDesc
• genEquipCurrentAlarmProbableCause
• genEquipCurrentAlarmCorrectiveActions
• genEquipCurrentAlarmState

Traps may be used for updating the alarm status in northbound management systems. That way
the variables in the trap are the same as the in the current alarm table. In addition as mentioned
above the genEquipCurrentAlarmLastChangeCounter helps to determine periodically if another pull
of the current alarm is required or if the alarm picture as the drwan by the trap is up to date.
For making the correlation between the current alarm and the traps the trap as "unique key" which
separate it from other alarms. The "unique key" of the trap is the combination of these three
variables: genEquipCurrentAlarmId, genEquipCurrentAlarmName and
genEquipCurrentAlarmInstance.
In the next release of IP-10 (2.x.x), we will change the name field to contain the "full tree path" of
the alarm. This means that this variable (genEquipCurrentAlarmName) can be treated as the
unique key without the need to use the other two variables.

FibeAir® IP-10 MIB Reference Guide 15


Management Traps & Current Alarms
When the Ceragon NMS system (PolyView™) is configured to forward traps to northbound
management systems, in addition to forwarding of traps received from the network elements, it
will also send management traps to northbound management systems (for example, when license
expires, when user try to repeatedly login with erroneous password, …).
Details on these traps can be found in the management MIB (ceraNMS.mib file).
The management traps contain 2 variables:

MIB Name Description

nmsCurrentAlarmSeverity Can be one of the following:


‰ Event (1)
‰ Warning (3)
‰ Minor (7)
‰ Major (15)
‰ Critical (31)

nmsCurrentAlarmText The alarm display text.


PolyView NMS is an SNMP agent by itself, in addition to its functionalities of Trap Forwarding, and
Alarm Synchronization. Applications can access it (as if they access network element), and retrieve
the current alarms of the whole network that is managed by that PolyView server.
PolyView current alarm table entries are:

MIB Name Access Description

nmsCurrentAlarmCounter R/O A running counter of open alarm, the counter is


incremented on every new Raised trap. It is cleared
after reset. This counter is (optionally) attached to
each trap.

nmsIpAddress R/O The IP address of the managed element

nmsCurrentAlarmSeverity R/O One of:


‰ Event (1)
‰ Warning (3)
‰ Minor (7)
‰ Major (15)
‰ Critical (31)

nmsCurrentAlarmId R/O Alarm Identifier (contains alarm type and interface).


The Alarm ID will have the same value for the Raise &
Clear of the same alarm.
Note that the same alarm type (e.g. LOS) will have
different ID if it is raised on different interfaces.
The alarm ID should be used by the polling application
to identify if the polled alarm is already raised in its
system for that managed IP.

FibeAir® IP-10 MIB Reference Guide 16


MIB Name Access Description

nmsCurrentAlarmIfIndex R/O Interface index where the alarm occurred, alarms that
are not associated with specific interface will have the
following value:
For IDC related alarms the value is: 65001
For drawer1 related alarms the value is: 65003
For drawer2 related alarms the value is: 65004
The interface index is used to identify the interface in
the ifTable (See more info in the “Standard MIB
Information” section).
For FA 3200T systems, the value for alarms that are
associated with an a carrier and not specific interface,
it will be 65000 + the alarm origin.

nmsCurrentAlarmOrigin R/O The origin drawer of the alarm, for 1500P systems, one
of:
‰ IDC (2)
‰ Drawer #1 (3)
‰ Drawer #2 (4)
‰ Unknown (5)

Management Alarms will have the origin:


‰ Management (400)
For 3200T systems:
‰ IDC #n (256 + n), e.g., IDC #1 (257)
‰ Drawer #n (512 + n), e.g., Drawer #1
(513)
‰ XC #n (768 + n), e.g., XC #1 (769)

nmsCurrentAlarmUnit R/O A lower level of the alarm origin, one of:


‰ IDC (2)
‰ ODU (3)
‰ MUX (4)
‰ Modem (5)
‰ Drawer (6)
‰ Unknown (7)
‰ XC (Cross Connect) (9)
‰ Management (400)

nmsCurrentAlarmTrapID R/O The trap ID of the trap that was sent when the alarm
occurred, this is important for systems that implement
Alarm Synchronization, and want to recreate the trap
and send it to northbound system, when they identify
that the original trap was not received from the

FibeAir® IP-10 MIB Reference Guide 17


MIB Name Access Description
managed element.

nmsCurrentAlarmTimeT R/O Timestamp of this alarm, this number is the seconds


from midnight 1.1.1970.
The time zone used is GMT.

nmsCurrentAlarmText R/O The alarm display text (same as the text in the sent
trap) - up to 45 characters long.

FibeAir® IP-10 MIB Reference Guide 18

You might also like