1-- *****************************************************************
2-- ciscoWanModule MIB
3--
4-- The MIB supported in WAN Module
5--
6-- May 1999, Shilpa Kale
7-- July 2001, Rajesh Kumar
8-- Sept 2002, Subra Hegde
9--
10-- Copyright (c) 1999, 2001, 2002 by Cisco Systems, Inc.
11-- All rights reserved.
12-- *****************************************************************
13
14CISCO-WAN-MODULE-MIB DEFINITIONS ::= BEGIN
15IMPORTS
16    MODULE-IDENTITY,
17    OBJECT-TYPE,
18    Unsigned32                   FROM SNMPv2-SMI
19    MODULE-COMPLIANCE,
20    OBJECT-GROUP                 FROM SNMPv2-CONF
21    DisplayString,
22    TEXTUAL-CONVENTION           FROM SNMPv2-TC
23    ciscoMgmt                    FROM CISCO-SMI;
24
25ciscoWanModuleMIB MODULE-IDENTITY
26    LAST-UPDATED "200209110000Z"
27    ORGANIZATION "Cisco Systems, Inc."
28    CONTACT-INFO "Cisco Systems
29                  Customer Service
30
31                  Postal: 170 W Tasman Drive
32                  San Jose, CA  95134
33                  USA
34
35                  Tel: +1 800 553-NETS
36
37                  E-mail: cs-wanatm@cisco.com"
38    DESCRIPTION
39        "The MIB to configure Connection Specific parameters and
40         statistics related information in a Service Module.
41         The Service Module(SM) is defined as any Module which
42         provides services such as ATM, Frame Relay or Voice in a
43         Wide Area Network(WAN) switch."
44
45    REVISION "200209110000Z"
46    DESCRIPTION
47              "Imported Unsigned32 from SNMPv2-SMI instead
48              of CISCO-TC.
49              Added cwmUploadCounter in cwmConfigTable."
50
51    REVISION "200107200000Z"
52    DESCRIPTION
53              " 1. Added cwmSCTFileVerCfg and cwmSCTFileVerOpr to
54               CwmConfigEntry. "
55
56    REVISION "9910220000Z"
57    DESCRIPTION
58              "Initial version of the mib module."
59    ::= { ciscoMgmt 145 }
60
61cwmMIBObjects      OBJECT IDENTIFIER ::= { ciscoWanModuleMIB 1}
62
63cwmConfig          OBJECT IDENTIFIER ::= { cwmMIBObjects 1}
64cwmStatsConfig     OBJECT IDENTIFIER ::= { cwmMIBObjects 2 }
65
66StatisticsLevel ::= TEXTUAL-CONVENTION
67    STATUS current
68    DESCRIPTION
69       "Used to configure level statistics on service module.
70        Statistic level on a module dictates the type and
71        amount of statistics that is collected.
72
73        There is a predefined set of statistics associated with each level
74        and are enabled when a level is set. Also, setting statistics level
75        to N will enable counters associated with levels N-1 through 1 as well.
76
77        The valid values are
78
79         notApplicable(0)- Statistics level is not applicable.
80
81         levelOne(1)    - Enables level one counters.
82
83         levelTwo(2)    - Enables level two and level one counters.
84
85         levelThree(3)  - Enables level one, level two and level three
86                          counters."
87    SYNTAX INTEGER{
88        notApplicable(0),
89        levelOne(1),
90        levelTwo(2),
91        levelThree(3)
92    }
93
94-- Module configuration Table
95
96cwmConfigTable OBJECT-TYPE
97    SYNTAX      SEQUENCE OF CwmConfigEntry
98    MAX-ACCESS  not-accessible
99    STATUS      current
100    DESCRIPTION
101        "This table contains objects required for configuring module
102         specific parameters. These parameters may be related to the
103         hardware specific parameters which can affect the
104         ATM Connection characteristics."
105    ::= { cwmConfig 1}
106
107cwmConfigEntry OBJECT-TYPE
108    SYNTAX      CwmConfigEntry
109    MAX-ACCESS  not-accessible
110    STATUS      current
111    DESCRIPTION
112        "Entry containing information for each module."
113    INDEX { cwmIndex }
114    ::= { cwmConfigTable 1 }
115
116CwmConfigEntry ::=
117    SEQUENCE {
118        cwmIndex                     Unsigned32,
119        cwmIngressSCTFileId          Unsigned32,
120        cwmIngressSCTFileName        DisplayString,
121        cwmAutoLineDiagEnable        INTEGER,
122        cwmSCTFileVerCfg             Unsigned32,
123        cwmSCTFileVerOpr             Unsigned32,
124        cwmUploadCounter             Unsigned32
125    }
126
127cwmIndex OBJECT-TYPE
128    SYNTAX      Unsigned32 (1..2147483647)
129    MAX-ACCESS  not-accessible
130    STATUS      current
131    DESCRIPTION
132        "This object's value generally corresponds to the
133         slot number where the module resides. However,
134         system wide uniqueness is the only true requirement."
135    ::= {cwmConfigEntry  1 }
136
137cwmIngressSCTFileId OBJECT-TYPE
138    SYNTAX      Unsigned32 (0..255)
139    MAX-ACCESS  read-write
140    STATUS      current
141    DESCRIPTION
142        "The file ID of the Service Class Template(SCT) file. The SCT
143         holds the connection specific parameters for this module in
144         the ingress direction(From Network to the Switch).
145
146         Terminologies used:
147         SCT : Service Class Template
148          The Service Class Template ( or Service Template or SCT )
149          provides a means for inferring extended parameters, which
150          are generally platform-specific, from the set of standard
151          ATM protocol parameters passed in VSI(Virtual Switch Interface)
152          connection setup primitives. A set of Service Templates are
153          available in a non-volatile storage and is downloaded onto
154          each Service Module on power up.
155
156          In general, SCTs contain two classes of data. One class consists
157          of parameters necessary to establish a Virtual Connection
158          (i.e. Per-VC) and includes entries such as UPC(Usage Parameter Control)
159          actions, various bandwidth-related items, per-VC thresholds,
160          and some hardware-specific items.The second class of data items
161          includes those necessary to configure the associated
162          Class-of-Service Buffers that provide the QoS support."
163    ::= {cwmConfigEntry  2 }
164
165cwmIngressSCTFileName OBJECT-TYPE
166    SYNTAX  DisplayString
167    MAX-ACCESS  read-write
168    STATUS  current
169    DESCRIPTION
170       "This variable contains the SCT filename. Write access
171        is not required. The filename has cwmIngressSCTFileId
172        value as the suffix. For example, the value SCT.INGR.13
173        for this object indicates 13 is the value of
174        cwmIngressSCTFileId."
175    ::= { cwmConfigEntry 3 }
176
177cwmAutoLineDiagEnable OBJECT-TYPE
178    SYNTAX INTEGER {
179        enable(1),
180        disable(2)
181        }
182     MAX-ACCESS    read-write
183     STATUS    current
184     DESCRIPTION
185       "This object enables/disables automatic diagnostic feature
186        of physical lines on module.
187        In case of a line alarm, enabling this feature temporarily
188        suspends traffic in both direction and starts local loop-back
189        testing. Disabling this feature will not effect the traffic
190        in one direction while another direction is in alarm."
191     DEFVAL { disable }
192    ::= { cwmConfigEntry 4 }
193
194cwmSCTFileVerCfg OBJECT-TYPE
195    SYNTAX      Unsigned32 (0..65535)
196    MAX-ACCESS  read-write
197    STATUS      current
198    DESCRIPTION
199        "The Configured version of the Service Class Template(SCT)
200        file. This version applies to both the card SCT and the port
201        SCT files in a service module.
202
203        The port SCT files are specified while provisioning a port using
204        the caviFileId field in the CISCO-WAN-VIRTUAL-IF-MIB.my MIB.
205        The card SCT file is specifed in this MIB using the
206        cwmIngressSCTFileName object.
207
208        The configured version of the SCT does not take effect until
209        the service module is rebooted. However, graceful invocation
210        of a new SCT version can be achieved by using redundant service
211        modules. The configured SCT version is first applied on a standby
212        service module by rebooting it. When the standby reboots, it
213        comes up with the configured SCT version. Thereafter a switchover
214        can be performed, making the standby SM take over as active."
215    ::= {cwmConfigEntry  5 }
216
217cwmSCTFileVerOpr OBJECT-TYPE
218    SYNTAX      Unsigned32 (0..65535)
219    MAX-ACCESS  read-only
220    STATUS      current
221    DESCRIPTION
222        "The operational version of the Service Class Template(SCT)
223        file. This is sct version currently in use. The operational
224        version could be different from the configured version
225        (cwmSCTFileVerCfg), until the service module is rebooted."
226
227    ::= {cwmConfigEntry  6 }
228
229cwmUploadCounter  OBJECT-TYPE
230    SYNTAX      Unsigned32 (0..4294967295)
231    MAX-ACCESS  read-only
232    STATUS      current
233    DESCRIPTION
234        "This counter is used by the management station to
235        determine if any changes(other than ATM/FR connections)
236        have been done on configuration of a card.
237
238        The use of this object is implementation specific.
239        This requires the NMS application saving the previous
240        value of this object and compare it later for finding
241        any changes in the card.
242
243        The upload counter is incremented in, for instance:
244
245        - any physical interface characteristics are modified.
246        - any logical interface is added/deleted/modified.
247        - any IMA Group/MFR bundle is added/deleted/modified.
248        - any resource is added/deleted/modified on an interface.
249        - any configuration changes are done(not specified above)
250          which are not related to ATM/FR Connections
251          (SPVCs for example)."
252    ::= {cwmConfigEntry  7 }
253
254
255
256-- Statistics Configuration Table
257
258cwmStatConfigTable OBJECT-TYPE
259    SYNTAX      SEQUENCE OF CwmStatConfigEntry
260    MAX-ACCESS  not-accessible
261    STATUS      current
262    DESCRIPTION
263       "This table has objects required for configuring module statistic
264        collection related parameters. The statistics related to interfaces
265        and ATM Connections are stored in a file. The statistics file can be
266        uploaded by NMS applications using file transfer protocols such as tftp
267        or ftp. While current interval of data is being collected in memory,
268        previous interval of data is uploaded by NMS. Each interval's
269        data will overwrite the previous interval's data in the statistic
270        file after the interval is over."
271     ::= { cwmStatsConfig 1 }
272
273cwmStatConfigEntry OBJECT-TYPE
274    SYNTAX      CwmStatConfigEntry
275    MAX-ACCESS  not-accessible
276    STATUS      current
277    DESCRIPTION
278       "Entry containing statistics configuration information for
279        the module."
280    INDEX   { cwmIndex }
281    ::= { cwmStatConfigTable 1 }
282
283CwmStatConfigEntry ::=
284    SEQUENCE {
285         cwmStatBucketInterval          INTEGER,
286         cwmStatCollectionInterval      INTEGER,
287         cwmStatCollectionStatus        INTEGER,
288         cwmStatCurrentLevel            StatisticsLevel,
289         cwmStatLevelConfigured         StatisticsLevel,
290         cwmStatMaximumConnections      Unsigned32
291    }
292
293cwmStatBucketInterval OBJECT-TYPE
294   SYNTAX  INTEGER {
295            five(5),
296            ten(10),
297            fifteen(15),
298            twenty(20),
299            thirty(30),
300            sixty(60)
301            }
302    UNITS "minutes"
303    MAX-ACCESS  read-write
304    STATUS      current
305    DESCRIPTION
306       "This object contains the bucket interval in minutes used in
307        collecting statistics. This specifies the interval over
308        which the module accumulates a sample. This value also
309        defines the amount of time available to NMS application
310        to upload the statistic file in order to not miss one
311        interval worth of data."
312    DEFVAL { fifteen }
313    ::= {cwmStatConfigEntry  1 }
314
315cwmStatCollectionInterval OBJECT-TYPE
316    SYNTAX INTEGER {
317        default(0),
318        one(1),
319        five(5)
320        }
321    UNITS "minutes"
322    MAX-ACCESS  read-write
323    STATUS      current
324    DESCRIPTION
325       "The collection interval of statistics. Within a sampling interval,
326        as defined by cwmStatBucketInterval, statistics counters are
327        updated every collection interval.
328
329        Default value of collection interval is same as bucket interval.
330
331        In case of bucket interval being 5 minutes, default(0) and five(5)
332        values for this object has the same effect."
333    DEFVAL { default }
334    ::= {cwmStatConfigEntry 2 }
335
336cwmStatCollectionStatus OBJECT-TYPE
337    SYNTAX INTEGER {
338        enable(1),
339        disable(2)
340        }
341    MAX-ACCESS  read-write
342    STATUS      current
343    DESCRIPTION
344       "Enables or disables statistics collection on the module."
345    DEFVAL { enable }
346    ::= {cwmStatConfigEntry 3 }
347
348cwmStatCurrentLevel OBJECT-TYPE
349    SYNTAX      StatisticsLevel
350    MAX-ACCESS  read-only
351    STATUS      current
352    DESCRIPTION
353       "The current statistics level of the module.
354
355        A change in the card statistic level can take place only
356        after a module reset. This object shows the current module
357        statistic level. While cwmStatLevelConfigured object is
358        used to configure module statistic level. The value
359        set in cwmStatLevelConfigured object will take effect after
360        next module reset."
361    ::= {cwmStatConfigEntry 4 }
362
363cwmStatLevelConfigured OBJECT-TYPE
364    SYNTAX      StatisticsLevel
365    MAX-ACCESS  read-write
366    STATUS      current
367    DESCRIPTION
368       "This object is used to configure the statistics level
369        for the module. The statistics level value set in this
370        object will take effect only on reset of the module.
371
372        This object can be set only if cwmStatCollectionStatus is set
373        to enable(1). This object cannot be set to notApplicable(0)."
374    DEFVAL { levelOne }
375    ::= {cwmStatConfigEntry 5 }
376
377cwmStatMaximumConnections OBJECT-TYPE
378    SYNTAX      Unsigned32
379    MAX-ACCESS  read-only
380    STATUS      current
381    DESCRIPTION
382       "The maximum number of connections for which the statistics are
383        being collected."
384    ::= { cwmStatConfigEntry 6 }
385
386-- Notifications
387ciscoWanModuleMIBNotificationPrefix OBJECT IDENTIFIER ::=
388                                    { ciscoWanModuleMIB 2 }
389ciscoWanModuleMIBNotifications OBJECT IDENTIFIER ::=
390    { ciscoWanModuleMIBNotificationPrefix 0 }
391
392-- conformance information
393
394ciscoWanModuleMIBConformance OBJECT IDENTIFIER ::= { ciscoWanModuleMIB 3 }
395ciscoWanModuleMIBCompliances
396                     OBJECT IDENTIFIER ::= {ciscoWanModuleMIBConformance 1}
397ciscoWanModuleMIBGroups
398                     OBJECT IDENTIFIER ::= {ciscoWanModuleMIBConformance 2}
399
400ciscoWanModuleMIBCompliance MODULE-COMPLIANCE
401        STATUS deprecated
402        DESCRIPTION
403           "The Compliance statement for cwmConfigGroup group."
404
405        MODULE -- this module
406        MANDATORY-GROUPS { cwmConfigGroup }
407        OBJECT     cwmIngressSCTFileName
408        MIN-ACCESS read-only
409        DESCRIPTION
410        "Write access is not required if the cwmIngressSCTFileId
411         is specified."
412
413
414        GROUP cwmStatConfigGroup
415        DESCRIPTION
416            "Implementation of this group is not mandatory for
417             the modules which does not support statistics collection."
418
419        OBJECT cwmStatCollectionInterval
420        MIN-ACCESS not-accessible
421        DESCRIPTION
422            "This is an optional attribute."
423
424        OBJECT     cwmStatCurrentLevel
425        MIN-ACCESS not-accessible
426        DESCRIPTION
427            "This is an optional attribute. This attribute is not required
428             if the cwmStatLevelConfigured object is not supported."
429
430        OBJECT     cwmStatLevelConfigured
431        MIN-ACCESS not-accessible
432        DESCRIPTION
433            "This is an optional attribute. This object is not required
434             if the module does not support the statistics based on
435             statistics level setting."
436
437        ::= { ciscoWanModuleMIBCompliances 1 }
438
439  ciscoWanModuleMIBComplianceRev1 MODULE-COMPLIANCE
440          STATUS deprecated -- replaced by
441                            -- ciscoWanModuleMIBComplianceRev2
442          DESCRIPTION
443             "The Compliance statement for cwmConfigGroup group,
444              with addition of SCT file versioning "
445          MODULE -- this module
446          MANDATORY-GROUPS { cwmConfigGroup,
447                             cwmConfigGroup2 }
448          OBJECT     cwmIngressSCTFileName
449          MIN-ACCESS read-only
450          DESCRIPTION
451          "Write access is not required if the cwmIngressSCTFileId
452           is specified."
453
454
455          GROUP cwmStatConfigGroup
456          DESCRIPTION
457              "Implementation of this group is not mandatory for
458               the modules which does not support statistics
459               collection."
460
461          OBJECT cwmStatCollectionInterval
462          MIN-ACCESS not-accessible
463          DESCRIPTION
464              "This is an optional attribute."
465
466          OBJECT     cwmStatCurrentLevel
467          MIN-ACCESS not-accessible
468          DESCRIPTION
469              "This is an optional attribute. This attribute is not
470               required if the cwmStatLevelConfigured object is not
471               supported."
472
473          OBJECT     cwmStatLevelConfigured
474          MIN-ACCESS not-accessible
475          DESCRIPTION
476              "This is an optional attribute. This object is
477               not required if the module does not support the
478               statistics based on statistics level setting."
479
480          ::= { ciscoWanModuleMIBCompliances 2 }
481
482  ciscoWanModuleMIBComplianceRev2 MODULE-COMPLIANCE
483          STATUS current
484          DESCRIPTION
485             "The Compliance statement for cwmConfigGroup group,
486              with addition of SCT file versioning "
487          MODULE -- this module
488          MANDATORY-GROUPS { cwmConfigGroup,
489                             cwmConfigGroup2 }
490
491          GROUP      cwmUploadGroup
492          DESCRIPTION
493              "The implementation of this group is mandatory
494              where the changes to card configuration can
495              be tracked."
496
497          OBJECT     cwmIngressSCTFileName
498          MIN-ACCESS read-only
499          DESCRIPTION
500          "Write access is not required if the cwmIngressSCTFileId
501           is specified."
502
503
504          GROUP cwmStatConfigGroup
505          DESCRIPTION
506              "Implementation of this group is not mandatory for
507               the modules which does not support statistics
508               collection."
509
510          OBJECT cwmStatCollectionInterval
511          MIN-ACCESS not-accessible
512          DESCRIPTION
513              "This is an optional attribute."
514
515          OBJECT     cwmStatCurrentLevel
516          MIN-ACCESS not-accessible
517          DESCRIPTION
518              "This is an optional attribute. This attribute is not
519               required if the cwmStatLevelConfigured object is not
520               supported."
521
522          OBJECT     cwmStatLevelConfigured
523          MIN-ACCESS not-accessible
524          DESCRIPTION
525              "This is an optional attribute. This object is
526               not required if the module does not support the
527               statistics based on statistics level setting."
528
529          ::= { ciscoWanModuleMIBCompliances 3 }
530
531-- units of conformance
532
533cwmConfigGroup OBJECT-GROUP
534    OBJECTS {
535         cwmIngressSCTFileId ,
536         cwmIngressSCTFileName,
537         cwmAutoLineDiagEnable
538        }
539    STATUS current
540    DESCRIPTION
541        "Group containing Module Specific Parameters."
542    ::= { ciscoWanModuleMIBGroups 1}
543
544cwmStatConfigGroup OBJECT-GROUP
545        OBJECTS {
546             cwmStatBucketInterval,
547             cwmStatCurrentLevel,
548             cwmStatLevelConfigured,
549             cwmStatCollectionStatus,
550             cwmStatCollectionInterval,
551             cwmStatMaximumConnections
552            }
553       STATUS current
554       DESCRIPTION
555          "Group containing statistics configuration."
556       ::= { ciscoWanModuleMIBGroups 2}
557
558cwmConfigGroup2 OBJECT-GROUP
559      OBJECTS {
560           cwmSCTFileVerCfg,
561           cwmSCTFileVerOpr
562          }
563      STATUS current
564      DESCRIPTION
565          "Group containing additional Module Specific Parameters."
566      ::= { ciscoWanModuleMIBGroups 3}
567
568
569cwmUploadGroup OBJECT-GROUP
570      OBJECTS {
571           cwmUploadCounter
572          }
573      STATUS current
574      DESCRIPTION
575          "Group containing objects related to configuration
576          changes in a card."
577      ::= { ciscoWanModuleMIBGroups 4}
578
579END
580
581
582