Imported Upstream version 0.4.8
[platform/upstream/libsmi.git] / mibs / ietf / HPR-MIB
1 HPR-MIB DEFINITIONS ::= BEGIN
2
3   IMPORTS
4         DisplayString, DateAndTime, TimeStamp, TEXTUAL-CONVENTION
5                 FROM SNMPv2-TC
6
7         Counter32, Gauge32, Unsigned32, TimeTicks,
8         OBJECT-TYPE, MODULE-IDENTITY
9                 FROM SNMPv2-SMI
10
11         MODULE-COMPLIANCE, OBJECT-GROUP
12                 FROM SNMPv2-CONF
13
14         snanauMIB
15                 FROM SNA-NAU-MIB
16
17         SnaControlPointName
18                 FROM APPN-MIB;
19
20 hprMIB MODULE-IDENTITY
21         LAST-UPDATED  "9705140000Z"
22         ORGANIZATION  "AIW APPN / HPR MIB SIG"
23         CONTACT-INFO
24
25                 "
26
27                         Bob Clouston
28                         Cisco Systems
29                         7025 Kit Creek Road
30                         P.O. Box 14987
31                         Research Triangle Park, NC 27709, USA
32                         Tel:    1 919 472 2333
33                         E-mail: clouston@cisco.com
34
35                         Bob Moore
36                         IBM Corporation
37                         800 Park Offices Drive
38                         RHJA/664
39                         P.O. Box 12195
40                         Research Triangle Park, NC 27709, USA
41                         Tel:    1 919 254 4436
42                         E-mail: remoore@ralvm6.vnet.ibm.com
43                 "
44       DESCRIPTION
45                 "This is the MIB module for objects used to
46                  manage network devices with HPR capabilities."
47 ::= { snanauMIB 6 }
48 -- snanauMIB ::= { mib-2 34 }
49
50 -- *********************************************************************
51 -- Textual Conventions
52 -- *********************************************************************
53 -- SnaControlPointName is imported from the APPN MIB
54
55 HprNceTypes ::= TEXTUAL-CONVENTION
56       STATUS current
57       DESCRIPTION
58           "A bit string identifying the set of functions provided by a
59           network connection endpoint (NCE).  The following values are
60           defined:
61
62                 bit 0:  control point
63                 bit 1:  logical unit
64                 bit 2:  boundary function
65                 bit 3:  route setup
66           "
67
68       SYNTAX BITS { controlPoint(0),
69                     logicalUnit(1),
70                     boundaryFunction(2),
71                     routeSetup(3) }
72
73 HprRtpCounter ::= TEXTUAL-CONVENTION
74       STATUS current
75       DESCRIPTION
76           "An object providing statistics for an RTP connection.  A
77           Management Station can detect discontinuities in this counter
78           by monitoring the correspondingly indexed
79           hprRtpCounterDisconTime object."
80
81       SYNTAX Counter32
82
83 -- *********************************************************************
84   hprObjects         OBJECT IDENTIFIER ::= { hprMIB 1 }
85 -- *********************************************************************
86
87 -- *********************************************************************
88 hprGlobal            OBJECT IDENTIFIER ::= { hprObjects 1 }
89 -- *********************************************************************
90 -- The hprGlobal group applies to both intermediate and end nodes.
91 -- *********************************************************************
92
93 hprNodeCpName OBJECT-TYPE
94       SYNTAX SnaControlPointName
95       MAX-ACCESS read-only
96       STATUS current
97       DESCRIPTION
98           "Administratively assigned network name for the APPN node
99           where this HPR implementation resides.  If this object has
100           the same value as the appnNodeCpName object in the APPN MIB,
101           then the two objects are referring to the same APPN node."
102
103       ::= { hprGlobal 1 }
104
105 hprOperatorPathSwitchSupport  OBJECT-TYPE
106       SYNTAX INTEGER {
107                       notSupported(1),
108                       switchTriggerSupported(2),
109                       switchToPathSupported(3)
110                      }
111       MAX-ACCESS read-only
112       STATUS current
113       DESCRIPTION
114           "This object indicates an implementation's level of support
115           for an operator-requested path switch.
116
117             notSupported(1)           - the agent does not support
118                                         operator-requested path switches
119             switchTriggerSupported(2) - the agent supports a 'switch
120                                         path now' command from an
121                                         operator, but not a command to
122                                         switch to a specified path
123             switchToPathSupported(3)  - the agent supports both a
124                                         'switch path now' command and a
125                                         command to switch to a specified
126                                         path.  Note that the latter
127                                         command is not available via
128                                         this MIB; a system that supports
129                                         it must do so via other means,
130                                         such as a local operator
131                                         interface."
132
133       ::= { hprGlobal 2 }
134
135 -- *********************************************************************
136 hprAnrRouting        OBJECT IDENTIFIER ::= { hprObjects 2 }
137 -- *********************************************************************
138
139 hprAnrsAssigned OBJECT-TYPE
140       SYNTAX Counter32
141       UNITS "ANR labels"
142       MAX-ACCESS read-only
143       STATUS current
144       DESCRIPTION
145           "The count of ANR labels assigned by this node since it was
146           last re-initialized.  A Management Station can detect
147           discontinuities in this counter by monitoring the
148           appnNodeCounterDisconTime object in the APPN MIB."
149
150       ::= { hprAnrRouting 1 }
151
152 hprAnrCounterState  OBJECT-TYPE
153       SYNTAX INTEGER {
154                       notActive(1),
155                       active(2)
156                      }
157       MAX-ACCESS read-write
158       STATUS current
159       DESCRIPTION
160           "This object is used for a network management station to turn
161           on/off the counting of ANR packets in the hprAnrRoutingTable.
162           The initial value of this object is an implementation choice.
163
164                  notActive(1) - the counter hprAnrPacketsReceived
165                                 returns no meaningful value
166                  active(2)    - the counter hprAnrPacketsReceived is
167                                 being incremented and is returning
168                                 meaningful values"
169
170       ::= { hprAnrRouting 2 }
171
172 hprAnrCounterStateTime OBJECT-TYPE
173       SYNTAX DateAndTime
174       MAX-ACCESS read-only
175       STATUS current
176       DESCRIPTION
177           "The time when the hprAnrCounterState object last changed its
178           value.  The initial value returned by this object is the time
179           at which the APPN node instrumented with this MIB was last
180           brought up."
181
182       ::= { hprAnrRouting 3 }
183
184 hprAnrRoutingTable OBJECT-TYPE
185       SYNTAX SEQUENCE OF HprAnrRoutingEntry
186       MAX-ACCESS not-accessible
187       STATUS current
188       DESCRIPTION
189           "The ANR Routing table provides a means of correlating an
190           incoming ANR label (i.e., one assigned by this node) with the
191           TG over which a packet containing the label will be forwarded.
192           When the ANR label identifies a local NCE, the hprAnrOutTgDest
193           and hprAnrOutTgNum objects have no meaning.  The table also
194           contains an object to count the number of packets received
195           with a given ANR label."
196
197       ::= { hprAnrRouting 4 }
198
199 hprAnrRoutingEntry OBJECT-TYPE
200       SYNTAX HprAnrRoutingEntry
201       MAX-ACCESS not-accessible
202       STATUS current
203       DESCRIPTION
204           "The ANR label is used to index this table."
205
206       INDEX  { hprAnrLabel }
207
208       ::= { hprAnrRoutingTable 1 }
209
210 HprAnrRoutingEntry ::= SEQUENCE {
211      hprAnrLabel             OCTET STRING,
212      hprAnrType              INTEGER,
213      hprAnrOutTgDest         DisplayString,
214      hprAnrOutTgNum          INTEGER,
215      hprAnrPacketsReceived   Counter32,
216      hprAnrCounterDisconTime TimeStamp
217      }
218
219 hprAnrLabel OBJECT-TYPE
220       SYNTAX OCTET STRING (SIZE (1..8))
221       MAX-ACCESS not-accessible
222       STATUS current
223       DESCRIPTION
224           "The first ANR label in an incoming packet."
225
226       ::= { hprAnrRoutingEntry 1 }
227
228 hprAnrType OBJECT-TYPE
229       SYNTAX INTEGER {
230                       nce(1),
231                       tg(2)
232                      }
233       MAX-ACCESS read-only
234       STATUS current
235       DESCRIPTION
236           "An object indicating whether an ANR label assigned by this
237           node identifies a local NCE or a TG on which outgoing packets
238           are forwarded.
239
240               nce(1)  - the ANR label identifies a local NCE.  In this
241                         case the hprAnrOutTgDest and hprAnrOutTgNum
242                         objects have no meaning.
243               tg(2)   - the ANR label identifies a TG."
244
245       ::= { hprAnrRoutingEntry 2 }
246
247 hprAnrOutTgDest OBJECT-TYPE
248       SYNTAX DisplayString (SIZE (0 | 3..17))
249       MAX-ACCESS read-only
250       STATUS current
251       DESCRIPTION
252           "Destination node for the TG over which packets with this ANR
253           label are forwarded.  This is the fully qualified name of an
254           APPN network node or end node, formatted according to the
255           SnaControlPointName textual convention.  If the ANR label
256           identifies a local NCE, then this object returns a zero-length
257           string.
258
259           This object corresponds to the appnLocalTgDest object in the
260           APPN MIB."
261
262       ::= { hprAnrRoutingEntry 3 }
263
264 hprAnrOutTgNum OBJECT-TYPE
265       SYNTAX INTEGER (0..255)
266       MAX-ACCESS read-only
267       STATUS current
268       DESCRIPTION
269           "Number of the TG over which packets with this ANR label are
270           forwarded.  If the ANR label identifies a local NCE, then this
271           object returns the value 0, since 0 is not a valid TG number
272           for a TG that supports HPR.
273
274           This object corresponds to the appnLocalTgNum object in the
275           APPN MIB."
276
277       ::= { hprAnrRoutingEntry 4 }
278
279 hprAnrPacketsReceived OBJECT-TYPE
280       SYNTAX Counter32
281       UNITS "ANR packets"
282       MAX-ACCESS read-only
283       STATUS current
284       DESCRIPTION
285           "The count of packets received with this ANR label as their
286           first label.
287
288           A Management Station can detect discontinuities in this
289           counter by monitoring the hprAnrCounterDisconTime object in
290           the same row."
291
292       ::= { hprAnrRoutingEntry 5 }
293
294 hprAnrCounterDisconTime OBJECT-TYPE
295       SYNTAX TimeStamp
296       MAX-ACCESS read-only
297       STATUS current
298       DESCRIPTION
299           "The value of the sysUpTime object when the
300           hprAnrPacketsReceived counter for this ANR label last
301           experienced a discontinuity.  This will be the more recent of
302           two times:  the time at which the ANR label was associated with
303           either an outgoing TG or a local NCE, or the time at which the
304           ANR counters were last turned on or off."
305
306       ::= { hprAnrRoutingEntry 6 }
307
308 -- *********************************************************************
309 hprTransportUser     OBJECT IDENTIFIER ::= { hprObjects 3 }
310 -- *********************************************************************
311 -- Transport Service User (TU) Table: (RTP Connection Users)
312 --
313 -- There will be several users of the HPR transport and each HPR node
314 -- shall maintain a table of these users.
315 -- *********************************************************************
316
317 hprNceTable OBJECT-TYPE
318       SYNTAX SEQUENCE OF HprNceEntry
319       MAX-ACCESS not-accessible
320       STATUS current
321       DESCRIPTION
322           "The Network Connection Endpoint (NCE) table."
323
324       ::= { hprTransportUser 1 }
325
326 hprNceEntry OBJECT-TYPE
327       SYNTAX HprNceEntry
328       MAX-ACCESS not-accessible
329       STATUS current
330       DESCRIPTION
331           "The NCE ID is used to index this table."
332
333       INDEX  { hprNceId }
334
335       ::= { hprNceTable 1 }
336
337 HprNceEntry ::= SEQUENCE {
338      hprNceId            OCTET STRING,
339      hprNceType          HprNceTypes,
340      hprNceDefault       HprNceTypes,
341      hprNceInstanceId    OCTET STRING
342      }
343
344 hprNceId OBJECT-TYPE
345       SYNTAX OCTET STRING (SIZE (1..8))
346       MAX-ACCESS not-accessible
347       STATUS current
348       DESCRIPTION
349           "The Network Connection Endpoint (NCE) ID.  NCEs identify
350           Control Points (Cp), Logical Units (Lu), HPR Boundary
351           Functions (Bf) and Route Setup (Rs) Functions.  A value for
352           this object can be retrieved from any of the following
353           objects in the APPN MIB:
354
355                - appnLsCpCpNceId
356                - appnLsRouteNceId
357                - appnLsBfNceId
358                - appnIsInRtpNceId
359                - appnIsRtpNceId
360
361           In each case this value identifies a row in this table
362           containing information related to that in the APPN MIB."
363
364       ::= { hprNceEntry 1 }
365
366 hprNceType OBJECT-TYPE
367       SYNTAX HprNceTypes
368       MAX-ACCESS read-only
369       STATUS current
370       DESCRIPTION
371           "A bit string identifying the function types provided by this
372           Network Connection Endpoint (NCE)."
373
374       ::= { hprNceEntry 2 }
375
376 hprNceDefault OBJECT-TYPE
377       SYNTAX HprNceTypes
378       MAX-ACCESS read-only
379       STATUS current
380       DESCRIPTION
381           "A bit string identifying the function types for which this
382           Network Connection Endpoint (NCE) is the default NCE.  While
383           default NCEs are not explicitly defined in the architecture,
384           some implementations provide them; for such implementations,
385           it is useful to make this information available to a
386           Management Station."
387
388       ::= { hprNceEntry 3 }
389
390 hprNceInstanceId   OBJECT-TYPE
391       SYNTAX OCTET STRING (SIZE (4))
392       MAX-ACCESS read-only
393       STATUS current
394       DESCRIPTION
395           "The NCE instance identifier (NCEII) identifying the current
396           instance of this NCE.  An NCEII is used to denote different
397           instances (IPLs) of an NCE component.  Each time an NCE is
398           activated (IPL'd), it acquires a different, unique NCEII."
399
400       ::= { hprNceEntry 4 }
401
402 -- *********************************************************************
403 hprRtp               OBJECT IDENTIFIER ::= { hprObjects 4 }
404 -- *********************************************************************
405 -- *********************************************************************
406 --
407 -- The RTP group is implemented by all managed nodes supporting the
408 -- HPR Transport Tower.  The group contains several scalars (simple
409 -- objects) and a table.
410 -- *********************************************************************
411
412 -- *********************************************************************
413 hprRtpGlobe          OBJECT IDENTIFIER ::= { hprRtp 1}
414 -- *********************************************************************
415 hprRtpGlobeConnSetups  OBJECT-TYPE
416       SYNTAX Counter32
417       UNITS "RTP connection setups"
418       MAX-ACCESS read-only
419       STATUS current
420       DESCRIPTION
421           "The count of RTP connection setups in which this node has
422           participated, as either sender or receiver, since it was last
423           re-initialized.  Retries of a setup attempt do not cause the
424           counter to be incremented.
425
426           A Management Station can detect discontinuities in this
427           counter by monitoring the appnNodeCounterDisconTime object
428           in the APPN MIB."
429
430       ::= { hprRtpGlobe 1 }
431
432 hprRtpGlobeCtrState OBJECT-TYPE
433       SYNTAX INTEGER {
434                       notActive(1),
435                       active(2)
436                      }
437       MAX-ACCESS read-write
438       STATUS current
439       DESCRIPTION
440           "This object allows a network management station to turn the
441           counters in the hprRtpTable on and off.  The initial value of
442           this object is an implementation choice.
443
444                  notActive(1) - the counters in the hprRtpTable are
445                                 returning no meaningful values
446                  active(2)    - the counters in the hprRtpTable are
447                                 being incremented and are returning
448                                 meaningful values"
449
450       ::= { hprRtpGlobe 2 }
451
452 hprRtpGlobeCtrStateTime OBJECT-TYPE
453       SYNTAX DateAndTime
454       MAX-ACCESS read-only
455       STATUS current
456       DESCRIPTION
457           "The time when the value of the hprRtpGlobeCtrState object
458           last changed.  The initial value returned by this object is
459           the time at which the APPN node instrumented with this MIB
460           was last brought up."
461
462       ::= { hprRtpGlobe 3 }
463
464 -- *********************************************************************
465 -- The RTP Connection Table
466 -- There may be many RTP connections on a node supporting the functions
467 -- specified in the RTP option set.  Each node implementing this option
468 -- set shall maintain a table of these RTP connections.
469 -- *********************************************************************
470
471 hprRtpTable OBJECT-TYPE
472       SYNTAX SEQUENCE OF HprRtpEntry
473       MAX-ACCESS not-accessible
474       STATUS current
475       DESCRIPTION
476           "The RTP Connection table"
477
478       ::= { hprRtp 2 }
479
480 hprRtpEntry OBJECT-TYPE
481       SYNTAX HprRtpEntry
482       MAX-ACCESS not-accessible
483       STATUS current
484       DESCRIPTION
485           "The local NCE ID and local TCID are used to index this
486           table."
487
488       INDEX
489              { hprRtpLocNceId,
490                hprRtpLocTcid }
491
492       ::= { hprRtpTable 1 }
493
494 HprRtpEntry ::= SEQUENCE {
495      hprRtpLocNceId          OCTET STRING,       -- local nce id
496      hprRtpLocTcid           OCTET STRING,       -- local tcid
497      hprRtpRemCpName         SnaControlPointName,-- remote cp name
498      hprRtpRemNceId          OCTET STRING,       -- remote nce id
499      hprRtpRemTcid           OCTET STRING,       -- remote tcid
500      hprRtpPathSwitchTrigger INTEGER,            -- trigger (read-write)
501      hprRtpRscv              OCTET STRING,       -- rscv
502      hprRtpTopic             DisplayString,      -- topic (cos)
503      hprRtpState             INTEGER,            -- state
504      hprRtpUpTime            TimeTicks,          -- up time
505
506      hprRtpLivenessTimer     Unsigned32,         -- liveness timer
507      hprRtpShortReqTimer     Unsigned32,         -- short request timer
508      hprRtpPathSwTimer       Unsigned32,         -- path switch timer
509      hprRtpLivenessTimeouts  HprRtpCounter,      -- liveness timeouts
510      hprRtpShortReqTimeouts  HprRtpCounter,      -- short req timeouts
511
512      hprRtpMaxSendRate       Gauge32,            -- maximum send rate
513      hprRtpMinSendRate       Gauge32,            -- minimum send rate
514      hprRtpCurSendRate       Gauge32,            -- current send rate
515
516      hprRtpSmRdTripDelay     Gauge32,            -- smooth rnd trip
517                                                  -- delay
518
519      hprRtpSendPackets       HprRtpCounter,      -- packets sent
520      hprRtpRecvPackets       HprRtpCounter,      -- packets received
521      hprRtpSendBytes         HprRtpCounter,      -- bytes sent
522      hprRtpRecvBytes         HprRtpCounter,      -- bytes received
523
524      hprRtpRetrPackets       HprRtpCounter,      -- pkts re-xmitted
525      hprRtpPacketsDiscarded  HprRtpCounter,      -- pkts discarded
526      hprRtpDetectGaps        HprRtpCounter,      -- gaps detected
527      hprRtpRateReqSends      HprRtpCounter,      -- rate req send
528
529      hprRtpOkErrPathSws      HprRtpCounter,      -- ok  err path sws
530      hprRtpBadErrPathSws     HprRtpCounter,      -- bad err path sws
531      hprRtpOkOpPathSws       HprRtpCounter,      -- ok  op  path sws
532      hprRtpBadOpPathSws      HprRtpCounter,      -- bad op  path sws
533
534      hprRtpCounterDisconTime TimeStamp           -- discontinuity ind
535         }
536
537 hprRtpLocNceId OBJECT-TYPE
538       SYNTAX OCTET STRING (SIZE (1..8))
539       MAX-ACCESS not-accessible
540       STATUS current
541       DESCRIPTION
542           "The local Network Connection Endpoint (NCE) ID of this RTP
543           connection.  NCEs identify CPs, LUs, Boundary Functions (BFs),
544           and Route Setup (RS) components.  A value for this object can
545           be retrieved from any of the following objects in the APPN
546           MIB:
547
548                - appnLsCpCpNceId
549                - appnLsRouteNceId
550                - appnLsBfNceId
551                - appnIsInRtpNceId
552                - appnIsRtpNceId
553
554           In each case this value identifies a row in this table
555           containing information related to that in the APPN MIB."
556
557       ::= { hprRtpEntry 1 }
558
559 hprRtpLocTcid OBJECT-TYPE
560       SYNTAX OCTET STRING (SIZE (8))
561       MAX-ACCESS not-accessible
562       STATUS current
563       DESCRIPTION
564           "The local TCID of this RTP connection.  A value for this
565           object can be retrieved from either the appnIsInRtpTcid object
566           or the appnIsRtpTcid object the APPN MIB; in each case this
567           value identifies a row in this table containing information
568           related to that in the APPN MIB."
569
570       ::= { hprRtpEntry 2 }
571
572 hprRtpRemCpName OBJECT-TYPE
573       SYNTAX SnaControlPointName
574       MAX-ACCESS read-only
575       STATUS current
576       DESCRIPTION
577           "Administratively assigned network name for the remote node of
578           this RTP connection."
579
580       ::= { hprRtpEntry 3 }
581
582 hprRtpRemNceId OBJECT-TYPE
583       SYNTAX OCTET STRING (SIZE (1..8))
584       MAX-ACCESS read-only
585       STATUS current
586       DESCRIPTION
587           "The remote Network Connection Endpoint (NCE) of this RTP
588           connection.  NCEs identify CPs, LUs, Boundary Functions (BFs),
589           and Route Setup (RS) components."
590
591       ::= { hprRtpEntry 4 }
592
593 hprRtpRemTcid OBJECT-TYPE
594       SYNTAX OCTET STRING (SIZE (8))
595       MAX-ACCESS read-only
596       STATUS current
597       DESCRIPTION
598           "The remote TCID of this RTP connection."
599
600       ::= { hprRtpEntry 5 }
601
602 hprRtpPathSwitchTrigger OBJECT-TYPE
603       SYNTAX INTEGER {
604                       ready(1),
605                       switchPathNow(2)
606                      }
607       MAX-ACCESS read-write
608       STATUS current
609       DESCRIPTION
610           "Object by which a Management Station can trigger an operator-
611           requested path switch, by setting the value to
612           switchPathNow(2).  Setting this object to switchPathNow(2)
613           triggers a path switch even if its previous value was already
614           switchPathNow(2).
615           The value ready(1) is returned on GET operations until a SET
616           has been processed; after that the value received on the most
617           recent SET is returned.
618
619           This MIB module provides no support for an operator-requested
620           switch to a specified path."
621
622       ::= { hprRtpEntry 6 }
623
624 hprRtpRscv OBJECT-TYPE
625       SYNTAX OCTET STRING (SIZE (0..255))
626       MAX-ACCESS read-only
627       STATUS current
628       DESCRIPTION
629           "The forward Route Selection Control Vector for this RTP
630           connection.  The format of this vector is described in SNA
631           Formats.
632
633           The value returned in this object during a path switch is
634           implementation-dependent:  it may be the old path, the new
635           path, a zero-length string, or some other valid RSCV string."
636
637       ::= { hprRtpEntry 7 }
638
639 hprRtpTopic OBJECT-TYPE
640       SYNTAX DisplayString (SIZE(8))
641       MAX-ACCESS read-only
642       STATUS current
643       DESCRIPTION
644           "The topic for this RTP connection.  This is used to indicate
645           the Class of Service."
646
647       ::= { hprRtpEntry 8 }
648
649 hprRtpState OBJECT-TYPE
650       SYNTAX INTEGER {
651                       rtpListening(1),
652                       rtpCalling(2),
653                       rtpConnected(3),
654                       rtpPathSwitching(4),
655                       rtpDisconnecting(5),
656                       other(99)
657                      }
658       MAX-ACCESS read-only
659       STATUS current
660       DESCRIPTION
661           "The state of the RTP connection, from the perspective of the
662           local RTP protocol machine:
663               rtpListening      - connection open; waiting for other end
664                                   to call in
665               rtpCalling        - connection opened, attempting to call
666                                   out, have not yet received any data
667                                   from other end
668               rtpConnected      - connection is active; responded to a
669                                   call-in or received other end's TCID
670                                   from a call-out attempt
671               rtpPathSwitching  - the path switch timer is running;
672                                   attempting to find a new path for this
673                                   connection.
674               rtpDisconnecting  - no sessions are using this connection;
675                                   in process of bringing it down
676               other             - the connection is not in any of the
677                                   states listed above."
678
679       ::= { hprRtpEntry 9 }
680
681 hprRtpUpTime OBJECT-TYPE
682       SYNTAX TimeTicks
683       UNITS "1/100ths of a second"
684       MAX-ACCESS read-only
685       STATUS current
686       DESCRIPTION
687           "The length of time the RTP connection has been up, measured
688           in 1/100ths of a second."
689
690       ::= { hprRtpEntry 10 }
691
692 hprRtpLivenessTimer OBJECT-TYPE
693       SYNTAX Unsigned32
694       UNITS "1/100ths of a second"
695       MAX-ACCESS read-only
696       STATUS current
697       DESCRIPTION
698           "The value of the liveness (ALIVE) timer of this RTP
699           connection, in units of 1/100th of a second.  When this timer
700           expires and no packet has arrived from the partner since it
701           was last set, packets with Status Request indicators will be
702           sent to see if the RTP connection is still alive."
703
704       ::= { hprRtpEntry 11 }
705
706 hprRtpShortReqTimer  OBJECT-TYPE
707       SYNTAX Unsigned32
708       UNITS "1/100ths of a second"
709       MAX-ACCESS read-only
710       STATUS current
711       DESCRIPTION
712           "The value of the RTP SHORT_REQ timer, in units of 1/100 of a
713           second.  This timer represents the maximum time that a sender
714           waits for a reply from a receiver."
715
716       ::= { hprRtpEntry 12 }
717
718 hprRtpPathSwTimer OBJECT-TYPE
719       SYNTAX Unsigned32
720       UNITS "1/100ths of a second"
721       MAX-ACCESS read-only
722       STATUS current
723       DESCRIPTION
724           "The length of time that RTP should attempt a path switch
725           for a connection, in units of 1/100th of a second."
726
727       ::= { hprRtpEntry 13 }
728
729 hprRtpLivenessTimeouts OBJECT-TYPE
730       SYNTAX HprRtpCounter
731       UNITS "liveness timeouts"
732       MAX-ACCESS read-only
733       STATUS current
734       DESCRIPTION
735           "The count of liveness timeouts for this RTP connection."
736
737       ::= { hprRtpEntry 14 }
738
739 hprRtpShortReqTimeouts OBJECT-TYPE
740       SYNTAX HprRtpCounter
741       UNITS "short request timeouts"
742       MAX-ACCESS read-only
743       STATUS current
744       DESCRIPTION
745           "The count of short request timeouts for this RTP connection."
746
747       ::= { hprRtpEntry 15 }
748
749 hprRtpMaxSendRate OBJECT-TYPE
750       SYNTAX Gauge32
751       UNITS "bytes per second"
752       MAX-ACCESS read-only
753       STATUS current
754       DESCRIPTION
755           "The high-water mark for this RTP connection's send rate, in
756           units of bytes per second.  This is the high-water mark for
757           the entire life of the connection, not just the high-water
758           mark for the connection's current path.
759           For more details on this and other parameters related to HPR,
760           see the High Performance Routing Architecture Reference."
761
762       ::= { hprRtpEntry 16 }
763
764 hprRtpMinSendRate OBJECT-TYPE
765       SYNTAX Gauge32
766       UNITS "bytes per second"
767       MAX-ACCESS read-only
768       STATUS current
769       DESCRIPTION
770           "The low-water mark for this RTP connection's send rate, in
771           units of bytes per second.  This is the low-water mark for the
772           entire life of the connection, not just the low-water mark for
773           the connection's current path.
774
775           For more details on this and other parameters related to HPR,
776           see the High Performance Routing Architecture Reference."
777
778       ::= { hprRtpEntry 17 }
779
780 hprRtpCurSendRate OBJECT-TYPE
781       SYNTAX Gauge32
782       UNITS "bytes per second"
783       MAX-ACCESS read-only
784       STATUS current
785       DESCRIPTION
786           "The current send rate for this RTP connection, in units of
787           bytes per second.
788
789           For more details on this and other parameters related to HPR,
790           see the High Performance Routing Architecture Reference."
791
792       ::= { hprRtpEntry 18 }
793
794 hprRtpSmRdTripDelay OBJECT-TYPE
795       SYNTAX Gauge32
796       UNITS "1/1000ths of a second"
797       MAX-ACCESS read-only
798       STATUS current
799       DESCRIPTION
800           "The smoothed round trip delay for this RTP connection, in
801           units of 1/1000th of a second (ms).
802
803           For more details on this and other parameters related to HPR,
804           see the High Performance Routing Architecture Reference."
805
806       ::= { hprRtpEntry 19 }
807
808 hprRtpSendPackets OBJECT-TYPE
809       SYNTAX HprRtpCounter
810       UNITS "RTP packets"
811       MAX-ACCESS read-only
812       STATUS current
813       DESCRIPTION
814           "The count of packets successfully sent on this RTP
815           connection."
816
817       ::= { hprRtpEntry 20 }
818
819 hprRtpRecvPackets OBJECT-TYPE
820       SYNTAX HprRtpCounter
821       UNITS "RTP packets"
822       MAX-ACCESS read-only
823       STATUS current
824       DESCRIPTION
825           "The count of packets received on this RTP connection.  The
826           counter is incremented only once if duplicate copies of a
827           packet are received."
828
829       ::= { hprRtpEntry 21 }
830
831 hprRtpSendBytes OBJECT-TYPE
832       SYNTAX HprRtpCounter
833       UNITS "bytes"
834       MAX-ACCESS read-only
835       STATUS current
836       DESCRIPTION
837           "The count of bytes sent on this RTP connection.  Both RTP
838           Transport Header (THDR) bytes and data bytes are included in
839           this count."
840
841       ::= { hprRtpEntry 22 }
842
843 hprRtpRecvBytes OBJECT-TYPE
844       SYNTAX HprRtpCounter
845       UNITS "bytes"
846       MAX-ACCESS read-only
847       STATUS current
848       DESCRIPTION
849           "The count of bytes received on this RTP connection.  Both RTP
850           Transport Header (THDR) bytes and data bytes are included in
851           this count."
852
853       ::= { hprRtpEntry 23 }
854
855 hprRtpRetrPackets OBJECT-TYPE
856       SYNTAX HprRtpCounter
857       UNITS "RTP packets"
858       MAX-ACCESS read-only
859       STATUS current
860       DESCRIPTION
861           "The count of packets retransmitted on this RTP connection."
862
863       ::= { hprRtpEntry 24 }
864
865 hprRtpPacketsDiscarded OBJECT-TYPE
866       SYNTAX HprRtpCounter
867       UNITS "RTP packets"
868       MAX-ACCESS read-only
869       STATUS current
870       DESCRIPTION
871           "The count of packets received on this RTP connection and then
872           discarded.  A packet may be discarded because it is determined
873           to be a duplicate, or for other reasons."
874
875       ::= { hprRtpEntry 25 }
876
877 hprRtpDetectGaps OBJECT-TYPE
878       SYNTAX HprRtpCounter
879       UNITS "gaps"
880       MAX-ACCESS read-only
881       STATUS current
882       DESCRIPTION
883           "The count of gaps detected on this RTP connection."
884
885       ::= { hprRtpEntry 26 }
886
887 hprRtpRateReqSends OBJECT-TYPE
888       SYNTAX HprRtpCounter
889       UNITS "rate requests"
890       MAX-ACCESS read-only
891       STATUS current
892       DESCRIPTION
893           "The count of Rate Requests sent on this RTP connection."
894
895       ::= { hprRtpEntry 27 }
896
897 hprRtpOkErrPathSws OBJECT-TYPE
898       SYNTAX HprRtpCounter
899       UNITS "path switch attempts"
900       MAX-ACCESS read-only
901       STATUS current
902       DESCRIPTION
903           "The count of successful path switch attempts for this RTP
904           connection due to errors."
905
906       ::= { hprRtpEntry 28 }
907
908 hprRtpBadErrPathSws OBJECT-TYPE
909       SYNTAX HprRtpCounter
910       UNITS "path switch attempts"
911       MAX-ACCESS read-only
912       STATUS current
913       DESCRIPTION
914           "The count of unsuccessful path switches for this RTP
915           connection due to errors."
916
917       ::= { hprRtpEntry 29 }
918
919 hprRtpOkOpPathSws OBJECT-TYPE
920       SYNTAX HprRtpCounter
921       UNITS "path switches"
922       MAX-ACCESS read-only
923       STATUS current
924       DESCRIPTION
925           "The count of successful path switches for this RTP connection
926           due to operator requests."
927
928       ::= { hprRtpEntry 30 }
929
930 hprRtpBadOpPathSws OBJECT-TYPE
931       SYNTAX HprRtpCounter
932       UNITS "path switches"
933       MAX-ACCESS read-only
934       STATUS current
935       DESCRIPTION
936           "The count of unsuccessful path switches for this RTP
937           connection due to operator requests.  This counter is not
938           incremented by an implementation that does not support
939           operator-requested path switches, even if a Management Station
940           requests such a path switch by setting the
941           hprRtpPathSwitchTrigger object."
942
943       ::= { hprRtpEntry 31 }
944
945 hprRtpCounterDisconTime OBJECT-TYPE
946       SYNTAX TimeStamp
947       MAX-ACCESS read-only
948       STATUS current
949       DESCRIPTION
950           "The value of the sysUpTime object when the counters for this
951           RTP connection last experienced a discontinuity.  This will be
952           the more recent of two times:  the time at which the
953           connection was established or the time at which the HPR
954           counters were last turned on or off."
955
956       ::= { hprRtpEntry 32 }
957
958 -- *********************************************************************
959 -- The RTP Connection Status Table
960 --  This table contains statistics and historical information related to
961 --  both successful and unsuccessful RTP path switches.  This
962 --  information can be important for both trend analysis and problem
963 --  determination.
964 --
965 --  Note the terminology here:  when RTP is triggered to find a new path
966 --  for a connection, this initiates a 'path switch,' which will end up
967 --  being either successful or unsuccessful.  During this path switch,
968 --  RTP will make one or more 'path switch attempts,' which are attempts
969 --  to find a new path for the connection and switch the connection to
970 --  it.  This 'new' path may be the same path that the connection was
971 --  using before the path switch.
972 --
973 --  It is an implementation option how many entries to keep in this
974 --  table, and how long to retain any individual entry.
975 -- *********************************************************************
976 hprRtpStatusTable OBJECT-TYPE
977       SYNTAX SEQUENCE OF HprRtpStatusEntry
978       MAX-ACCESS not-accessible
979       STATUS current
980       DESCRIPTION
981           "RTP Connection Status Table:  This table contains historical
982           information on RTP connections.  An entry is created in this
983           table when a path switch is completed, either successfully or
984           unsuccessfully."
985
986       ::= { hprRtp 3 }
987
988 hprRtpStatusEntry OBJECT-TYPE
989       SYNTAX HprRtpStatusEntry
990       MAX-ACCESS not-accessible
991       STATUS current
992       DESCRIPTION
993           "This table is indexed by local NCE ID, local TCID, and an
994           integer hprRtpStatusIndex.  Thus the primary grouping of table
995           rows is by RTP connection, with the multiple entries for a
996           given RTP connection ordered by time."
997
998       INDEX
999              { hprRtpStatusLocNceId,
1000                hprRtpStatusLocTcid,
1001                hprRtpStatusIndex }
1002
1003       ::= { hprRtpStatusTable 1 }
1004
1005   HprRtpStatusEntry ::= SEQUENCE {
1006      hprRtpStatusLocNceId          OCTET STRING, -- local nce id
1007      hprRtpStatusLocTcid           OCTET STRING, -- local tcid
1008      hprRtpStatusIndex             Unsigned32,   -- index
1009      hprRtpStatusStartTime         DateAndTime,  -- time stamp
1010      hprRtpStatusEndTime           DateAndTime,  -- time stamp
1011      hprRtpStatusRemCpName         SnaControlPointName,-- remote cp name
1012      hprRtpStatusRemNceId          OCTET STRING, -- remote nce id
1013      hprRtpStatusRemTcid           OCTET STRING, -- remote tcid
1014      hprRtpStatusNewRscv           OCTET STRING, -- new rscv
1015      hprRtpStatusOldRscv           OCTET STRING, -- old rscv
1016      hprRtpStatusCause             INTEGER,      -- cause
1017      hprRtpStatusLastAttemptResult INTEGER       -- result of last
1018                                           }
1019
1020 hprRtpStatusLocNceId OBJECT-TYPE
1021       SYNTAX OCTET STRING (SIZE (1..8))
1022       MAX-ACCESS not-accessible
1023       STATUS current
1024       DESCRIPTION
1025           "The local Network Connection Endpoint (NCE) of this RTP
1026           connection.  NCEs identify CPs, LUs, Boundary Functions (BFs),
1027           and Route Setup (RS) components."
1028
1029       ::= { hprRtpStatusEntry 1 }
1030
1031 hprRtpStatusLocTcid OBJECT-TYPE
1032       SYNTAX OCTET STRING (SIZE (8))
1033       MAX-ACCESS not-accessible
1034       STATUS current
1035       DESCRIPTION
1036           "The local TCID of this RTP connection."
1037
1038       ::= { hprRtpStatusEntry 2 }
1039
1040 hprRtpStatusIndex OBJECT-TYPE
1041       SYNTAX Unsigned32 (1..4294967295)
1042       MAX-ACCESS not-accessible
1043       STATUS current
1044       DESCRIPTION
1045           "Table index.  This value begins at one and is incremented
1046           when a new entry is added to the table.  It is an
1047           implementation choice whether to run a single counter for
1048           all entries in the table, or to run a separate counter for
1049           the entries for each RTP connection.  In the unlikely event
1050           of a wrap, it is assumed that Management Stations will have
1051           the ability to order table entries correctly."
1052
1053       ::= { hprRtpStatusEntry 3 }
1054
1055 hprRtpStatusStartTime OBJECT-TYPE
1056       SYNTAX DateAndTime
1057       MAX-ACCESS read-only
1058       STATUS current
1059       DESCRIPTION
1060           "The time when the path switch began."
1061
1062       ::= { hprRtpStatusEntry 4 }
1063
1064 hprRtpStatusEndTime OBJECT-TYPE
1065       SYNTAX DateAndTime
1066       MAX-ACCESS read-only
1067       STATUS current
1068       DESCRIPTION
1069           "The time when the path switch was ended, either successfully
1070           or unsuccessfully."
1071
1072       ::= { hprRtpStatusEntry 5 }
1073
1074 hprRtpStatusRemCpName OBJECT-TYPE
1075       SYNTAX SnaControlPointName
1076       MAX-ACCESS read-only
1077       STATUS current
1078       DESCRIPTION
1079           "Administratively assigned network name for the remote node of
1080           this RTP connection."
1081
1082       ::= { hprRtpStatusEntry 6 }
1083
1084 hprRtpStatusRemNceId OBJECT-TYPE
1085       SYNTAX OCTET STRING (SIZE (1..8))
1086       MAX-ACCESS read-only
1087       STATUS current
1088       DESCRIPTION
1089           "The remote Network Connection Endpoint (NCE) of this RTP
1090           connection.  NCEs identify CPs, LUs, Boundary Functions (BFs),
1091           and Route Setup (RS) components."
1092
1093       ::= { hprRtpStatusEntry 7 }
1094
1095 hprRtpStatusRemTcid OBJECT-TYPE
1096       SYNTAX OCTET STRING (SIZE (8))
1097       MAX-ACCESS read-only
1098       STATUS current
1099       DESCRIPTION
1100           "The remote TCID of this RTP connection."
1101
1102       ::= { hprRtpStatusEntry 8 }
1103
1104 hprRtpStatusNewRscv OBJECT-TYPE
1105       SYNTAX OCTET STRING (SIZE (0..255))
1106       MAX-ACCESS read-only
1107       STATUS current
1108       DESCRIPTION
1109           "The new Route Selection Control Vector for this RTP
1110           connection.  A zero-length string indicates that no value is
1111           available, perhaps because the implementation does not save
1112           RSCVs."
1113
1114       ::= { hprRtpStatusEntry 9 }
1115
1116 hprRtpStatusOldRscv OBJECT-TYPE
1117       SYNTAX OCTET STRING (SIZE (0..255))
1118       MAX-ACCESS read-only
1119       STATUS current
1120       DESCRIPTION
1121           "The old Route Selection Control Vector for this RTP
1122           connection.  A zero-length string indicates that no value is
1123           available, perhaps because the implementation does not save
1124           RSCVs."
1125
1126       ::= { hprRtpStatusEntry 10 }
1127
1128 hprRtpStatusCause OBJECT-TYPE
1129       SYNTAX INTEGER {
1130                       other(1),
1131                       rtpConnFail(2),
1132                       locLinkFail(3),
1133                       remLinkFail(4),
1134                       operRequest(5)
1135                      }
1136       MAX-ACCESS read-only
1137       STATUS current
1138       DESCRIPTION
1139           "The reason for the path switch:
1140
1141                other(1)       - Reason other than those listed below,
1142                rtpConnFail(2) - RTP connection failure detected,
1143                locLinkFail(3) - Local link failure,
1144                remLinkFail(4) - Remote link failure (learned from TDUs),
1145                operRequest(5) - Operator requested path switch. "
1146
1147       ::= { hprRtpStatusEntry 11 }
1148
1149 hprRtpStatusLastAttemptResult  OBJECT-TYPE
1150       SYNTAX INTEGER { successful(1),
1151                        initiatorMoving(2),
1152                        directorySearchFailed(3),
1153                        rscvCalculationFailed(4),
1154                        negativeRouteSetupReply(5),
1155                        backoutRouteSetupReply(6),
1156                        timeoutDuringFirstAttempt(7),
1157                        otherUnsuccessful(8)
1158                      }
1159       MAX-ACCESS read-only
1160       STATUS current
1161       DESCRIPTION
1162           "The result of the last completed path switch attempt.  If the
1163           path switch is aborted in the middle of a path switch attempt
1164           because the path switch timer expires, the result of the
1165           previous path switch attempt is reported.
1166
1167           The values are defined as follows:
1168
1169              successful(1)                - The final path switch
1170                                             attempt was successful.
1171              initiatorMoving(2)           - The final path switch
1172                                             attempt failed because the
1173                                             initiator is mobile, and
1174                                             there was no active link
1175                                             out of this node.
1176              directorySearchFailed(3)     - The final path switch
1177                                             attempt failed because a
1178                                             directory search for the
1179                                             destination node's CP name
1180                                             failed.
1181              rscvCalculationFailed(4)     - The final path switch
1182                                             attempt failed because an
1183                                             RSCV to the node containing
1184                                             the remote RTP endpoint
1185                                             could not be calculated.
1186              negativeRouteSetupReply(5)   - The final path switch
1187                                             attempt failed because route
1188                                             setup failed for the new
1189                                             path.
1190              backoutRouteSetupReply(6)    - The final path switch
1191                                             attempt failed because the
1192                                             remote RTP endpoint refused
1193                                             to continue the RTP
1194                                             connection.
1195              timeoutDuringFirstAttempt(7) - The path switch timer
1196                                             expired during the first
1197                                             path switch attempt.
1198              otherUnsuccessful(8)         - The final path switch
1199                                             attempt failed for a reason
1200                                             other than those listed
1201                                             above."
1202
1203
1204       ::= { hprRtpStatusEntry 12 }
1205
1206
1207 -- ***************************************************************
1208 -- Conformance information
1209 -- ***************************************************************
1210
1211 hprConformance       OBJECT IDENTIFIER ::= { hprMIB 2 }
1212
1213 hprCompliances       OBJECT IDENTIFIER ::= { hprConformance 1 }
1214 hprGroups            OBJECT IDENTIFIER ::= { hprConformance 2 }
1215
1216 -- Compliance statements
1217
1218 hprCompliance  MODULE-COMPLIANCE
1219       STATUS  current
1220       DESCRIPTION
1221           "The compliance statement for the SNMPv2 entities that
1222           implement the HPR MIB."
1223
1224       MODULE  -- this module
1225
1226 --    Unconditionally mandatory groups
1227           MANDATORY-GROUPS  {
1228                              hprGlobalConfGroup,
1229                              hprAnrRoutingConfGroup,
1230                              hprTransportUserConfGroup
1231                             }
1232
1233 --    Conditionally mandatory groups
1234           GROUP   hprRtpConfGroup
1235           DESCRIPTION
1236               "The hprRtpConfGroup is mandatory for HPR implementations
1237               supporting the HPR transport tower."
1238
1239       ::= { hprCompliances 1 }
1240
1241 -- Units of conformance
1242 hprGlobalConfGroup OBJECT-GROUP
1243         OBJECTS {
1244                  hprNodeCpName,
1245                  hprOperatorPathSwitchSupport
1246                 }
1247       STATUS  current
1248       DESCRIPTION
1249           "A collection of objects providing the instrumentation of HPR
1250           general information and capabilities."
1251
1252       ::= { hprGroups 1 }
1253
1254 hprAnrRoutingConfGroup OBJECT-GROUP
1255         OBJECTS {
1256                  hprAnrsAssigned,
1257                  hprAnrCounterState,
1258                  hprAnrCounterStateTime,
1259                  hprAnrType,
1260                  hprAnrOutTgDest,
1261                  hprAnrOutTgNum,
1262                  hprAnrPacketsReceived,
1263                  hprAnrCounterDisconTime
1264                 }
1265       STATUS  current
1266       DESCRIPTION
1267           "A collection of objects providing instrumentation for the
1268           node's ANR routing."
1269
1270       ::= { hprGroups 2 }
1271
1272 hprTransportUserConfGroup OBJECT-GROUP
1273         OBJECTS {
1274                  hprNceType,
1275                  hprNceDefault,
1276                  hprNceInstanceId
1277                 }
1278       STATUS  current
1279       DESCRIPTION
1280           "A collection of objects providing information on the users of
1281           the HPR transport known to the node."
1282
1283       ::= { hprGroups 3 }
1284
1285 hprRtpConfGroup  OBJECT-GROUP
1286         OBJECTS {
1287                  hprRtpGlobeConnSetups,
1288                  hprRtpGlobeCtrState,
1289                  hprRtpGlobeCtrStateTime,
1290                  hprRtpRemCpName,
1291                  hprRtpRemNceId,
1292                  hprRtpRemTcid,
1293                  hprRtpPathSwitchTrigger,
1294                  hprRtpRscv,
1295                  hprRtpTopic,
1296                  hprRtpState,
1297                  hprRtpUpTime,
1298                  hprRtpLivenessTimer,
1299                  hprRtpShortReqTimer,
1300                  hprRtpPathSwTimer,
1301                  hprRtpLivenessTimeouts,
1302                  hprRtpShortReqTimeouts,
1303
1304                  hprRtpMaxSendRate,
1305                  hprRtpMinSendRate,
1306                  hprRtpCurSendRate,
1307
1308                  hprRtpSmRdTripDelay,
1309
1310                  hprRtpSendPackets,
1311                  hprRtpRecvPackets,
1312                  hprRtpSendBytes,
1313                  hprRtpRecvBytes,
1314
1315                  hprRtpRetrPackets,
1316                  hprRtpPacketsDiscarded,
1317                  hprRtpDetectGaps,
1318                  hprRtpRateReqSends,
1319
1320                  hprRtpOkErrPathSws,
1321                  hprRtpBadErrPathSws,
1322                  hprRtpOkOpPathSws,
1323                  hprRtpBadOpPathSws,
1324                  hprRtpCounterDisconTime,
1325
1326                  hprRtpStatusStartTime,
1327                  hprRtpStatusEndTime,
1328                  hprRtpStatusRemNceId,
1329                  hprRtpStatusRemTcid,
1330                  hprRtpStatusRemCpName,
1331                  hprRtpStatusNewRscv,
1332                  hprRtpStatusOldRscv,
1333                  hprRtpStatusCause,
1334                  hprRtpStatusLastAttemptResult
1335
1336                 }
1337       STATUS  current
1338       DESCRIPTION
1339           "A collection of objects providing the instrumentation for RTP
1340           connection end points."
1341
1342       ::= { hprGroups 4 }
1343
1344 -- end of conformance statement
1345
1346 END