Imported Upstream version 0.4.8
[platform/upstream/libsmi.git] / mibs / ietf / MPLS-LDP-FRAME-RELAY-STD-MIB
1 MPLS-LDP-FRAME-RELAY-STD-MIB DEFINITIONS ::= BEGIN
2
3 IMPORTS
4     OBJECT-TYPE,
5     MODULE-IDENTITY,
6     Unsigned32
7         FROM SNMPv2-SMI                                 --  [RFC2578]
8     MODULE-COMPLIANCE,
9     OBJECT-GROUP
10         FROM SNMPv2-CONF                                --  [RFC2580]
11
12     RowStatus,
13     StorageType
14
15
16         FROM SNMPv2-TC                                  --  [RFC2579]
17
18     DLCI
19         FROM FRAME-RELAY-DTE-MIB                        --  [RFC2115]
20
21     InterfaceIndexOrZero
22         FROM IF-MIB                                     --  [RFC2020]
23
24     mplsStdMIB
25         FROM MPLS-TC-STD-MIB                            --  [RFC3811]
26
27     mplsLdpEntityLdpId,
28     mplsLdpEntityIndex,
29     mplsLdpPeerLdpId
30         FROM MPLS-LDP-STD-MIB                           --  [RFC3813]
31     ;
32
33 mplsLdpFrameRelayStdMIB MODULE-IDENTITY
34     LAST-UPDATED "200406030000Z"  -- June 3, 2004
35     ORGANIZATION "Multiprotocol Label Switching (mpls)
36                   Working Group"
37     CONTACT-INFO
38         "Joan Cucchiara (jcucchiara@mindspring.com)
39          Marconi Communications, Inc.
40
41          Hans Sjostrand (hans@ipunplugged.com)
42          ipUnplugged
43
44          James V. Luciani (james_luciani@mindspring.com)
45          Marconi Communications, Inc.
46
47          Working Group Chairs:
48          George Swallow,   email: swallow@cisco.com
49          Loa Andersson,    email: loa@pi.se
50
51          MPLS Working Group, email: mpls@uu.net
52     "
53     DESCRIPTION
54         "Copyright (C) The Internet Society (year). The
55         initial version of this MIB module was published
56         in RFC 3815. For full legal notices see the RFC
57         itself or see:
58         http://www.ietf.org/copyrights/ianamib.html
59
60         This MIB contains managed object definitions for
61         configuring and monitoring the Multiprotocol Label
62         Switching (MPLS), Label Distribution Protocol (LDP),
63         utilizing Frame Relay as the Layer 2 media."
64
65
66
67     REVISION "200406030000Z"  -- June 6, 2004
68     DESCRIPTION
69         "Initial version published as part of RFC 3815."
70
71     ::= { mplsStdMIB 6 }
72
73 --****************************************************************
74
75 mplsLdpFrameRelayObjects  OBJECT IDENTIFIER
76                            ::= { mplsLdpFrameRelayStdMIB 1 }
77
78 mplsLdpFrameRelayConformance   OBJECT IDENTIFIER
79                            ::= { mplsLdpFrameRelayStdMIB 2 }
80
81 --****************************************************************
82 -- MPLS LDP Frame Relay Objects
83 --****************************************************************
84
85 --
86 -- Ldp Entity Objects for Frame Relay
87 --
88
89 mplsLdpEntityFrameRelayObjects OBJECT IDENTIFIER ::=
90                                     { mplsLdpFrameRelayObjects 1 }
91
92 mplsLdpEntityFrameRelayTable  OBJECT-TYPE
93     SYNTAX      SEQUENCE OF MplsLdpEntityFrameRelayEntry
94     MAX-ACCESS  not-accessible
95     STATUS      current
96     DESCRIPTION
97         "This table contains Frame Relay specific
98         information which could be used in the
99         'Optional Parameters' and other Frame Relay
100         specific information.
101
102         This table 'sparse augments' the mplsLdpEntityTable
103         when Frame Relay is the Layer 2 medium."
104     ::= { mplsLdpEntityFrameRelayObjects 1 }
105
106 mplsLdpEntityFrameRelayEntry OBJECT-TYPE
107     SYNTAX      MplsLdpEntityFrameRelayEntry
108     MAX-ACCESS  not-accessible
109     STATUS      current
110     DESCRIPTION
111         "An entry in this table represents the Frame Relay
112         optional parameters associated with the LDP entity."
113     INDEX       {  mplsLdpEntityLdpId,
114                    mplsLdpEntityIndex
115
116
117                 }
118     ::= { mplsLdpEntityFrameRelayTable 1 }
119
120 MplsLdpEntityFrameRelayEntry ::= SEQUENCE {
121     mplsLdpEntityFrameRelayIfIndexOrZero        InterfaceIndexOrZero,
122     mplsLdpEntityFrameRelayMergeCap             INTEGER,
123     mplsLdpEntityFrameRelayLRComponents         Unsigned32,
124     mplsLdpEntityFrameRelayVcDirectionality     INTEGER,
125     mplsLdpEntityFrameRelayStorageType          StorageType,
126     mplsLdpEntityFrameRelayRowStatus            RowStatus
127 }
128
129 mplsLdpEntityFrameRelayIfIndexOrZero OBJECT-TYPE
130     SYNTAX      InterfaceIndexOrZero
131     MAX-ACCESS  read-create
132     STATUS      current
133     DESCRIPTION
134        "This value represents either the InterfaceIndex of
135        the 'ifLayer' where the Frame Relay Labels 'owned' by this
136        entry were created, or 0 (zero).  The value of zero
137        means that the InterfaceIndex is not known.  For example,
138        if the InterfaceIndex is created subsequent to the
139        Frame Relay Label's creation, then it would not be known.
140        However, if the InterfaceIndex is known, then it must
141        be represented by this value.
142
143        If an InterfaceIndex becomes known, then the
144        network management entity (e.g., SNMP agent) responsible
145        for this object MUST change the value from 0 (zero) to the
146        value of the InterfaceIndex.  If an Frame Relay Label is
147        being used in forwarding data, then the value of this
148        object MUST be the InterfaceIndex."
149     ::= { mplsLdpEntityFrameRelayEntry 1 }
150
151 mplsLdpEntityFrameRelayMergeCap OBJECT-TYPE
152     SYNTAX      INTEGER {
153                     notSupported(0),
154                     supported(1)
155                 }
156     MAX-ACCESS  read-create
157     STATUS      current
158     DESCRIPTION
159         "This represents whether or not the Frame Relay merge
160         capability is supported.  This is the EXACT value for the
161         Frame Relay Session Parameter, field M (for Frame Relay
162         Merge Capabilities).  The Frame Relay Session Parameter
163         is an optional parameter in the Initialization Message.
164
165
166
167
168         The description from rfc3036.txt is:
169         'M, Frame Relay Merge Capabilities
170            Specifies the merge capabilities of a Frame
171            Relay switch.  The following values are
172            supported in this version of the
173            specification:
174
175                   Value          Meaning
176
177                     0            Merge not supported
178                     1            Merge supported
179
180            Non-merge and merge Frame Relay LSRs may
181            freely interoperate.'
182
183            Please refer to the following reference for a
184            complete description of this feature."
185      REFERENCE
186         "RFC3036, LDP Specification, Section 3.5.3
187         Initialization Message."
188     ::= { mplsLdpEntityFrameRelayEntry 2 }
189
190 mplsLdpEntityFrameRelayLRComponents OBJECT-TYPE
191     SYNTAX      Unsigned32 (1..65535)
192     MAX-ACCESS  read-only
193     STATUS      current
194     DESCRIPTION
195         "Number of Label Range Components in the Initialization
196         message.  This also represents the number of entries
197         in the mplsLdpEntityFrameRelayLRTable which correspond
198         to this entry.
199
200         This is the EXACT value for the Frame Relay Session
201         Parameter, field N (for Number of label range
202         components).  The Frame Relay Session Parameter
203         is an optional parameter in the Initialization
204         Message.
205
206         The description from rfc3036.txt is:
207
208         'N, Number of label range components
209             Specifies the number of Frame Relay Label
210             Range Components included in the TLV.'
211
212          Please refer to the following reference for a
213          complete description of this feature."
214      REFERENCE
215         "RFC3036, LDP Specification, Section 3.5.3
216
217
218
219         Initialization Message."
220     ::= { mplsLdpEntityFrameRelayEntry 3 }
221
222 mplsLdpEntityFrameRelayVcDirectionality OBJECT-TYPE
223     SYNTAX      INTEGER {
224                           bidirectional(0),
225                           unidirection(1)
226                         }
227     MAX-ACCESS  read-create
228     STATUS      current
229     DESCRIPTION
230         "If the value of this object is 'bidirectional(0)', then
231         the LSR supports the use of a given DLCI as a label for
232         both directions independently.  If the value of
233         this object is 'unidirectional(1)', then the LSR
234         uses the given DLCI as a label in only one direction.
235
236         This is the EXACT value for the Frame Relay Session
237         Parameter, field D (for VC Directionality).  The
238         Frame Relay Session Parameter is an optional
239         parameter in the Initialization Message.
240
241         The description from rfc3036.txt is:
242
243         'D, VC Directionality
244            A value of 0 specifies bidirectional VC capability,
245            meaning the LSR can support the use of a given
246            DLCI as a label for both link directions
247            independently.  A value of 1 specifies
248            unidirectional VC capability, meaning a given
249            DLCI may appear in a label mapping for one
250            direction on the link only.  When either or both
251            of the peers specifies unidirectional VC
252            capability, both LSRs use unidirectional VC
253            label assignment for the link as follows.  The
254            LSRs compare their LDP Identifiers as unsigned
255            integers.  The LSR with the larger LDP
256            Identifier may assign only odd-numbered DLCIs
257            in the range as labels.  The system with the
258            smaller LDP Identifier may assign only
259            even-numbered DLCIs in the range as labels.'
260
261            Please refer to the following reference for a
262            complete description of this feature."
263      REFERENCE
264         "RFC3036, LDP Specification, Section 3.5.3
265         Initialization Message."
266     ::= { mplsLdpEntityFrameRelayEntry 4 }
267
268
269 mplsLdpEntityFrameRelayStorageType  OBJECT-TYPE
270     SYNTAX      StorageType
271     MAX-ACCESS  read-create
272     STATUS      current
273     DESCRIPTION
274         "The storage type for this conceptual row.
275         Conceptual rows having the value 'permanent(4)'
276         need not allow write-access to any columnar
277         objects in the row."
278     DEFVAL { nonVolatile }
279     ::= { mplsLdpEntityFrameRelayEntry 5 }
280
281 mplsLdpEntityFrameRelayRowStatus OBJECT-TYPE
282     SYNTAX      RowStatus
283     MAX-ACCESS  read-create
284     STATUS      current
285     DESCRIPTION
286         "The status of this conceptual row.  All writable
287          objects in this row may be modified at any time,
288          however, as described in detail in the section
289          entitled, 'Changing Values After Session
290          Establishment', and again described in the
291          DESCRIPTION clause of the
292          mplsLdpEntityAdminStatus object,
293          if a session has been initiated with a Peer,
294          changing objects in this table will
295          wreak havoc with the session and interrupt
296          traffic.  To repeat again:
297          the recommended procedure is to set the
298          mplsLdpEntityAdminStatus to
299          down, thereby explicitly causing a
300          session to be torn down. Then,
301          change objects in this entry, then set
302          the mplsLdpEntityAdminStatus
303          to enable which enables a new session
304          to be initiated."
305     ::= { mplsLdpEntityFrameRelayEntry 6 }
306
307 --
308 -- Frame Relay Label Range Components
309 --
310
311 mplsLdpEntityFrameRelayLRTable  OBJECT-TYPE
312     SYNTAX      SEQUENCE OF MplsLdpEntityFrameRelayLREntry
313     MAX-ACCESS  not-accessible
314     STATUS      current
315     DESCRIPTION
316         "This table contains information about the
317
318
319         Optional Parameters for the Frame Relay Session
320         in the LDP Initialization Message, specifically
321         it contains information about the Frame Relay
322         Label Range Components.
323
324         If the value of the object
325         'mplsLdpEntityOptionalParameters' contains the
326         value of 'frameRelaySessionParameters(3)' then
327         there must be at least one corresponding entry
328         in this table."
329     ::= { mplsLdpEntityFrameRelayObjects 2 }
330
331 mplsLdpEntityFrameRelayLREntry OBJECT-TYPE
332     SYNTAX      MplsLdpEntityFrameRelayLREntry
333     MAX-ACCESS  not-accessible
334     STATUS      current
335     DESCRIPTION
336         "An entry in this table represents the Frame Relay
337         Label Range Component associated with the LDP entity."
338     INDEX       {  mplsLdpEntityLdpId,
339                    mplsLdpEntityIndex,
340                    mplsLdpEntityFrameRelayLRMinDlci
341                 }
342     ::= { mplsLdpEntityFrameRelayLRTable 1 }
343
344 MplsLdpEntityFrameRelayLREntry ::= SEQUENCE {
345     mplsLdpEntityFrameRelayLRMinDlci              DLCI,
346     mplsLdpEntityFrameRelayLRMaxDlci              DLCI,
347     mplsLdpEntityFrameRelayLRLen                  INTEGER,
348     mplsLdpEntityFrameRelayLRStorageType          StorageType,
349     mplsLdpEntityFrameRelayLRRowStatus            RowStatus
350 }
351
352 mplsLdpEntityFrameRelayLRMinDlci OBJECT-TYPE
353     SYNTAX      DLCI
354     MAX-ACCESS  not-accessible
355     STATUS      current
356     DESCRIPTION
357         "The lower bound which is supported.  This value
358         should be the same as that in the Frame Relay Label
359         Range Component's Minimum DLCI field.  The value
360         of zero is valid for the minimum DLCI field of
361         the label."
362     REFERENCE
363         "RFC3034, Use of Label Switching on Frame Relay
364         Networks Specification."
365     ::= { mplsLdpEntityFrameRelayLREntry 1 }
366
367
368
369 mplsLdpEntityFrameRelayLRMaxDlci OBJECT-TYPE
370     SYNTAX      DLCI
371     MAX-ACCESS  read-create
372     STATUS      current
373     DESCRIPTION
374         "The upper bound which is supported.  This value
375         should be the same as that in the Frame Relay Label
376         Range Component's Maximum DLCI field."
377     ::= { mplsLdpEntityFrameRelayLREntry 2 }
378
379 mplsLdpEntityFrameRelayLRLen OBJECT-TYPE
380     SYNTAX      INTEGER {
381                     tenDlciBits(0),
382                     twentyThreeDlciBits(2)
383                 }
384     MAX-ACCESS  read-create
385     STATUS      current
386     DESCRIPTION
387         "This object specifies the length of the DLCI bits.
388
389         This is the EXACT value for the Len field of the
390         Frame Relay Label Range Component.
391
392         The description from rfc3036.txt is:
393
394         'Len
395             This field specifies the number of bits of the DLCI.
396             The following values are supported:
397
398                  Len    DLCI bits
399
400                  0       10
401                  2       23
402
403             Len values 1 and 3 are reserved.'
404
405          Please refer to the following reference for a complete
406          description of this feature."
407      REFERENCE
408         "RFC3036, LDP Specification, Section 3.5.3
409         Initialization Message."
410     ::= { mplsLdpEntityFrameRelayLREntry 3 }
411
412 mplsLdpEntityFrameRelayLRStorageType  OBJECT-TYPE
413     SYNTAX      StorageType
414     MAX-ACCESS  read-create
415     STATUS      current
416     DESCRIPTION
417
418
419         "The storage type for this conceptual row.
420         Conceptual rows having the value 'permanent(4)'
421         need not allow write-access to any columnar
422         objects in the row."
423     DEFVAL { nonVolatile }
424     ::= { mplsLdpEntityFrameRelayLREntry 4 }
425
426 mplsLdpEntityFrameRelayLRRowStatus OBJECT-TYPE
427     SYNTAX      RowStatus
428     MAX-ACCESS  read-create
429     STATUS      current
430     DESCRIPTION
431         "The status of this conceptual row.  All writable
432          objects in this row may be modified at any time,
433          however, as described in detail in the section
434          entitled, 'Changing Values After Session
435          Establishment', and again described in the
436          DESCRIPTION clause of the
437          mplsLdpEntityAdminStatus object,
438          if a session has been initiated with a Peer,
439          changing objects in this table will
440          wreak havoc with the session and interrupt
441          traffic.  To repeat again:
442          the recommended procedure is to set the
443          mplsLdpEntityAdminStatus to down, thereby
444          explicitly causing a session to be torn down. Then,
445          change objects in this entry, then set the
446          mplsLdpEntityAdminStatus to enable which enables
447          a new session to be initiated."
448     ::= { mplsLdpEntityFrameRelayLREntry 5 }
449
450 --
451 -- MPLS LDP Frame Relay Session Information
452 --
453
454 mplsLdpFrameRelaySessionObjects  OBJECT IDENTIFIER ::=
455                            { mplsLdpFrameRelayObjects  2 }
456
457 mplsLdpFrameRelaySessionTable OBJECT-TYPE
458     SYNTAX      SEQUENCE OF MplsLdpFrameRelaySessionEntry
459     MAX-ACCESS  not-accessible
460     STATUS      current
461     DESCRIPTION
462         "A table of Frame Relay label range intersections
463         between the LDP Entities and LDP Peers.
464         Each row represents a single label range intersection.
465
466         NOTE:  this table cannot use the 'AUGMENTS'
467
468
469         clause because there is not necessarily a one-to-one
470         mapping between this table and the
471         mplsLdpSessionTable."
472     ::= { mplsLdpFrameRelaySessionObjects 1 }
473
474 mplsLdpFrameRelaySessionEntry OBJECT-TYPE
475     SYNTAX      MplsLdpFrameRelaySessionEntry
476     MAX-ACCESS  not-accessible
477     STATUS      current
478     DESCRIPTION
479         "An entry in this table represents information on a
480         single label range intersection between an
481         LDP Entity and LDP Peer.
482
483         The information contained in a row is read-only."
484     INDEX       { mplsLdpEntityLdpId,
485                   mplsLdpEntityIndex,
486                   mplsLdpPeerLdpId,
487                   mplsLdpFrameRelaySessionMinDlci
488                 }
489     ::= { mplsLdpFrameRelaySessionTable 1 }
490
491 MplsLdpFrameRelaySessionEntry ::= SEQUENCE {
492     mplsLdpFrameRelaySessionMinDlci    DLCI,
493     mplsLdpFrameRelaySessionMaxDlci    DLCI,
494     mplsLdpFrameRelaySessionLen        INTEGER
495 }
496
497 mplsLdpFrameRelaySessionMinDlci OBJECT-TYPE
498     SYNTAX      DLCI
499     MAX-ACCESS  not-accessible
500     STATUS      current
501     DESCRIPTION
502         "The lower bound of DLCIs which are supported.
503         The value of zero is a valid value for the
504         minimum DLCI field of the label."
505     REFERENCE
506         "RFC3034, Use of Label Switching on Frame Relay
507         Networks Specification."
508     ::= { mplsLdpFrameRelaySessionEntry 1 }
509
510 mplsLdpFrameRelaySessionMaxDlci OBJECT-TYPE
511     SYNTAX      DLCI
512     MAX-ACCESS  read-only
513     STATUS      current
514     DESCRIPTION
515         "The upper bound of DLCIs which are supported."
516     ::= { mplsLdpFrameRelaySessionEntry 2 }
517
518
519 mplsLdpFrameRelaySessionLen OBJECT-TYPE
520     SYNTAX      INTEGER {
521                     tenDlciBits(0),
522                     twentyThreeDlciBits(2)
523                 }
524     MAX-ACCESS  read-only
525     STATUS      current
526     DESCRIPTION
527         "This object specifies the DLCI bits."
528     ::= { mplsLdpFrameRelaySessionEntry 3 }
529
530 --****************************************************************
531 -- Module Conformance Statement
532 --****************************************************************
533
534 mplsLdpFrameRelayGroups
535     OBJECT IDENTIFIER ::= { mplsLdpFrameRelayConformance 1 }
536
537 mplsLdpFrameRelayCompliances
538     OBJECT IDENTIFIER ::= { mplsLdpFrameRelayConformance 2 }
539
540 --
541 -- Full Compliance
542 --
543
544 mplsLdpFrameRelayModuleFullCompliance MODULE-COMPLIANCE
545     STATUS current
546     DESCRIPTION
547         "The Module is implemented with support for
548         read-create and read-write.  In other words,
549         both monitoring and configuration
550         are available when using this MODULE-COMPLIANCE."
551     MODULE -- this module
552         MANDATORY-GROUPS    {
553                                mplsLdpFrameRelayGroup
554                             }
555
556     OBJECT       mplsLdpEntityFrameRelayRowStatus
557     SYNTAX       RowStatus { active(1) }
558     WRITE-SYNTAX RowStatus { createAndGo(4), destroy(6) }
559     DESCRIPTION
560        "Support for createAndWait and notInService is not required."
561
562     OBJECT       mplsLdpEntityFrameRelayLRRowStatus
563     SYNTAX       RowStatus { active(1) }
564     WRITE-SYNTAX RowStatus { createAndGo(4), destroy(6) }
565     DESCRIPTION
566        "Support for createAndWait and notInService is not required."
567
568
569     ::= { mplsLdpFrameRelayCompliances 1 }
570
571 --
572 -- Read-Only Compliance
573 --
574
575 mplsLdpFrameRelayModuleReadOnlyCompliance MODULE-COMPLIANCE
576     STATUS current
577     DESCRIPTION
578         "The Module is implemented with support for
579         read-only.  In other words, only monitoring
580         is available by implementing this MODULE-COMPLIANCE."
581     MODULE -- this module
582         MANDATORY-GROUPS    {
583                                mplsLdpFrameRelayGroup
584                             }
585
586     OBJECT       mplsLdpEntityFrameRelayIfIndexOrZero
587     MIN-ACCESS   read-only
588     DESCRIPTION
589        "Write access is not required."
590
591     OBJECT       mplsLdpEntityFrameRelayMergeCap
592     MIN-ACCESS   read-only
593     DESCRIPTION
594        "Write access is not required."
595
596     OBJECT       mplsLdpEntityFrameRelayVcDirectionality
597     MIN-ACCESS   read-only
598     DESCRIPTION
599        "Write access is not required."
600
601     OBJECT       mplsLdpEntityFrameRelayStorageType
602     MIN-ACCESS   read-only
603     DESCRIPTION
604        "Write access is not required."
605
606     OBJECT       mplsLdpEntityFrameRelayRowStatus
607     SYNTAX       RowStatus { active(1) }
608     MIN-ACCESS   read-only
609     DESCRIPTION
610        "Write access is not required, and active is the
611        only status that needs to be supported."
612
613     OBJECT       mplsLdpEntityFrameRelayLRMaxDlci
614     MIN-ACCESS   read-only
615     DESCRIPTION
616        "Write access is not required."
617
618
619     OBJECT       mplsLdpEntityFrameRelayLRLen
620     MIN-ACCESS   read-only
621     DESCRIPTION
622        "Write access is not required."
623
624     OBJECT       mplsLdpEntityFrameRelayLRStorageType
625     MIN-ACCESS   read-only
626     DESCRIPTION
627        "Write access is not required."
628
629     OBJECT       mplsLdpEntityFrameRelayLRRowStatus
630     SYNTAX       RowStatus { active(1) }
631     MIN-ACCESS   read-only
632     DESCRIPTION
633        "Write access is not required, and active is the
634        only status that needs to be supported."
635     ::= { mplsLdpFrameRelayCompliances 2 }
636
637 --
638 -- units of conformance
639 --
640
641 mplsLdpFrameRelayGroup OBJECT-GROUP
642     OBJECTS {
643     mplsLdpEntityFrameRelayIfIndexOrZero,
644     mplsLdpEntityFrameRelayMergeCap,
645     mplsLdpEntityFrameRelayLRComponents,
646     mplsLdpEntityFrameRelayVcDirectionality,
647     mplsLdpEntityFrameRelayStorageType,
648     mplsLdpEntityFrameRelayRowStatus,
649     mplsLdpEntityFrameRelayLRMaxDlci,
650     mplsLdpEntityFrameRelayLRLen,
651     mplsLdpEntityFrameRelayLRStorageType,
652     mplsLdpEntityFrameRelayLRRowStatus,
653     mplsLdpFrameRelaySessionMaxDlci,
654     mplsLdpFrameRelaySessionLen
655     }
656     STATUS    current
657     DESCRIPTION
658         "Objects that apply to all MPLS LDP implementations
659         using Frame Relay as the Layer 2."
660     ::= { mplsLdpFrameRelayGroups 1 }
661
662 END