1-- *****************************************************************
2-- CISCO-IETF-VPLS-BGP-EXT-MIB.my
3--
4-- November 2008, Panchalingesh Konananavar.
5--
6-- Copyright (c) 2008-2009 by cisco Systems, Inc.
7-- All rights reserved.
8--
9-- ****************************************************************
10
11CISCO-IETF-VPLS-BGP-EXT-MIB DEFINITIONS ::= BEGIN
12
13IMPORTS
14    MODULE-IDENTITY,
15    OBJECT-TYPE,
16    Unsigned32
17        FROM SNMPv2-SMI
18    ciscoExperiment
19        FROM CISCO-SMI
20    MODULE-COMPLIANCE,
21    OBJECT-GROUP
22        FROM SNMPv2-CONF
23    RowStatus,
24    StorageType,
25    TEXTUAL-CONVENTION
26        FROM SNMPv2-TC
27    SnmpAdminString
28        FROM SNMP-FRAMEWORK-MIB
29    cvplsConfigIndex,
30    cvplsPwBindIndex
31        FROM CISCO-IETF-VPLS-GENERIC-MIB;
32
33
34ciscoIetfVplsBgpExtMIB MODULE-IDENTITY
35    LAST-UPDATED    "200810240000Z"
36    ORGANIZATION    "Cisco Systems, Inc."
37    CONTACT-INFO
38            "Cisco Systems
39            Customer Service
40
41            Postal: 170 W Tasman Drive
42            San Jose, CA  95134
43            USA
44
45            Tel: +1 800 553-NETS
46
47            E-mail: cs-l2vpn@cisco.com"
48    DESCRIPTION
49        "This MIB module enables the use of any underlying Pseudo Wire network.
50
51        This MIB extends the MIB module published in the RFC 4188 to manage
52        object definitions for BGP signalled VPLS.
53
54                              GLOSSARY
55        PE
56        The term PE refers to Provider-Edge devices.
57
58        Pseudo Wire
59        An emulation of a native service over a Packet Switched Network.
60
61        RD (Route Distinguisher)
62        They are used to create VPN-IPv4 addresses, as specified in [RFC4364].
63
64        RT (Route Target)
65        A Route Target attribute can be thought of as identifying a set of
66        sites. More description specified in [RFC4364].
67
68        u-PE
69        A Layer 2 PE device used for Layer 2 aggregation. The notion of u-PE is
70        described further in [RFC4761].
71
72        VE
73        The term VE refers to a VPLS Edge device, which could be either
74        a PE or a u-PE.
75
76        VPLS
77        Virtual private LAN service. A type of layer 2 VPN."
78    REVISION        "200810240000Z"
79    DESCRIPTION
80        "Initial version of this MIB module."
81    ::= { ciscoExperiment 140 }
82
83
84
85CiVplsBgpExtRouteDistinguisher ::= TEXTUAL-CONVENTION
86    STATUS          current
87    DESCRIPTION
88        "This textual convention represents a Route Distinguisher.
89        Please refer to RFC 4364 for more details about the
90        Route Distinguisher. Please refer to draft-ietf-l2vpn-vpls-bgp-08
91        on the use of a Route Distinguisher for a VPLS."
92
93    REFERENCE       "[RFC4364]"
94    SYNTAX          OCTET STRING (SIZE (0..256))
95
96CiVplsBgpExtRouteTarget ::= TEXTUAL-CONVENTION
97    STATUS          current
98    DESCRIPTION
99        "This textual convention represents a Route Target.
100        Please refer to RFC 4364 for more details about the
101        Route Target. Please refer to draft-ietf-l2vpn-vpls-bgp-08
102        on the use of a Route Target for a VPLS."
103
104    REFERENCE       "[RFC4364]"
105    SYNTAX          OCTET STRING (SIZE (0..256))
106
107CiVplsBgpExtRouteTargetType ::= TEXTUAL-CONVENTION
108    STATUS          current
109    DESCRIPTION
110        "This textual convention represents the type of a route target usage.
111        Route targets can be specified to be imported, exported, or both."
112
113    REFERENCE       "[RFC 4364]"
114    SYNTAX          INTEGER  {
115                        import(1),
116                        export(2),
117                        both(3)
118                    }
119
120CiVplsBgpExtVEID ::= TEXTUAL-CONVENTION
121    STATUS          current
122    DESCRIPTION
123        "This textual convention represents a VE id."
124    SYNTAX          Unsigned32
125ciscoIetfVplsBgpExtMIBNotifs  OBJECT IDENTIFIER
126    ::= { ciscoIetfVplsBgpExtMIB 0 }
127
128ciscoIetfVplsBgpExtMIBObjects  OBJECT IDENTIFIER
129    ::= { ciscoIetfVplsBgpExtMIB 1 }
130
131ciscoIetfVplsBgpExtMIBConform  OBJECT IDENTIFIER
132    ::= { ciscoIetfVplsBgpExtMIB 2 }
133
134-- Objects
135
136ciVplsBgpExtConfigTable OBJECT-TYPE
137    SYNTAX          SEQUENCE OF CiVplsBgpExtConfigEntry
138    MAX-ACCESS      not-accessible
139    STATUS          current
140    DESCRIPTION
141        "This table specifies information for configuring
142        and monitoring BGP-specific parameters for VPLS.
143
144        A row is automatically created when a VPLS is
145        configured using BGP signalling.
146
147        None of the read-write objects values can be
148        changed when cvplsConfigRowStatus is in the active(1)
149        state. Changes are allowed when the cvplsConfigRowStatus
150        is in notInService(2) or notReady(3) states only.
151        If the operator need to change one of the values
152        for an active row the cvplsConfigRowStatus should be
153        first changed to notInService(2), the objects may
154        be changed now, and later to active(1) in order to
155        re-initiate the signaling process with the new
156        values in effect."
157    ::= { ciscoIetfVplsBgpExtMIBObjects 1 }
158
159ciVplsBgpExtConfigEntry OBJECT-TYPE
160    SYNTAX          CiVplsBgpExtConfigEntry
161    MAX-ACCESS      not-accessible
162    STATUS          current
163    DESCRIPTION
164        "Each Entry represents a conceptual row in ciVplsBgpExtConfigTable
165        and provides the information about BGP-specific information
166        for VPLS in a packet network."
167    INDEX           { cvplsConfigIndex }
168    ::= { ciVplsBgpExtConfigTable 1 }
169
170CiVplsBgpExtConfigEntry ::= SEQUENCE {
171        ciVplsBgpExtConfigRouteDistinguisher CiVplsBgpExtRouteDistinguisher,
172        ciVplsBgpExtConfigVERangeSize        Unsigned32
173}
174
175ciVplsBgpExtConfigRouteDistinguisher OBJECT-TYPE
176    SYNTAX          CiVplsBgpExtRouteDistinguisher
177    MAX-ACCESS      read-write
178    STATUS          current
179    DESCRIPTION
180        "This object represents the Route Distingiusher for this VPLS."
181    DEFVAL          { "" }
182    ::= { ciVplsBgpExtConfigEntry 1 }
183
184ciVplsBgpExtConfigVERangeSize OBJECT-TYPE
185    SYNTAX          Unsigned32 (0..65535 )
186    MAX-ACCESS      read-write
187    STATUS          current
188    DESCRIPTION
189        "This object represents the size of the range of VE identifiers in this VPLS.
190        This number controls the size of the label block advertised for this
191        VE by the PE.
192        A value of 0 indicates that the range is not configured and the PE
193        derives the range value from received advertisements from other PEs."
194    DEFVAL          { 0 }
195    ::= { ciVplsBgpExtConfigEntry 4 }
196
197
198
199civplsBgpExtRTTable OBJECT-TYPE
200    SYNTAX          SEQUENCE OF CiVplsBgpExtRTEntry
201    MAX-ACCESS      not-accessible
202    STATUS          current
203    DESCRIPTION
204        "This table specifies information for the list of RTs imported or
205         exported by BGP during auto-discovery of VPLS."
206    ::= { ciscoIetfVplsBgpExtMIBObjects 2 }
207
208civplsBgpExtRTEntry OBJECT-TYPE
209    SYNTAX          CiVplsBgpExtRTEntry
210    MAX-ACCESS      not-accessible
211    STATUS          current
212    DESCRIPTION
213        "Each Entry represents a conceptual row in civplsBgpExtRTTable
214        and provides the information about the value of the RT being used by BGP.
215        Depending on the value of civplsBgpExtRTType, an RT might be exported or
216        imported or both. Every VPLS, which uses auto-discovery for finding peer
217        nodes, can import and export multiple RTs. This representation allows
218        support for hierarchical VPLS. A row is created by the operator or agent
219        prior to autodiscovery."
220    INDEX           {
221                        cvplsConfigIndex,
222                        ciVplsBgpExtRTType,
223                        ciVplsBgpExtRT
224                    }
225    ::= { civplsBgpExtRTTable 1 }
226
227CiVplsBgpExtRTEntry ::= SEQUENCE {
228        ciVplsBgpExtRTType        CiVplsBgpExtRouteTargetType,
229        ciVplsBgpExtRT            CiVplsBgpExtRouteTarget,
230        ciVplsBgpExtRTStorageType StorageType,
231        ciVplsBgpExtRTRowStatus   RowStatus
232}
233
234ciVplsBgpExtRTType OBJECT-TYPE
235    SYNTAX          CiVplsBgpExtRouteTargetType
236    MAX-ACCESS      read-create
237    STATUS          current
238    DESCRIPTION
239        "This object represents the type of a RT usage. RTs can be specified
240        to be imported, exported, or both."
241    ::= { civplsBgpExtRTEntry 1 }
242
243ciVplsBgpExtRT OBJECT-TYPE
244    SYNTAX          CiVplsBgpExtRouteTarget (SIZE  (1..64))
245    MAX-ACCESS      read-create
246    STATUS          current
247    DESCRIPTION
248        "The RT associated with the VPLS service."
249    ::= { civplsBgpExtRTEntry 2 }
250
251ciVplsBgpExtRTStorageType OBJECT-TYPE
252    SYNTAX          StorageType
253    MAX-ACCESS      read-create
254    STATUS          current
255    DESCRIPTION
256        "This object indicates the storage type for this row."
257    DEFVAL          { volatile }
258    ::= { civplsBgpExtRTEntry 3 }
259
260ciVplsBgpExtRTRowStatus OBJECT-TYPE
261    SYNTAX          RowStatus
262    MAX-ACCESS      read-create
263    STATUS          current
264    DESCRIPTION
265        "This object is used to create, modify, and/or
266        delete a row in this table.  When a row in this
267        table is in active(1) state, no objects in that row
268        can be modified."
269    ::= { civplsBgpExtRTEntry 4 }
270
271
272
273ciVplsBgpExtVETable OBJECT-TYPE
274    SYNTAX          SEQUENCE OF CiVplsBgpExtVEEntry
275    MAX-ACCESS      not-accessible
276    STATUS          current
277    DESCRIPTION
278        "This table associates VPLS Edge devices to a VPLS.
279        The VEs assigned to a VPLS can be configured on a PE.
280        This table has an expansion dependant relationship
281        with cvplsConfigTable. For each row identified by
282        cvplsConfigIndex, there may exist one or more rows
283        in this table. ciVplsBgpExtVEId is the expansion index.
284
285        None of the read-create objects values can be
286        changed when ciVplsBgpExtVERowStatus is in the active(1)
287        state. Changes are allowed when the ciVplsBgpExtVERowStatus
288        is in notInService(2) or notReady(3) states only.
289        If the operator need to change one of the values
290        for an active row the ciVplsBgpExtVERowStatus should be
291        first changed to notInService(2), the objects may
292        be changed now, and later to active(1) in order to
293        re-initiate the signaling process with the new
294        values in effect."
295    ::= { ciscoIetfVplsBgpExtMIBObjects 3 }
296
297ciVplsBgpExtVEEntry OBJECT-TYPE
298    SYNTAX          CiVplsBgpExtVEEntry
299    MAX-ACCESS      not-accessible
300    STATUS          current
301    DESCRIPTION
302        "Each Entry represents a conceptual row in ciVplsBgpExtVETable
303        and provides the information about VPLS Edge devices."
304    INDEX           {
305                        cvplsConfigIndex,
306                        ciVplsBgpExtVEId
307                    }
308    ::= { ciVplsBgpExtVETable 1 }
309
310CiVplsBgpExtVEEntry ::= SEQUENCE {
311        ciVplsBgpExtVEId          CiVplsBgpExtVEID,
312        ciVplsBgpExtVEName        SnmpAdminString,
313        ciVplsBgpExtVEPreference  Unsigned32,
314        ciVplsBgpExtVEStorageType StorageType,
315        ciVplsBgpExtVERowStatus   RowStatus
316}
317
318ciVplsBgpExtVEId OBJECT-TYPE
319    SYNTAX          CiVplsBgpExtVEID
320    MAX-ACCESS      not-accessible
321    STATUS          current
322    DESCRIPTION
323        "This object identifies a VE associated with a VPLS."
324    ::= { ciVplsBgpExtVEEntry 1 }
325
326ciVplsBgpExtVEName OBJECT-TYPE
327    SYNTAX          SnmpAdminString
328    MAX-ACCESS      read-create
329    STATUS          current
330    DESCRIPTION
331        "This object represents the name of the site or u-PE associated with this VE."
332    DEFVAL          { "" }
333    ::= { ciVplsBgpExtVEEntry 2 }
334
335ciVplsBgpExtVEPreference OBJECT-TYPE
336    SYNTAX          Unsigned32 (0..65535 )
337    MAX-ACCESS      read-create
338    STATUS          current
339    DESCRIPTION
340        "This object represents the preference of the VE if the site is multi-homed and VE Id is used."
341    DEFVAL          { 0 }
342    ::= { ciVplsBgpExtVEEntry 3 }
343
344ciVplsBgpExtVEStorageType OBJECT-TYPE
345    SYNTAX          StorageType
346    MAX-ACCESS      read-create
347    STATUS          current
348    DESCRIPTION
349        "This object indicates the storage type for this row."
350    DEFVAL          { volatile }
351    ::= { ciVplsBgpExtVEEntry 5 }
352
353ciVplsBgpExtVERowStatus OBJECT-TYPE
354    SYNTAX          RowStatus
355    MAX-ACCESS      read-create
356    STATUS          current
357    DESCRIPTION
358        "This object is used to create, modify, and/or
359        delete a row in this table.  When a row in this
360        table is in active(1) state, no objects in that row
361        can be modified."
362    ::= { ciVplsBgpExtVEEntry 6 }
363
364
365
366ciVplsBgpExtPwBindTable OBJECT-TYPE
367    SYNTAX          SEQUENCE OF CiVplsBgpExtPwBindEntry
368    MAX-ACCESS      not-accessible
369    STATUS          current
370    DESCRIPTION
371        "This table provides BGP-specific information for
372        an association between a VPLS and the
373        corresponding Pseudo Wires. A service can have more
374        than one Pseudo Wire association. Pseudo Wires are
375        defined in the cpwvcTable.
376
377        Each row represents an association between a VPLS instance
378        and one or more Pseudo Wires defined in the cpwVcTable in
379        CISCO-IETF-PW-MIB.
380
381        An Entry in this table in instantiated only when
382        BGP signalling is used to configure VPLS."
383    ::= { ciscoIetfVplsBgpExtMIBObjects 4 }
384
385ciVplsBgpExtPwBindEntry OBJECT-TYPE
386    SYNTAX          CiVplsBgpExtPwBindEntry
387    MAX-ACCESS      not-accessible
388    STATUS          current
389    DESCRIPTION
390        "Each Entry represents a conceptual row in ciVplsBgpExtPwBindTable
391        and provides the information about BGP-specific information for
392        an association between a VPLS and the
393        corresponding Pseudo Wires."
394    INDEX           {
395                        cvplsConfigIndex,
396                        cvplsPwBindIndex
397                    }
398    ::= { ciVplsBgpExtPwBindTable 1 }
399
400CiVplsBgpExtPwBindEntry ::= SEQUENCE {
401        ciVplsBgpExtPwBindLocalVEId  CiVplsBgpExtVEID,
402        ciVplsBgpExtPwBindRemoteVEId CiVplsBgpExtVEID
403}
404
405ciVplsBgpExtPwBindLocalVEId OBJECT-TYPE
406    SYNTAX          CiVplsBgpExtVEID
407    MAX-ACCESS      read-only
408    STATUS          current
409    DESCRIPTION
410        "This object represents the local VE this Pseudo Wire is associated with."
411    ::= { ciVplsBgpExtPwBindEntry 1 }
412
413ciVplsBgpExtPwBindRemoteVEId OBJECT-TYPE
414    SYNTAX          CiVplsBgpExtVEID
415    MAX-ACCESS      read-only
416    STATUS          current
417    DESCRIPTION
418        "This object represents the remote VE this Pseudo Wire is associated with."
419    ::= { ciVplsBgpExtPwBindEntry 2 }
420
421
422-- Notifiations
423--
424
425-- Conformance
426
427ciscoIetfVplsBgpExtMIBCompliances  OBJECT IDENTIFIER
428    ::= { ciscoIetfVplsBgpExtMIBConform 1 }
429
430ciscoIetfVplsBgpExtMIBGroups  OBJECT IDENTIFIER
431    ::= { ciscoIetfVplsBgpExtMIBConform 2 }
432
433
434ciscoIetfVplsBgpExtMIBCompliance MODULE-COMPLIANCE
435    STATUS          current
436    DESCRIPTION
437        "Compliance statement for the entities that implement
438        the ciscoIetfVplsBgpExtMIB module."
439    MODULE          -- this module
440    MANDATORY-GROUPS {
441                        ciVplsBgpExtConfigGroup,
442                        ciVplsBgpExtRTGroup,
443                        ciVplsBgpExtVEGroup,
444                        ciVplsBgpExtPwBindGroup
445                    }
446
447    OBJECT          ciVplsBgpExtConfigRouteDistinguisher
448    MIN-ACCESS      read-only
449    DESCRIPTION
450        "Write access is not required."
451
452    OBJECT          ciVplsBgpExtRT
453    MIN-ACCESS      read-only
454    DESCRIPTION
455        "Write access is not required."
456
457    OBJECT          ciVplsBgpExtRTType
458    MIN-ACCESS      read-only
459    DESCRIPTION
460        "Write access is not required."
461
462    OBJECT          ciVplsBgpExtRTStorageType
463    DESCRIPTION
464        "volatile(2) is the only storage type required
465        to be supported.  Support for other(1), nonVolatile (3),
466        permanent (4) and readOnly (5) is not required."
467
468    OBJECT          ciVplsBgpExtRTRowStatus
469    MIN-ACCESS      read-only
470    DESCRIPTION
471        "Write access is not required."
472
473    OBJECT          ciVplsBgpExtConfigVERangeSize
474    MIN-ACCESS      read-only
475    DESCRIPTION
476        "Write access is not required."
477
478    OBJECT          ciVplsBgpExtVEName
479    MIN-ACCESS      read-only
480    DESCRIPTION
481        "Write access is not required."
482
483    OBJECT          ciVplsBgpExtVEPreference
484    MIN-ACCESS      read-only
485    DESCRIPTION
486        "Write access is not required."
487
488    OBJECT          ciVplsBgpExtVEStorageType
489    DESCRIPTION
490        "volatile(2) is the only storage type required
491        to be supported.  Support for other(1), nonVolatile (3),
492        permanent (4) and readOnly (5) is not required."
493
494    OBJECT          ciVplsBgpExtVERowStatus
495    MIN-ACCESS      read-only
496    DESCRIPTION
497        "Write access is not required."
498    ::= { ciscoIetfVplsBgpExtMIBCompliances 1 }
499
500-- Units of Conformance
501
502ciVplsBgpExtConfigGroup OBJECT-GROUP
503    OBJECTS         {
504                        ciVplsBgpExtConfigRouteDistinguisher,
505                        ciVplsBgpExtConfigVERangeSize
506                    }
507    STATUS          current
508    DESCRIPTION
509        "This group of objects help to configure L2VPN  VPLS using BGP."
510    ::= { ciscoIetfVplsBgpExtMIBGroups 1 }
511
512ciVplsBgpExtRTGroup OBJECT-GROUP
513    OBJECTS         {
514                        ciVplsBgpExtRTType,
515                        ciVplsBgpExtRT,
516                        ciVplsBgpExtRTStorageType,
517                        ciVplsBgpExtRTRowStatus
518                    }
519    STATUS          current
520    DESCRIPTION
521        "The group of objects help to manage RTs
522        for L2VPN VPLS using BGP."
523    ::= { ciscoIetfVplsBgpExtMIBGroups 2 }
524
525ciVplsBgpExtVEGroup OBJECT-GROUP
526    OBJECTS         {
527                        ciVplsBgpExtVEName,
528                        ciVplsBgpExtVEPreference,
529                        ciVplsBgpExtVERowStatus,
530                        ciVplsBgpExtVEStorageType
531                    }
532    STATUS          current
533    DESCRIPTION
534        "The group of objects help to manage VE devices
535        for L2VPN VPLS using BGP."
536    ::= { ciscoIetfVplsBgpExtMIBGroups 3 }
537
538ciVplsBgpExtPwBindGroup OBJECT-GROUP
539    OBJECTS         {
540                        ciVplsBgpExtPwBindLocalVEId,
541                        ciVplsBgpExtPwBindRemoteVEId
542                    }
543    STATUS          current
544    DESCRIPTION
545        "The group of objects help to manage
546        Pseudo Wires for L2VPN VPLS using BGP."
547    ::= { ciscoIetfVplsBgpExtMIBGroups 4 }
548
549END
550
551
552
553
554