Imported Upstream version 0.4.8
[platform/upstream/libsmi.git] / mibs / ietf / MPLS-TC-STD-MIB
1 MPLS-TC-STD-MIB DEFINITIONS ::= BEGIN
2
3     IMPORTS
4
5        MODULE-IDENTITY,
6        Unsigned32, Integer32,
7        transmission           FROM SNMPv2-SMI            -- [RFC2578]
8
9        TEXTUAL-CONVENTION
10           FROM SNMPv2-TC;                                -- [RFC2579]
11
12     mplsTCStdMIB MODULE-IDENTITY
13        LAST-UPDATED "200406030000Z" -- June 3, 2004
14        ORGANIZATION
15           "IETF Multiprotocol Label Switching (MPLS) Working
16            Group."
17        CONTACT-INFO
18             "        Thomas D. Nadeau
19
20
21
22                      Cisco Systems, Inc.
23                      tnadeau@cisco.com
24
25                      Joan Cucchiara
26                      Marconi Communications, Inc.
27                      jcucchiara@mindspring.com
28
29                      Cheenu Srinivasan
30                      Bloomberg L.P.
31                      cheenu@bloomberg.net
32
33                      Arun Viswanathan
34                      Force10 Networks, Inc.
35                      arunv@force10networks.com
36
37                      Hans Sjostrand
38                      ipUnplugged
39                      hans@ipunplugged.com
40
41                      Kireeti Kompella
42                      Juniper Networks
43                      kireeti@juniper.net
44
45           Email comments to the MPLS WG Mailing List at
46           mpls@uu.net."
47        DESCRIPTION
48            "Copyright (C) The Internet Society (2004). The
49            initial version of this MIB module was published
50            in RFC 3811. For full legal notices see the RFC
51            itself or see:
52            http://www.ietf.org/copyrights/ianamib.html
53
54            This MIB module defines TEXTUAL-CONVENTIONs
55            for concepts used in Multiprotocol Label
56            Switching (MPLS) networks."
57
58        REVISION "200406030000Z" -- June 3, 2004
59        DESCRIPTION
60           "Initial version published as part of RFC 3811."
61
62         ::= { mplsStdMIB 1 }
63
64     mplsStdMIB OBJECT IDENTIFIER
65
66     ::= { transmission 166 }
67
68     MplsAtmVcIdentifier ::= TEXTUAL-CONVENTION
69        DISPLAY-HINT "d"
70
71
72
73        STATUS  current
74        DESCRIPTION
75           "A Label Switching Router (LSR) that
76            creates LDP sessions on ATM interfaces
77            uses the VCI or VPI/VCI field to hold the
78            LDP Label.
79
80            VCI values MUST NOT be in the 0-31 range.
81            The values 0 to 31 are reserved for other uses
82            by the ITU and ATM Forum.  The value
83            of 32 can only be used for the Control VC,
84            although values greater than 32 could be
85            configured for the Control VC.
86
87            If a value from 0 to 31 is used for a VCI
88            the management entity controlling the LDP
89            subsystem should reject this with an
90            inconsistentValue error.  Also, if
91            the value of 32 is used for a VC which is
92            NOT the Control VC, this should
93            result in an inconsistentValue error."
94        REFERENCE
95           "MPLS using LDP and ATM VC Switching, RFC3035."
96        SYNTAX  Integer32 (32..65535)
97
98     MplsBitRate ::= TEXTUAL-CONVENTION
99        DISPLAY-HINT "d"
100        STATUS      current
101        DESCRIPTION
102           "If the value of this object is greater than zero,
103            then this represents the bandwidth of this MPLS
104            interface (or Label Switched Path) in units of
105            '1,000 bits per second'.
106
107            The value, when greater than zero, represents the
108            bandwidth of this MPLS interface (rounded to the
109            nearest 1,000) in units of 1,000 bits per second.
110            If the bandwidth of the MPLS interface is between
111            ((n * 1000) - 500) and ((n * 1000) + 499), the value
112            of this object is n, such that n > 0.
113
114            If the value of this object is 0 (zero), this
115            means that the traffic over this MPLS interface is
116            considered to be best effort."
117        SYNTAX  Unsigned32 (0|1..4294967295)
118
119     MplsBurstSize ::= TEXTUAL-CONVENTION
120        DISPLAY-HINT "d"
121
122
123
124        STATUS      current
125        DESCRIPTION
126           "The number of octets of MPLS data that the stream
127            may send back-to-back without concern for policing.
128            The value of zero indicates that an implementation
129            does not support Burst Size."
130        SYNTAX  Unsigned32 (0..4294967295)
131
132     MplsExtendedTunnelId ::= TEXTUAL-CONVENTION
133        STATUS        current
134        DESCRIPTION
135           "A unique identifier for an MPLS Tunnel.  This may
136            represent an IPv4 address of the ingress or egress
137            LSR for the tunnel.  This value is derived from the
138            Extended Tunnel Id in RSVP or the Ingress Router ID
139            for CR-LDP."
140        REFERENCE
141           "RSVP-TE: Extensions to RSVP for LSP Tunnels,
142            [RFC3209].
143
144            Constraint-Based LSP Setup using LDP, [RFC3212]."
145        SYNTAX  Unsigned32(0..4294967295)
146
147     MplsLabel ::= TEXTUAL-CONVENTION
148        STATUS        current
149        DESCRIPTION
150           "This value represents an MPLS label as defined in
151            [RFC3031],  [RFC3032], [RFC3034], [RFC3035] and
152            [RFC3471].
153
154            The label contents are specific to the label being
155            represented, such as:
156
157            * The label carried in an MPLS shim header
158              (for LDP this is the Generic Label) is a 20-bit
159              number represented by 4 octets.  Bits 0-19 contain
160              a label or a reserved label value.  Bits 20-31
161              MUST be zero.
162
163              The following is quoted directly from [RFC3032].
164              There are several reserved label values:
165
166                 i. A value of 0 represents the
167                    'IPv4 Explicit NULL Label'.  This label
168                    value is only legal at the bottom of the
169                    label stack.  It indicates that the label
170                    stack must be popped, and the forwarding
171                    of the packet must then be based on the
172
173
174
175                    IPv4 header.
176
177                ii. A value of 1 represents the
178                    'Router Alert Label'.  This label value is
179                    legal anywhere in the label stack except at
180                    the bottom.  When a received packet
181                    contains this label value at the top of
182                    the label stack, it is delivered to a
183                    local software module for processing.
184                    The actual forwarding of the packet
185                    is determined by the label beneath it
186                    in the stack.  However, if the packet is
187                    forwarded further, the Router Alert Label
188                    should be pushed back onto the label stack
189                    before forwarding.  The use of this label
190                    is analogous to the use of the
191                    'Router Alert Option' in IP packets
192                    [RFC2113].  Since this label
193                    cannot occur at the bottom of the stack,
194                    it is not associated with a
195                    particular network layer protocol.
196
197               iii. A value of 2 represents the
198                    'IPv6 Explicit NULL Label'.  This label
199                    value is only legal at the bottom of the
200                    label stack.  It indicates that the label
201                    stack must be popped, and the forwarding
202                    of the packet must then be based on the
203                    IPv6 header.
204
205                iv. A value of 3 represents the
206                    'Implicit NULL Label'.
207                    This is a label that an LSR may assign and
208                    distribute, but which never actually
209                    appears in the encapsulation.  When an
210                    LSR would otherwise replace the label
211                    at the top of the stack with a new label,
212                    but the new label is 'Implicit NULL',
213                    the LSR will pop the stack instead of
214                    doing the replacement.  Although
215                    this value may never appear in the
216                    encapsulation, it needs to be specified in
217                    the Label Distribution Protocol, so a value
218                    is reserved.
219
220                 v. Values 4-15 are reserved.
221
222            * The frame relay label can be either 10-bits or
223
224
225
226              23-bits depending on the DLCI field size and the
227              upper 22-bits or upper 9-bits must be zero,
228              respectively.
229
230            * For an ATM label the lower 16-bits represents the
231              VCI, the next 12-bits represents the VPI and the
232              remaining bits MUST be zero.
233
234            * The Generalized-MPLS (GMPLS) label contains a
235              value greater than 2^24-1 and used in GMPLS
236              as defined in [RFC3471]."
237        REFERENCE
238           "Multiprotocol Label Switching Architecture,
239            RFC3031.
240
241            MPLS Label Stack Encoding, [RFC3032].
242
243            Use of Label Switching on Frame Relay Networks,
244            RFC3034.
245
246            MPLS using LDP and ATM VC Switching, RFC3035.
247            Generalized Multiprotocol Label Switching
248            (GMPLS) Architecture, [RFC3471]."
249        SYNTAX  Unsigned32 (0..4294967295)
250
251     MplsLabelDistributionMethod ::= TEXTUAL-CONVENTION
252        STATUS  current
253        DESCRIPTION
254           "The label distribution method which is also called
255            the label advertisement mode [RFC3036].
256            Each interface on an LSR is configured to operate
257            in either Downstream Unsolicited or Downstream
258            on Demand."
259        REFERENCE
260           "Multiprotocol Label Switching Architecture,
261            RFC3031.
262
263            LDP Specification, RFC3036, Section 2.6.3."
264        SYNTAX INTEGER {
265                   downstreamOnDemand(1),
266                   downstreamUnsolicited(2)
267               }
268
269     MplsLdpIdentifier ::= TEXTUAL-CONVENTION
270        DISPLAY-HINT "1d.1d.1d.1d:2d"
271        STATUS      current
272        DESCRIPTION
273           "The LDP identifier is a six octet
274
275
276
277            quantity which is used to identify a
278            Label Switching Router (LSR) label space.
279
280            The first four octets identify the LSR and
281            must be a globally unique value, such as a
282            32-bit router ID assigned to the LSR, and the
283            last two octets identify a specific label
284            space within the LSR."
285        SYNTAX  OCTET STRING (SIZE (6))
286
287     MplsLsrIdentifier ::= TEXTUAL-CONVENTION
288        STATUS      current
289        DESCRIPTION
290           "The Label Switching Router (LSR) identifier is the
291            first 4 bytes of the Label Distribution Protocol
292            (LDP) identifier."
293        SYNTAX  OCTET STRING (SIZE (4))
294     MplsLdpLabelType ::= TEXTUAL-CONVENTION
295        STATUS      current
296        DESCRIPTION
297           "The Layer 2 label types which are defined for MPLS
298            LDP and/or CR-LDP are generic(1), atm(2), or
299            frameRelay(3)."
300        SYNTAX  INTEGER {
301                  generic(1),
302                  atm(2),
303                  frameRelay(3)
304              }
305
306     MplsLSPID ::= TEXTUAL-CONVENTION
307        STATUS        current
308        DESCRIPTION
309           "A unique identifier within an MPLS network that is
310            assigned to each LSP.  This is assigned at the head
311            end of the LSP and can be used by all LSRs
312            to identify this LSP.  This value is piggybacked by
313            the signaling protocol when this LSP is signaled
314            within the network.  This identifier can then be
315            used at each LSR to identify which labels are
316            being swapped to other labels for this LSP.  This
317            object  can also be used to disambiguate LSPs that
318            share the same RSVP sessions between the same
319            source and destination.
320
321            For LSPs established using CR-LDP, the LSPID is
322            composed of the ingress LSR Router ID (or any of
323            its own IPv4 addresses) and a locally unique
324            CR-LSP ID to that LSR.  The first two bytes carry
325
326
327
328            the CR-LSPID, and the remaining 4 bytes carry
329            the Router ID.  The LSPID is useful in network
330            management, in CR-LSP repair, and in using
331            an already established CR-LSP as a hop in
332            an ER-TLV.
333
334            For LSPs signaled using RSVP-TE, the LSP ID is
335            defined as a 16-bit (2 byte) identifier used
336            in the SENDER_TEMPLATE and the FILTER_SPEC
337            that can be changed to allow a sender to
338            share resources with itself.  The length of this
339            object should only be 2 or 6 bytes.  If the length
340            of this octet string is 2 bytes, then it must
341            identify an RSVP-TE LSPID, or it is 6 bytes,
342            it must contain a CR-LDP LSPID."
343        REFERENCE
344           "RSVP-TE:  Extensions to RSVP for LSP Tunnels,
345            [RFC3209].
346
347            Constraint-Based LSP Setup using LDP,
348            [RFC3212]."
349        SYNTAX  OCTET STRING (SIZE (2|6))
350
351     MplsLspType ::= TEXTUAL-CONVENTION
352        STATUS  current
353        DESCRIPTION
354           "Types of Label Switch Paths (LSPs)
355            on a Label Switching Router (LSR) or a
356            Label Edge Router (LER) are:
357
358               unknown(1)         -- if the LSP is not known
359                                     to be one of the following.
360
361               terminatingLsp(2)  -- if the LSP terminates
362                                     on the LSR/LER, then this
363                                     is an egressing LSP
364                                     which ends on the LSR/LER,
365
366               originatingLsp(3)  -- if the LSP originates
367                                     from this LSR/LER, then
368                                     this is an ingressing LSP
369                                     which is the head-end of
370                                     the LSP,
371
372            crossConnectingLsp(4) -- if the LSP ingresses
373                                     and egresses on the LSR,
374                                     then it is
375                                     cross-connecting on that
376
377
378
379                                     LSR."
380        SYNTAX INTEGER {
381                   unknown(1),
382                   terminatingLsp(2),
383                   originatingLsp(3),
384                   crossConnectingLsp(4)
385               }
386
387     MplsOwner ::= TEXTUAL-CONVENTION
388        STATUS      current
389        DESCRIPTION
390           "This object indicates the local network
391            management subsystem that originally created
392            the object(s) in question.  The values of
393            this enumeration are defined as follows:
394
395            unknown(1) - the local network management
396            subsystem cannot discern which
397            component created the object.
398
399            other(2) - the local network management
400            subsystem is able to discern which component
401            created the object, but the component is not
402            listed within the following choices,
403            e.g., command line interface (cli).
404
405            snmp(3) - The Simple Network Management Protocol
406            was used to configure this object initially.
407
408            ldp(4) - The Label Distribution Protocol was
409            used to configure this object initially.
410
411            crldp(5) - The Constraint-Based Label Distribution
412            Protocol was used to configure this object
413            initially.
414
415            rsvpTe(6) - The Resource Reservation Protocol was
416            used to configure this object initially.
417
418            policyAgent(7) - A policy agent (perhaps in
419            combination with one of the above protocols) was
420            used to configure this object initially.
421
422            An object created by any of the above choices
423            MAY be modified or destroyed by the same or a
424            different choice."
425        SYNTAX  INTEGER {
426                  unknown(1),
427
428
429
430                  other(2),
431                  snmp(3),
432                  ldp(4),
433                  crldp(5),
434                  rsvpTe(6),
435                  policyAgent(7)
436              }
437
438     MplsPathIndexOrZero ::= TEXTUAL-CONVENTION
439        STATUS current
440        DESCRIPTION
441           "A unique identifier used to identify a specific
442            path used by a tunnel.  A value of 0 (zero) means
443            that no path is in use."
444        SYNTAX  Unsigned32(0..4294967295)
445
446     MplsPathIndex ::= TEXTUAL-CONVENTION
447        STATUS        current
448        DESCRIPTION
449           "A unique value to index (by Path number) an
450            entry in a table."
451        SYNTAX  Unsigned32(1..4294967295)
452
453     MplsRetentionMode ::= TEXTUAL-CONVENTION
454        STATUS  current
455        DESCRIPTION
456           "The label retention mode which specifies whether
457            an LSR maintains a label binding for a FEC
458            learned from a neighbor that is not its next hop
459            for the FEC.
460
461            If the value is conservative(1) then advertised
462            label mappings are retained only if they will be
463            used to forward packets, i.e., if label came from
464            a valid next hop.
465
466            If the value is liberal(2) then all advertised
467            label mappings are retained whether they are from
468            a valid next hop or not."
469        REFERENCE
470           "Multiprotocol Label Switching Architecture,
471            RFC3031.
472
473            LDP Specification, RFC3036, Section 2.6.2."
474        SYNTAX INTEGER {
475                   conservative(1),
476                   liberal(2)
477               }
478
479
480
481     MplsTunnelAffinity ::= TEXTUAL-CONVENTION
482        STATUS        current
483        DESCRIPTION
484           "Describes the configured 32-bit Include-any,
485            include-all, or exclude-all constraint for
486            constraint-based link selection."
487        REFERENCE
488           "RSVP-TE:  Extensions to RSVP for LSP Tunnels,
489            RFC3209, Section 4.7.4."
490        SYNTAX  Unsigned32(0..4294967295)
491
492     MplsTunnelIndex ::= TEXTUAL-CONVENTION
493        STATUS        current
494        DESCRIPTION
495           "A unique index into mplsTunnelTable.
496            For tunnels signaled using RSVP, this value
497            should correspond to the RSVP Tunnel ID
498            used for the RSVP-TE session."
499        SYNTAX  Unsigned32 (0..65535)
500
501     MplsTunnelInstanceIndex ::= TEXTUAL-CONVENTION
502        STATUS        current
503        DESCRIPTION
504           "The tunnel entry with instance index 0
505            should refer to the configured tunnel
506            interface (if one exists).
507
508            Values greater than 0, but less than or
509            equal to 65535, should be used to indicate
510            signaled (or backup) tunnel LSP instances.
511            For tunnel LSPs signaled using RSVP,
512            this value should correspond to the
513            RSVP LSP ID used for the RSVP-TE
514            LSP.
515
516            Values greater than 65535 apply to FRR
517            detour instances."
518        SYNTAX  Unsigned32(0|1..65535|65536..4294967295)
519
520     TeHopAddressType ::= TEXTUAL-CONVENTION
521        STATUS     current
522        DESCRIPTION
523           "A value that represents a type of address for a
524            Traffic Engineered (TE) Tunnel hop.
525
526            unknown(0)   An unknown address type.  This value
527                         MUST be used if the value of the
528                         corresponding TeHopAddress object is a
529
530
531
532                         zero-length string.  It may also be
533                         used to indicate a TeHopAddress which
534                         is not in one of the formats defined
535                         below.
536
537            ipv4(1)      An IPv4 network address as defined by
538                         the InetAddressIPv4 TEXTUAL-CONVENTION
539                         [RFC3291].
540
541            ipv6(2)      A global IPv6 address as defined by
542                         the InetAddressIPv6 TEXTUAL-CONVENTION
543                         [RFC3291].
544
545            asnumber(3)  An Autonomous System (AS) number as
546                         defined by the TeHopAddressAS
547                         TEXTUAL-CONVENTION.
548
549            unnum(4)     An unnumbered interface index as
550                         defined by the TeHopAddressUnnum
551                         TEXTUAL-CONVENTION.
552
553            lspid(5)     An LSP ID for TE Tunnels
554                         (RFC3212) as defined by the
555                         MplsLSPID TEXTUAL-CONVENTION.
556
557            Each definition of a concrete TeHopAddressType
558            value must be accompanied by a definition
559            of a TEXTUAL-CONVENTION for use with that
560            TeHopAddress.
561
562            To support future extensions, the TeHopAddressType
563            TEXTUAL-CONVENTION SHOULD NOT be sub-typed in
564            object type definitions.  It MAY be sub-typed in
565            compliance statements in order to require only a
566            subset of these address types for a compliant
567            implementation.
568
569            Implementations must ensure that TeHopAddressType
570            objects and any dependent objects
571            (e.g., TeHopAddress objects) are consistent.
572            An inconsistentValue error must be generated
573            if an attempt to change a TeHopAddressType
574            object would, for example, lead to an
575            undefined TeHopAddress value that is
576            not defined herein.  In particular,
577            TeHopAddressType/TeHopAddress pairs
578            must be changed together if the address
579            type changes (e.g., from ipv6(2) to ipv4(1))."
580
581
582
583        REFERENCE
584           "TEXTUAL-CONVENTIONs for Internet Network
585            Addresses, RFC3291.
586
587            Constraint-Based LSP Setup using LDP,
588            [RFC3212]"
589
590        SYNTAX     INTEGER {
591                      unknown(0),
592                      ipv4(1),
593                      ipv6(2),
594                      asnumber(3),
595                      unnum(4),
596                      lspid(5)
597                   }
598
599     TeHopAddress ::= TEXTUAL-CONVENTION
600        STATUS     current
601        DESCRIPTION
602           "Denotes a generic Tunnel hop address,
603            that is, the address of a node which
604            an LSP traverses, including the source
605            and destination nodes.  An address may be
606            very concrete, for example, an IPv4 host
607            address (i.e., with prefix length 32);
608            if this IPv4 address is an interface
609            address, then that particular interface
610            must be traversed.  An address may also
611            specify an 'abstract node', for example,
612            an IPv4 address with prefix length
613            less than 32, in which case, the LSP
614            can traverse any node whose address
615            falls in that range.  An address may
616            also specify an Autonomous System (AS),
617            in which  case the LSP can traverse any
618            node that falls within that AS.
619
620            A TeHopAddress value is always interpreted within
621            the context of an TeHopAddressType value.  Every
622            usage of the TeHopAddress TEXTUAL-CONVENTION
623            is required to specify the TeHopAddressType object
624            which provides the context.  It is suggested that
625            the TeHopAddressType object is logically registered
626            before the object(s) which use the TeHopAddress
627            TEXTUAL-CONVENTION if they appear in the
628            same logical row.
629
630            The value of a TeHopAddress object must always be
631
632
633
634            consistent with the value of the associated
635            TeHopAddressType object.  Attempts to set a
636            TeHopAddress object to a value which is
637            inconsistent with the associated TeHopAddressType
638            must fail with an inconsistentValue error."
639        SYNTAX     OCTET STRING (SIZE (0..32))
640
641     TeHopAddressAS ::= TEXTUAL-CONVENTION
642        STATUS      current
643        DESCRIPTION
644           "Represents a two or four octet AS number.
645            The AS number is represented in network byte
646            order (MSB first).  A two-octet AS number has
647            the two MSB octets set to zero."
648        REFERENCE
649           "Textual Conventions for Internet Network
650            Addresses, [RFC3291].  The
651            InetAutonomousSystemsNumber TEXTUAL-CONVENTION
652            has a SYNTAX of Unsigned32, whereas this TC
653            has a SYNTAX of OCTET STRING (SIZE (4)).
654            Both TCs represent an autonomous system number
655            but use different syntaxes to do so."
656        SYNTAX      OCTET STRING (SIZE (4))
657
658     TeHopAddressUnnum ::= TEXTUAL-CONVENTION
659        STATUS      current
660        DESCRIPTION
661           "Represents an unnumbered interface:
662
663            octets   contents               encoding
664             1-4     unnumbered interface   network-byte order
665
666            The corresponding TeHopAddressType value is
667            unnum(5)."
668        SYNTAX      OCTET STRING(SIZE(4))
669
670 END