Ipe-4000 SNMP Agent
Ipe-4000 SNMP Agent
Ipe-4000 SNMP Agent
09/15/2009
Version 1.0
09/15/2009
Version 1.0
Revision History
Date
Rev
09/15/2009
1.0
Author
Phil England
Description
Initial revision
1.
09/15/2009
Version 1.0
OVERVIEW ......................................................................................................................4
1.1
BACKGROUND ........................................................................................................................... 4
1.2
ABOUT SNMP ........................................................................................................................... 4
1.2.1
SNMPv1 Message Types............................................................................................... 4
1.2.2
SNMP MIB....................................................................................................................... 4
1.2.3
SNMP OID ....................................................................................................................... 5
1.2.4
SNMP Protocol Data Unit (PDU) ................................................................................... 6
1.2.5
Determining OIDs for SNMP Tables.............................................................................. 6
1.2.6
RowStatus for SNMP Tables.......................................................................................... 7
1.2.7
Row Creation for SNMP Tables..................................................................................... 7
1.2.8
Row Deletion for SNMP Tables ..................................................................................... 8
1.2.9
Further Reading .............................................................................................................. 8
1.3
IPE MIB.................................................................................................................................... 8
1.4
SETTING READ AND WRITE COMMUNITY STRINGS ...................................................................... 8
1.5
MANAGEMENT APPLICATION SYSTEM REQUIREMENTS ................................................................ 8
2.
CAPABILITIES..................................................................................................................9
2.1
2.2
3.
4.
5.
INDEX ............................................................................................................................15
09/15/2009
Version 1.0
1. Overview
1.1
Background
The IPE-4000 (IPE) provides an efficient method for transmitting IP (Internet Protocol)
data in the format defined by the DVB standard for data broadcasting. Typical
applications include multimedia content delivery, high-speed Internet access, and file
transfer applications.
The IPE allows users to multiplex numerous IP data services, delivered over Ethernet, into one
DVB/ATSC compliant transport stream. It delivers IP data directly to a satellite, cable, or wireless
broadcast modulator for output to a broadcast PC client at downstream throughput speeds of up
to 200 Mbps.
1.2
About SNMP
Sent by
Manager
Yes
Sent by
Agent
No
Get-nextrequest
Set-request
Yes
No
Yes
No
Get-response
No
Yes
Trap
No
Yes
Description
A management application will send this message to
an agent to request a value from the agent.
A management application will send this message to
an agent to request a value from the agent.
A management application will send this message to
an agent in an attempt to change a value in the agent.
An agent will send this message to a management
application as a response to a get-request, get-nextrequest, or set-request message.
An agent will send this message to a management
application to notify the management application of an
event.
09/15/2009
Version 1.0
OID Numbers
1
1.3
1.3.6.1.4.4290
1.3.6.1.4.4290.2
1.3.6.1.4.4290.2.2
1.3.6.1.4.4290.2.2.
2
1.3.6.1.4.4290.3.1.
1
Alternate Representations
Iso.org or iso.3
Enterprises.4290
Enterprises.Logic-innovations.2
Enterprises.Logic-innovations.Products.2
Enterprises.Logic-innovations.Products.Ipe.2
Trap-management.trapTable.trapEntry
09/15/2009
Version 1.0
root
iso(1)
org(3)
dod(6)
internet(1)
private(4)
enterprises(1)
logic-innovations(4290)
products(2)
trap-management(3)
ipe(2)
trapTable(1)
ipe4000(2)
trapEntry(1)
v1(1)
...
...
Figure 1-1 A Portion of the IPE-4000 MIB Represented as a Tree
1.2.4 SNMP Protocol Data Unit (PDU)
A SNMP message is sent in a packet that SNMP calls a Protocol Data Unit (PDU). Management
software should send PDUs to the IPE at UDP port 161. The IPE will send trap PDUs to
management software at UDP port 162.
1.2.5 Determining OIDs for SNMP Tables
A table can be thought of as a 2 dimensional array of nodes. As with any 2-dimensional array,
the table will have rows and columns. A SNMP table must have at least one index that uniquely
identifies a row of the table. In the case of a table with more than one index, it is the combination
of both indexes that uniquely identifies a row of the table.
09/15/2009
Version 1.0
When constructing OIDs for tables it is important to understand that the lexicographical ordering
(used by the get-next operator) for tables will "walk" through each row of a column before moving
on to the next column. The OID for a cell in the table will consist of the root of the table entry,
followed by the column identifier, followed by the row index. We can represent this as
tableEntry.columnID.rowIndex. Where row index may consist of multiple values separated by
decimal points in the case where the table has multiple indexes and/or indexes consisting of
multi-byte values.
1.2.6 RowStatus for SNMP Tables
A table that supports row creation and deletion will have a "rowStatus" column. For the
RouteTable for example, this is the routeRowStatus column. The rowStatus column will control
the creation and deletion of a row.
A rowStatus entry in a table can take the following values:
Name
Value
Description
Active
1
Indicates that the row is active.
CreateAndGo
Destroy
OID (name)
routeParentIndex.0.0
routeName.0.0
routeIpVersion.0.0
routeIpAddress.0.0
routeIpMask.0.0
routeMacType.0.0
routeMacAdddress.0.0
routeSectionPacking.0.0
routeUdpFlowControlEnable
routeRowStatus.0.0
Value
2 (parent index in the PID table)
TestRoute
ipv4(1)
224.000.000.000
255.255.255.255
mac(1)
01.00.5E.00.00.00
enabled(1)
disabled(2)
createAndGo(4)
09/15/2009
Version 1.0
These steps will create a new row in the table. A get-request of routeRowStatus will return
active(1).
1.2.8 Row Deletion for SNMP Tables
To delete the row created in section 1.2.7, perform a set-request for the OID routeRowStatus to a
value of destroy(6).
This operation will delete the row in the table.
1.2.9 Further Reading
A more complete discussion of SNMP is beyond the scope of this document. Chapter 25 of
TCP/IP Illustrated, Volume 1 contains a more complete overview of SNMP.
1.3
IPE MIB
The IPE SNMP Agent uses a proprietary MIB defined in the following files located on the About
page of the web interface (and also on the CD that ships with each product):
Logic-tc.mib
Logic.mib
Logic-ipe4000.mib
The file logic-tc.mib defines textual conventions used in all Logic Innovations SNMP
implementations.
The file logic.mib defines the top of the Logic-innovations tree, nodes for other LII products and a
trap management table common to other LII products.
The file logic-ipe4000.mib defines the variables specific to monitoring and controlling the IPE4000.
1.4
IPE SNMP agent supports the use of two community strings to control network access to the IPE
SNMP agent. Network management software issuing requests to read values from the SNMP
agent must provide the appropriate "Read Community" string in the SNMP PDU. Write requests
must contain the appropriate "Write Community" string.
The default Read Community string is public and the default Write Community string is private.
These strings can be changed using the Admin->SNMP Comm. Strings menu on the web
interface.
1.5
SNMP Management applications for the IPE-4000 can be developed to run on any platform that
supports SNMP, in any language that supports sending/receiving UDP datagrams.
09/15/2009
Version 1.0
2. Capabilities
2.1
2.2
Unsupported Features
09/15/2009
Version 1.0
1.3.6.1.4.1.4290
1.3.6.1.4.1.4290.2
1.3.6.1.4.1.4290.2.2
1.3.6.1.4.1.4290.2.2.2
1.3.6.1.4.1.4290.3
1.3.6.1.4.1.4290.3.1
1.3.6.1.4.1.4290.3.1.1
10
09/15/2009
Version 1.0
The MIB nodes listed below exist only to create a hierarchical tree organization for the IPE-4000
MIB, and are not accessible. The IPE will reject any set-request or get-request messages that
identify these OIDs as the target. The IPE will respond to get-next-request messages that identify
these OIDs as the target. In the case of a get-next-request, the value returned will be the next
accessible value in lexicographic order.
ipe4000
i4kAbout
i4KAdmin
i4kSystem
i4kNetwork
i4kRedundancy
i4kConfiguration
i4kOutput
4.2
4.2.1
1.3.6.1.4.1.4290.2.2.2
1.3.6.1.4.1.4290.2.2.2.1
1.3.6.1.4.1.4290.2.2.2.2
1.3.6.1.4.1.4290.2.2.2.3
1.3.6.1.4.1.4290.2.2.2.4
1.3.6.1.4.1.4290.2.2.2.5
1.3.6.1.4.1.4290.2.2.2.6
1.3.6.1.4.1.4290.2.2.2.7
aboutFirmware
aboutUptime
4.2.2
OID
adminLicense
4.2.3
Description
1.3.6.1.4.1.4290.2.2.2.1.1.0
1.3.6.1.4.1.4290.2.2.2.1.2.0
OID
Description
1.3.6.1.4.1.4290.2.2.2.2.3.0
OID
Description
systemClock
1.3.6.1.4.1.4290.2.2.2.3.1.0
systemTempProcessor
systemTempSystem
systemTempDimm
1.3.6.1.4.1.4290.2.2.2.3.2.0
1.3.6.1.4.1.4290.2.2.2.3.3.0
1.3.6.1.4.1.4290.2.2.2.3.4.0
systemFanSpeed1
systemFanSpeed2
systemFanSpeed3
systemFanSpeed4
1.3.6.1.4.1.4290.2.2.2.3.5.0
1.3.6.1.4.1.4290.2.2.2.3.6.0
1.3.6.1.4.1.4290.2.2.2.3.7.0
1.3.6.1.4.1.4290.2.2.2.3.8.0
systemVoltageIn0
systemVoltageIn1
systemVoltageIn2
systemVoltageIn3
systemVoltageIn4
1.3.6.1.4.1.4290.2.2.2.3.9.0
1.3.6.1.4.1.4290.2.2.2.3.10.0
1.3.6.1.4.1.4290.2.2.2.3.11.0
1.3.6.1.4.1.4290.2.2.2.3.12.0
1.3.6.1.4.1.4290.2.2.2.3.13.0
11
09/15/2009
Version 1.0
Description
networkDataSpeed
networkDataDuplex
OID Name
1.3.6.1.4.1.4290.2.2.2.4.1.0
1.3.6.1.4.1.4290.2.2.2.4.2.0
networkDataRxPackets
1.3.6.1.4.1.4290.2.2.2.4.3.0
networkDataRxBytes
1.3.6.1.4.1.4290.2.2.2.4.4.0
networkDataRxErrors
1.3.6.1.4.1.4290.2.2.2.4.5.0
networkDataRxDrops
1.3.6.1.4.1.4290.2.2.2.4.6.0
networkDataTxPackets
1.3.6.1.4.1.4290.2.2.2.4.7.0
networkDataTxBytes
1.3.6.1.4.1.4290.2.2.2.4.8.0
networkDataTxErrors
1.3.6.1.4.1.4290.2.2.2.4.9.0
networkDataTxDrops
1.3.6.1.4.1.4290.2.2.2.4.10.0
networkMncSpeed
networkMncDuplex
1.3.6.1.4.1.4290.2.2.2.4.11.0
1.3.6.1.4.1.4290.2.2.2.4.12.0
networkMncRxPackets
1.3.6.1.4.1.4290.2.2.2.4.13.0
networkMncRxBytes
1.3.6.1.4.1.4290.2.2.2.4.14.0
networkMncRxErrors
1.3.6.1.4.1.4290.2.2.2.4.15.0
networkMncRxDrops
1.3.6.1.4.1.4290.2.2.2.4.16.0
networkMncTxPackets
1.3.6.1.4.1.4290.2.2.2.4.17.0
networkMncTxBytes
1.3.6.1.4.1.4290.2.2.2.4.18.0
networkMncTxErrors
1.3.6.1.4.1.4290.2.2.2.4.19.0
networkMncTxDrops
1.3.6.1.4.1.4290.2.2.2.4.20.0
4.2.5
Description
redundancyEnable
redundancyMode
OID Name
1.3.6.1.4.1.4290.2.2.2.5.1.0
1.3.6.1.4.1.4290.2.2.2.5.2.0
redundancyPartner
1.3.6.1.4.1.4290.2.2.2.5.3.0
redundancyRouterId
redundancyVrrpVirtualIpEnable
1.3.6.1.4.1.4290.2.2.2.5.4.0
1.3.6.1.4.1.4290.2.2.2.5.5.0
Enables/disables redundancy.
Specifies the redundancy mode
(simple=1, chain=2)
Specifies the IP address/computer
name of the IPEs redundant
partner. For redundancy to
function, each IPE in a redundant
pair must specify the IP address
/computer name of the other IPE
set in this field. If
redundancyEnable is disabled, this
value is ignored.
Specifies the redundancy router ID.
Enables/disables redundancy
12
09/15/2009
Version 1.0
redundancyVrrpVirtualIp
1.3.6.1.4.1.4290.2.2.2.5.6.0
redundancyRipEnable
redundancyRipMetric
1.3.6.1.4.1.4290.2.2.2.5.7.0
1.3.6.1.4.1.4290.2.2.2.5.8.0
redundancySwitchOnContactClosure
redundancyDisableTsOnFault
1.3.6.1.4.1.4290.2.2.2.5.9.0
1.3.6.1.4.1.4290.2.2.2.5.10.0
4.2.6
OID
configurationName
configurationRouteName
4.2.7
virtual IP.
Specifies the redundancy Virtual
IP address.
Enables/disables RIP.
Defines the RIP metric used by the
IPE when it is Standby.
Description
1.3.6.1.4.1.4290.2.2.2.6.1.0
1.3.6.1.4.1.4290.2.2.2.6.2.0
OID
Description
outputTable
outputAsiTable
1.3.6.1.4.1.4290.2.2.2.7.1
1.3.6.1.4.1.4290.2.2.2.7.2
programTable
1.3.6.1.4.1.4290.2.2.2.7.3
pidTable
1.3.6.1.4.1.4290.2.2.2.7.4
routeTable
1.3.6.1.4.1.4290.2.2.2.7.5
OID
Description
outputIndex
outputType
1.3.6.1.4.1.4290.2.2.2.7.1.1.1.0
1.3.6.1.4.1.4290.2.2.2.7.1.1.2.0
outputEnable
1.3.6.1.4.1.4290.2.2.2.7.1.1.3.0
4.2.9
Description
outputAsiIndex
outputAsiRate
outputAsiPacketSize
outputAsiFlowControlEnable
OID Name
1.3.6.1.4.1.4290.2.2.2.7.2.1.1.0
1.3.6.1.4.1.4290.2.2.2.7.2.1.2.0
1.3.6.1.4.1.4290.2.2.2.7.2.1.3.0
1.3.6.1.4.1.4290.2.2.2.7.2.1.4.0
outputAsiFlowControlPidOrPort
1.3.6.1.4.1.4290.2.2.2.7.2.1.5.0
outputTsid
1.3.6.1.4.1.4290.2.2.2.7.2.1.6.0
13
09/15/2009
Version 1.0
OID
Description
1.3.6.1.4.1.4290.2.2.2.7.3.1.1.0
1.3.6.1.4.1.4290.2.2.2.7.3.1.2.0
1.3.6.1.4.1.4290.2.2.2.7.3.1.3.0
1.3.6.1.4.1.4290.2.2.2.7.3.1.4.0
1.3.6.1.4.1.4290.2.2.2.7.3.1.5.0
1.3.6.1.4.1.4290.2.2.2.7.3.1.6.0
Description
pidIndex
pidParentIndex
OID Name
1.3.6.1.4.1.4290.2.2.2.7.4.1.1.0
1.3.6.1.4.1.4290.2.2.2.7.4.1.2.0
pidNumber
pidEncapFormat
1.3.6.1.4.1.4290.2.2.2.7.4.1.3.0
1.3.6.1.4.1.4290.2.2.2.7.4.1.4.0
pidSectionPack
pidRowStatus
1.3.6.1.4.1.4290.2.2.2.7.4.1.5.0
1.3.6.1.4.1.4290.2.2.2.7.4.1.6.0
Description
routeIndex
routeParentIndex
OID Name
1.3.6.1.4.1.4290.2.2.2.7.5.1.1.0
1.3.6.1.4.1.4290.2.2.2.7.5.1.2.0
routeName
1.3.6.1.4.1.4290.2.2.2.7.5.1.3.0
routeIpAddress
routeIpMask
routeIpVersion
routeMacType
1.3.6.1.4.1.4290.2.2.2.7.5.1.4.0
1.3.6.1.4.1.4290.2.2.2.7.5.1.5.0
1.3.6.1.4.1.4290.2.2.2.7.5.1.6.0
1.3.6.1.4.1.4290.2.2.2.7.5.1.7.0
routeMacAddress
1.3.6.1.4.1.4290.2.2.2.7.5.1.8.0
routeIpCopyPrefix
1.3.6.1.4.1.4290.2.2.2.7.5.1.9.0
routeIpCopyPrefixLength
1.3.6.1.4.1.4290.2.2.2.7.5.1.10.0
routeUdpFlowControlEnable
1.3.6.1.4.1.4290.2.2.2.7.5.1.11.0
routeUdpFlowControlBufferSize
1.3.6.1.4.1.4290.2.2.2.7.5.1.12.0
routeUdpFlowControlAddress
1.3.6.1.4.1.4290.2.2.2.7.5.1.13.0
routeUdpFlowControlPort
1.3.6.1.4.1.4290.2.2.2.7.5.1.14.0
routeUdpFlowControlTxTtl
1.3.6.1.4.1.4290.2.2.2.7.5.1.15.0
routeRowStatus
1.3.6.1.4.1.4290.2.2.2.7.5.1.16.0
14
09/15/2009
Version 1.0
5. Index
DVB .......................................................... 4
i4kAbout...................................................11
i4kAdmin ..................................................11
i4kConfiguration .......................................13
i4kNetwork ...............................................12
i4kOutput .................................................13
i4kRedundancy ........................................12
i4kSystem ................................................11
Internet Protocol........................................ 4
Ipe4000....................................................10
Logic.mib .............................................8, 10
Logic-innovations .....................................10
Logic-ipe4000.mib..................................... 8
Logic-Ipe4000.mib ...................................11
Logic-tc.mib ...............................................8
outputAsiTable.........................................13
outputTable..............................................13
pidTable...................................................14
Products ..................................................10
programTable ..........................................14
RIP ..........................................................13
routeTable ...............................................14
TrapEntry.................................................10
Trap-management ............................... 5, 10
TrapTable ................................................10
15