Imported Upstream version 0.4.8
[platform/upstream/libsmi.git] / mibs / ietf / ROHC-RTP-MIB
1 ROHC-RTP-MIB DEFINITIONS ::= BEGIN
2
3 IMPORTS
4     MODULE-IDENTITY, OBJECT-TYPE,
5     Unsigned32, Counter32, mib-2
6         FROM SNMPv2-SMI                               -- [RFC2578]
7
8
9     TruthValue
10         FROM SNMPv2-TC                                -- [RFC2579]
11
12     MODULE-COMPLIANCE, OBJECT-GROUP
13         FROM SNMPv2-CONF                              -- [RFC2580]
14
15     rohcChannelID, rohcContextCID
16         FROM ROHC-MIB;                                -- [RFC3816]
17
18 rohcRtpMIB MODULE-IDENTITY
19     LAST-UPDATED "200406030000Z"  -- June 3, 2004
20     ORGANIZATION "IETF Robust Header Compression Working Group"
21     CONTACT-INFO
22        "WG charter:
23           http://www.ietf.org/html.charters/rohc-charter.html
24
25         Mailing Lists:
26           General Discussion: rohc@ietf.org
27           To Subscribe: rohc-request@ietf.org
28           In Body: subscribe your_email_address
29
30         Editor:
31           Juergen Quittek
32           NEC Europe Ltd.
33           Network Laboratories
34           Kurfuersten-Anlage 36
35           69221 Heidelberg
36           Germany
37           Tel: +49 6221 90511-15
38           EMail: quittek@netlab.nec.de"
39     DESCRIPTION
40         "This MIB module defines a set of objects for monitoring
41          and configuring RObust Header Compression (ROHC).
42          The objects are specific to ROHC RTP (profile 0x0001),
43          ROHC UDP (profile 0x0002), and ROHC ESP (profile 0x0003)
44          defined in RFC 3095 and for the ROHC LLA profile (profile
45          0x0005) defined in RFC 3242.
46
47          Copyright (C) The Internet Society (2004). The
48          initial version of this MIB module was published
49          in RFC 3816. For full legal notices see the RFC
50          itself or see:
51          http://www.ietf.org/copyrights/ianamib.html"
52
53     REVISION    "200406030000Z"  -- June 3, 2004
54     DESCRIPTION "Initial version, published as RFC 3816."
55     ::= { mib-2 114 }
56
57
58
59 --
60 -- The groups defined within this MIB module:
61 --
62
63 rohcRtpObjects       OBJECT IDENTIFIER ::= { rohcRtpMIB 1 }
64 rohcRtpConformance   OBJECT IDENTIFIER ::= { rohcRtpMIB 2 }
65
66 --
67 -- Context Table
68 --
69 -- The rohcRtpContextTable lists all contexts per interface
70 -- and instance.  It extends the rohcContextTable.
71 --
72
73 rohcRtpContextTable OBJECT-TYPE
74     SYNTAX      SEQUENCE OF RohcRtpContextEntry
75     MAX-ACCESS  not-accessible
76     STATUS      current
77     DESCRIPTION
78         "This table lists and describes RTP profile specific
79          properties of compressor contexts and decompressor
80          contexts.  It extends the rohcContextTable of the
81          ROHC-MIB module."
82     ::= { rohcRtpObjects 1 }
83
84 rohcRtpContextEntry OBJECT-TYPE
85     SYNTAX      RohcRtpContextEntry
86     MAX-ACCESS  not-accessible
87     STATUS      current
88     DESCRIPTION
89         "An entry describing a particular context."
90     INDEX {
91         rohcChannelID,
92         rohcContextCID
93     }
94     ::= { rohcRtpContextTable 1 }
95
96 RohcRtpContextEntry ::= SEQUENCE {
97     rohcRtpContextState             INTEGER,
98     rohcRtpContextMode              INTEGER,
99     rohcRtpContextAlwaysPad         TruthValue,
100     rohcRtpContextLargePktsAllowed  TruthValue,
101     rohcRtpContextVerifyPeriod      Unsigned32,
102     rohcRtpContextSizesAllowed      Unsigned32,
103     rohcRtpContextSizesUsed         Unsigned32,
104     rohcRtpContextACKs              Counter32,
105     rohcRtpContextNACKs             Counter32,
106     rohcRtpContextSNACKs            Counter32,
107
108
109     rohcRtpContextNHPs              Counter32,
110     rohcRtpContextCSPs              Counter32,
111     rohcRtpContextCCPs              Counter32,
112     rohcRtpContextPktsLostPhysical  Counter32,
113     rohcRtpContextPktsLostPreLink   Counter32
114 }
115
116 rohcRtpContextState OBJECT-TYPE
117     SYNTAX      INTEGER {
118                     initAndRefresh(1),
119                     firstOrder(2),
120                     secondOrder(3),
121                     noContext(4),
122                     staticContext(5),
123                     fullContext(6)
124                 }
125     MAX-ACCESS  read-only
126     STATUS      current
127     DESCRIPTION
128         "State of the context as defined in RFC 3095.  States
129          initAndRefresh(1), firstOrder(2), and secondOrder(3)
130          are states of compressor contexts, states noContext(4),
131          staticContext(5) and fullContext(6) are states of
132          decompressor contexts."
133     REFERENCE
134         "RFC 3095"
135     ::= { rohcRtpContextEntry 3 }
136
137 rohcRtpContextMode OBJECT-TYPE
138     SYNTAX      INTEGER {
139                     unidirectional(1),
140                     optimistic(2),
141                     reliable(3)
142                 }
143     MAX-ACCESS  read-only
144     STATUS      current
145     DESCRIPTION
146         "Mode of the context."
147     REFERENCE
148         "RFC 3095, Section 4.4"
149     ::= { rohcRtpContextEntry 4 }
150
151 rohcRtpContextAlwaysPad OBJECT-TYPE
152     SYNTAX      TruthValue
153     MAX-ACCESS  read-only
154     STATUS      current
155     DESCRIPTION
156         "Boolean, only applicable to compressor contexts using the
157
158
159          LLA profile.  If its value is true, the compressor must
160          pad every RHP packet with a minimum of one octet ROHC
161          padding.
162
163          The value of this object is only valid for LLA profiles,
164          i.e., if the corresponding rohcProfile has a value of
165          0x0005.  If the corresponding rohcProfile has a value
166          other than 0x0005, then this object MUST NOT be
167          instantiated."
168     REFERENCE
169         "RFC 3242, Section 5.1.1"
170     DEFVAL { false }
171     ::= { rohcRtpContextEntry 5 }
172
173 rohcRtpContextLargePktsAllowed OBJECT-TYPE
174     SYNTAX      TruthValue
175     MAX-ACCESS  read-only
176     STATUS      current
177     DESCRIPTION
178         "Boolean, only applicable to compressor contexts using the
179          LLA profile.  It specifies how to handle packets that do
180          not fit any of the preferred packet sizes specified.  If
181          its value is true, the compressor must deliver the larger
182          packet as-is and must not use segmentation.  If it is set
183          to false, the ROHC segmentation scheme must be used to
184          split the packet into two or more segments, and each
185          segment must further be padded to fit one of the preferred
186          packet sizes.
187
188          The value of this object is only valid for LLA profiles,
189          i.e., if the corresponding rohcProfile has a value of
190          0x0005.  If the corresponding rohcProfile has a value
191          other than 0x0005, then this object MUST NOT be
192          instantiated."
193     REFERENCE
194         "RFC 3242, Section 5.1.1"
195     DEFVAL { true }
196     ::= { rohcRtpContextEntry 6 }
197
198 rohcRtpContextVerifyPeriod OBJECT-TYPE
199     SYNTAX      Unsigned32
200     MAX-ACCESS  read-only
201     STATUS      current
202     DESCRIPTION
203         "This object is only applicable to compressor contexts
204          using the LLA profile.  It specifies the minimum frequency
205          with which a packet validating the context must be sent.
206          This tells the compressor that a packet containing a CRC
207
208
209          field must be sent at least once every N packets, where N
210          is the value of the object.  A value of 0 indicates that
211          periodical verifications are disabled.
212
213          The value of this object is only valid for LLA profiles,
214          i.e., if the corresponding rohcProfile has a value of
215          0x0005.  If the corresponding rohcProfile has a value
216          other than 0x0005, then this object MUST NOT be
217          instantiated."
218     REFERENCE
219         "RFC 3242, Section 5.1.1"
220     DEFVAL { 0 }
221     ::= { rohcRtpContextEntry 7 }
222
223 rohcRtpContextSizesAllowed  OBJECT-TYPE
224     SYNTAX      Unsigned32 (1..4294967295)
225     MAX-ACCESS  read-only
226     STATUS      current
227     DESCRIPTION
228         "The value of this object is only valid for decompressor
229          contexts, i.e., if rohcInstanceType of the corresponding
230          rohcContextEntry has the value decompressor(2).  For
231          compressor contexts where rohcInstanceType has the value
232          compressor(1), this object MUST NOT be instantiated.
233
234          This object contains the number of different packet sizes
235          that may be used in the context."
236     REFERENCE
237         "RFC 3095, Section 6.3.1"
238     ::= { rohcRtpContextEntry 8 }
239
240 rohcRtpContextSizesUsed  OBJECT-TYPE
241     SYNTAX      Unsigned32 (1..4294967295)
242     MAX-ACCESS  read-only
243     STATUS      current
244     DESCRIPTION
245         "The value of this object is only valid for decompressor
246          contexts, i.e., if rohcInstanceType of the corresponding
247          rohcContextEntry has the value decompressor(2).  For
248          compressor contexts where rohcInstanceType has the value
249          compressor(1), this object MUST NOT be instantiated.
250
251          This object contains the number of different packet sizes
252          that are used in the context."
253     REFERENCE
254         "RFC 3095, Section 6.3.1"
255     ::= { rohcRtpContextEntry 9 }
256
257
258
259 rohcRtpContextACKs OBJECT-TYPE
260     SYNTAX      Counter32
261     MAX-ACCESS  read-only
262     STATUS      current
263     DESCRIPTION
264         "The number of all positive feedbacks (ACK) sent or
265          received in this context, respectively.
266
267          Discontinuities in the value of this counter can
268          occur at re-initialization of the management
269          system, and at other times as indicated by the
270          value of ifCounterDiscontinuityTime.  For checking
271          ifCounterDiscontinuityTime, the interface index is
272          required.  It can be determined by reading the
273          rohcChannelTable of the ROHC-MIB."
274     REFERENCE
275         "RFC 3095, Section 5.2.1."
276     ::= { rohcRtpContextEntry 10 }
277
278 rohcRtpContextNACKs OBJECT-TYPE
279     SYNTAX      Counter32
280     MAX-ACCESS  read-only
281     STATUS      current
282     DESCRIPTION
283         "The number of all dynamic negative feedbacks (ACK) sent
284          or received in this context, respectively.
285
286          Discontinuities in the value of this counter can
287          occur at re-initialization of the management
288          system, and at other times as indicated by the
289          value of ifCounterDiscontinuityTime.  For checking
290          ifCounterDiscontinuityTime, the interface index is
291          required.  It can be determined by reading the
292          rohcChannelTable of the ROHC-MIB."
293     REFERENCE
294         "RFC 3095, Section 5.2.1."
295     ::= { rohcRtpContextEntry 11 }
296
297 rohcRtpContextSNACKs OBJECT-TYPE
298     SYNTAX      Counter32
299     MAX-ACCESS  read-only
300     STATUS      current
301     DESCRIPTION
302         "The number of all static negative feedbacks (ACK) sent
303          or received in this context, respectively.
304
305          Discontinuities in the value of this counter can
306          occur at re-initialization of the management
307
308
309
310          system, and at other times as indicated by the
311          value of ifCounterDiscontinuityTime.  For checking
312          ifCounterDiscontinuityTime, the interface index is
313          required.  It can be determined by reading the
314          rohcChannelTable of the ROHC-MIB."
315     REFERENCE
316         "RFC 3095, Section 5.2.1."
317     ::= { rohcRtpContextEntry 12 }
318
319 rohcRtpContextNHPs OBJECT-TYPE
320     SYNTAX      Counter32
321     MAX-ACCESS  read-only
322     STATUS      current
323     DESCRIPTION
324         "This object is only applicable to contexts using the
325          LLA profile.  It contains the number of all no-header
326          packets (NHP) sent or received in this context,
327          respectively.
328
329          Discontinuities in the value of this counter can
330          occur at re-initialization of the management
331          system, and at other times as indicated by the
332          value of ifCounterDiscontinuityTime.  For checking
333          ifCounterDiscontinuityTime, the interface index is
334          required.  It can be determined by reading the
335          rohcChannelTable of the ROHC-MIB.
336
337          The value of this object is only valid for LLA profiles,
338          i.e., if the corresponding rohcProfile has a value of
339          0x0005.  If the corresponding rohcProfile has a value
340          other than 0x0005, then this object MUST NOT be
341          instantiated."
342     REFERENCE
343         "RFC 3242, Section 4.1.1."
344     ::= { rohcRtpContextEntry 13 }
345
346 rohcRtpContextCSPs OBJECT-TYPE
347     SYNTAX      Counter32
348     MAX-ACCESS  read-only
349     STATUS      current
350     DESCRIPTION
351         "This object is only applicable to contexts using the
352          LLA profile.  It contains the number of all context
353          synchronization packets (CSP) sent or received in this
354          context, respectively.
355
356          Discontinuities in the value of this counter can
357          occur at re-initialization of the management
358
359
360          system, and at other times as indicated by the
361          value of ifCounterDiscontinuityTime.  For checking
362          ifCounterDiscontinuityTime, the interface index is
363          required.  It can be determined by reading the
364          rohcChannelTable of the ROHC-MIB.
365
366          The value of this object is only valid for LLA profiles,
367          i.e., if the corresponding rohcProfile has a value of
368          0x0005.  If the corresponding rohcProfile has a value
369          other than 0x0005, then this object MUST NOT be
370          instantiated."
371     REFERENCE
372         "RFC 3242, Section 4.1.2."
373     ::= { rohcRtpContextEntry 14 }
374
375 rohcRtpContextCCPs OBJECT-TYPE
376     SYNTAX      Counter32
377     MAX-ACCESS  read-only
378     STATUS      current
379     DESCRIPTION
380         "This object is only applicable to contexts using the
381          LLA profile.  It contains the number of all context check
382          packets (CCP) sent or received in this context,
383          respectively.
384
385          Discontinuities in the value of this counter can
386          occur at re-initialization of the management
387          system, and at other times as indicated by the
388          value of ifCounterDiscontinuityTime.  For checking
389          ifCounterDiscontinuityTime, the interface index is
390          required.  It can be determined by reading the
391          rohcChannelTable of the ROHC-MIB.
392
393          The value of this object is only valid for LLA profiles,
394          i.e., if the corresponding rohcProfile has a value of
395          0x0005.  If the corresponding rohcProfile has a value
396          other than 0x0005, then this object MUST NOT be
397          instantiated."
398     REFERENCE
399         "RFC 3242, Section 4.1.3."
400     ::= { rohcRtpContextEntry 15 }
401
402 rohcRtpContextPktsLostPhysical OBJECT-TYPE
403     SYNTAX      Counter32
404     MAX-ACCESS  read-only
405     STATUS      current
406     DESCRIPTION
407         "This object is only applicable to decompressor contexts
408
409
410          using the LLA profile.  It contains the number of physical
411          packet losses on the link between compressor and
412          decompressor, that have been indicated to the decompressor.
413
414          Discontinuities in the value of this counter can
415          occur at re-initialization of the management
416          system, and at other times as indicated by the
417          value of ifCounterDiscontinuityTime.  For checking
418          ifCounterDiscontinuityTime, the interface index is
419          required.  It can be determined by reading the
420          rohcChannelTable of the ROHC-MIB.
421
422          The value of this object is only valid for LLA profiles,
423          i.e., if the corresponding rohcProfile has a value of
424          0x0005.  If the corresponding rohcProfile has a value
425          other than 0x0005, then this object MUST NOT be
426          instantiated."
427     REFERENCE
428         "RFC 3242, Section 5.1.2."
429     ::= { rohcRtpContextEntry 16 }
430
431 rohcRtpContextPktsLostPreLink OBJECT-TYPE
432     SYNTAX      Counter32
433     MAX-ACCESS  read-only
434     STATUS      current
435     DESCRIPTION
436         "This object is only applicable to decompressor contexts
437          using the LLA profile.  It contains the number of pre-link
438          packet losses on the link between compressor and
439          decompressor, that have been indicated to the decompressor.
440
441          Discontinuities in the value of this counter can
442          occur at re-initialization of the management
443          system, and at other times as indicated by the
444          value of ifCounterDiscontinuityTime.  For checking
445          ifCounterDiscontinuityTime, the interface index is
446          required.  It can be determined by reading the
447          rohcChannelTable of the ROHC-MIB.
448
449          The value of this object is only valid for LLA profiles,
450          i.e., if the corresponding rohcProfile has a value of
451          0x0005.  If the corresponding rohcProfile has a value
452          other than 0x0005, then this object MUST NOT be
453          instantiated."
454     REFERENCE
455         "RFC 3242, Section 5.1.2."
456     ::= { rohcRtpContextEntry 17 }
457
458
459
460 --
461 -- Packet Sizes Table
462 --
463 -- The rohcPacketSizeTable lists allowed, preferred, and used
464 -- packet sizes per compressor context.
465
466 rohcRtpPacketSizeTable OBJECT-TYPE
467     SYNTAX      SEQUENCE OF RohcRtpPacketSizeEntry
468     MAX-ACCESS  not-accessible
469     STATUS      current
470     DESCRIPTION
471         "This table lists all allowed, preferred, and used packet
472          sizes per compressor context and channel.
473
474          Note, that the sizes table represents implementation
475          parameters that are suggested by RFC 3095 and/or RFC 3242,
476          but that are not mandatory."
477     ::= { rohcRtpObjects 2 }
478
479 rohcRtpPacketSizeEntry OBJECT-TYPE
480     SYNTAX      RohcRtpPacketSizeEntry
481     MAX-ACCESS  not-accessible
482     STATUS      current
483     DESCRIPTION
484         "An entry of a particular packet size."
485     INDEX {
486         rohcChannelID,
487         rohcContextCID,
488         rohcRtpPacketSize
489     }
490     ::= { rohcRtpPacketSizeTable 1 }
491
492 RohcRtpPacketSizeEntry ::= SEQUENCE {
493     rohcRtpPacketSize                Unsigned32,
494     rohcRtpPacketSizePreferred       TruthValue,
495     rohcRtpPacketSizeUsed            TruthValue,
496     rohcRtpPacketSizeRestrictedType  INTEGER
497 }
498
499 rohcRtpPacketSize OBJECT-TYPE
500     SYNTAX      Unsigned32 (1..4294967295)
501     MAX-ACCESS  not-accessible
502     STATUS      current
503     DESCRIPTION
504         "A packet size used as index."
505     ::= { rohcRtpPacketSizeEntry 3 }
506
507 rohcRtpPacketSizePreferred OBJECT-TYPE
508
509
510     SYNTAX      TruthValue
511     MAX-ACCESS  read-only
512     STATUS      current
513     DESCRIPTION
514         "This object is only applicable to compressor contexts
515          using the LLA profile.  When retrieved, it will have
516          the value true(1) if the packet size is preferred.
517          Otherwise, its value will be false(2).
518
519          The value of this object is only valid for LLA profiles,
520          i.e., if the corresponding rohcProfile has a value of
521          0x0005.  If the corresponding rohcProfile has a value
522          other than 0x0005, then this object MUST NOT be
523          instantiated."
524     REFERENCE
525          "RFC 3242, Section 5.1.1"
526     ::= { rohcRtpPacketSizeEntry 4 }
527
528 rohcRtpPacketSizeUsed OBJECT-TYPE
529     SYNTAX      TruthValue
530     MAX-ACCESS  read-only
531     STATUS      current
532     DESCRIPTION
533         "This object is only applicable to compressor contexts
534          using the UDP, RTP, or ESP profile.  When retrieved,
535          it will have the value true(1) if the packet size is
536          used.  Otherwise, its value will be false(2).
537
538          The value of this object is only valid for UDP, RTP,
539          and ESP profiles, i.e., if the corresponding rohcProfile
540          has a value of either 0x0001, 0x0002 or 0x0003.  If
541          the corresponding rohcProfile has a value other than
542          0x0001, 0x0002 or 0x0003, then this object MUST NOT be
543          instantiated."
544     REFERENCE
545          "RFC 3095, Section 6.3.1"
546     ::= { rohcRtpPacketSizeEntry 5 }
547
548 rohcRtpPacketSizeRestrictedType OBJECT-TYPE
549     SYNTAX      INTEGER {
550                     nhpOnly(1),
551                     rhpOnly(2),
552                     noRestrictions(3)
553                 }
554     MAX-ACCESS  read-only
555     STATUS      current
556     DESCRIPTION
557         "This object is only applicable to preferred packet
558
559
560          sizes of compressor contexts using the LLA profile.
561          When retrieved, it will indicate whether the packet
562          size is preferred for NHP only, for RHP only, or
563          for both of them.
564
565          The value of this object is only valid for LLA profiles,
566          i.e., if the corresponding rohcProfile has a value of
567          0x0005.  If the corresponding rohcProfile has a value
568          other than 0x0005, then this object MUST NOT be
569          instantiated."
570     REFERENCE
571          "RFC 3242, Section 5.1.1"
572     ::= { rohcRtpPacketSizeEntry 6 }
573 --
574 -- conformance information
575 --
576
577 rohcRtpCompliances OBJECT IDENTIFIER ::= { rohcRtpConformance 1 }
578 rohcRtpGroups      OBJECT IDENTIFIER ::= { rohcRtpConformance 2 }
579
580 --
581 -- compliance statements
582 --
583
584 rohcRtpCompliance MODULE-COMPLIANCE
585     STATUS      current
586     DESCRIPTION
587         "The compliance statement for SNMP entities that implement
588          the ROHC-RTP-MIB.
589
590          Note that compliance with this compliance
591          statement requires compliance with the
592          rohcCompliance MODULE-COMPLIANCE statement of the
593          ROHC-MIB and with the ifCompliance3 MODULE-COMPLIANCE
594          statement of the IF-MIB (RFC2863)."
595     MODULE      -- this module
596     MANDATORY-GROUPS {
597             rohcRtpContextGroup
598     }
599     GROUP   rohcRtpPacketSizesGroup
600     DESCRIPTION
601        "A compliant implementation does not have to implement
602         the rohcRtpPacketSizesGroup."
603     GROUP   rohcRtpStatisticsGroup
604     DESCRIPTION
605        "A compliant implementation does not have to implement
606         the rohcRtpStatisticsGroup."
607     ::= { rohcRtpCompliances 1 }
608
609
610 rohcRtpContextGroup OBJECT-GROUP
611     OBJECTS {
612         rohcRtpContextState,
613         rohcRtpContextMode,
614         rohcRtpContextAlwaysPad,
615         rohcRtpContextLargePktsAllowed,
616         rohcRtpContextVerifyPeriod
617     }
618     STATUS      current
619     DESCRIPTION
620         "A collection of objects providing information about
621          ROHC RTP compressors and decompressors."
622     ::= { rohcRtpGroups 1 }
623
624 rohcRtpPacketSizesGroup OBJECT-GROUP
625     OBJECTS {
626         rohcRtpContextSizesAllowed,
627         rohcRtpContextSizesUsed,
628         rohcRtpPacketSizePreferred,
629         rohcRtpPacketSizeUsed,
630         rohcRtpPacketSizeRestrictedType
631     }
632     STATUS      current
633     DESCRIPTION
634         "A collection of objects providing information about
635          allowed and used packet sizes at a ROHC RTP compressor."
636     ::= { rohcRtpGroups 2 }
637
638 rohcRtpStatisticsGroup OBJECT-GROUP
639     OBJECTS {
640         rohcRtpContextACKs,
641         rohcRtpContextNACKs,
642         rohcRtpContextSNACKs,
643         rohcRtpContextNHPs,
644         rohcRtpContextCSPs,
645         rohcRtpContextCCPs,
646         rohcRtpContextPktsLostPhysical,
647         rohcRtpContextPktsLostPreLink
648     }
649     STATUS      current
650     DESCRIPTION
651         "A collection of objects providing ROHC compressor and
652          decompressor statistics."
653     ::= { rohcRtpGroups 3 }
654
655 END