1-- ******************************************************************
2-- CISCO-HW-MODULE-CONTROL-MIB.my: Cisco Hardware Module Control MIB.
3--
4-- November 2009, Guichuan Tang
5--
6-- Copyright (c) 2009, 2010 by Cisco Systems, Inc.
7-- All rights reserved.
8--
9-- ******************************************************************
10
11CISCO-HW-MODULE-CONTROL-MIB DEFINITIONS ::= BEGIN
12
13IMPORTS
14    MODULE-IDENTITY,
15    OBJECT-TYPE,
16    Unsigned32
17        FROM SNMPv2-SMI
18    MODULE-COMPLIANCE,
19    OBJECT-GROUP
20        FROM SNMPv2-CONF
21    entPhysicalIndex
22        FROM ENTITY-MIB
23    CiscoInterfaceIndexList
24        FROM CISCO-TC
25    ciscoMgmt
26        FROM CISCO-SMI;
27
28
29ciscoHwModuleControlMIB MODULE-IDENTITY
30    LAST-UPDATED    "201008090000Z"
31    ORGANIZATION    "Cisco Systems, Inc."
32    CONTACT-INFO
33            "Cisco Systems
34            Customer Service
35
36            Postal: 170 W Tasman Drive
37            San Jose, CA 95134
38            USA
39
40            Tel: +1 800 553-NETS
41
42            E-mail: cs-lan-switch-snmp@cisco.com"
43    DESCRIPTION
44        "The MIB module providing configuration and control
45        information for management of hardware modules and
46        components on Cisco devices.
47
48        The following features are managed: bandwidth
49        oversubscription, clearing of HoL(Head of Line)
50        blocking, etc.
51
52        Bandwidth oversubscription: a group of ports are
53        said to be operating in bandwidth oversubscription
54        mode if the amount of internal forwarding fabric
55        bandwidth allocated to the group of ports on a
56        switching or routing device is less than the aggregate
57        maximum connection speeds of these ports.
58
59        Clearing of HoL blocking: refers to the process
60        in which if any port of a port group receives a
61        pause frame from the remote side, it will block
62        packet transmission on all ports of the port group
63        till a packet is delivered to the flow controlled
64        port. If the clearing of HoL blocking feature is
65        disabled, the device will drop packets destined
66        for the jammed ports and continue delivering
67        packets for the other ports."
68    REVISION        "201008090000Z"
69    DESCRIPTION
70        "Added ciscoHmcMIBOperModeGroup."
71    REVISION        "200911120000Z"
72    DESCRIPTION
73        "Initial version of this MIB module."
74    ::= { ciscoMgmt 714 }
75
76
77ciscoHwModuleControlMIBNotifs  OBJECT IDENTIFIER
78    ::= { ciscoHwModuleControlMIB 0 }
79
80ciscoHwModuleControlMIBObjects  OBJECT IDENTIFIER
81    ::= { ciscoHwModuleControlMIB 1 }
82
83ciscoHwModuleControlMIBConform  OBJECT IDENTIFIER
84    ::= { ciscoHwModuleControlMIB 2 }
85
86chmcOversubscription  OBJECT IDENTIFIER
87    ::= { ciscoHwModuleControlMIBObjects 1 }
88
89chmcOperationalMode   OBJECT IDENTIFIER
90    ::= { ciscoHwModuleControlMIBObjects 2 }
91
92-- The hw-module oversubscription group
93
94chmcOversubModuleTable OBJECT-TYPE
95    SYNTAX          SEQUENCE OF ChmcOversubModuleEntry
96    MAX-ACCESS      not-accessible
97    STATUS          current
98    DESCRIPTION
99        "Contains information for managing bandwidth
100        oversubscription feature for physical modules
101        capable of providing such feature."
102    ::= { chmcOversubscription 1 }
103
104chmcOversubModuleEntry OBJECT-TYPE
105    SYNTAX          ChmcOversubModuleEntry
106    MAX-ACCESS      not-accessible
107    STATUS          current
108    DESCRIPTION
109        "Each entry provides management information for a
110        specific physical module as indicated by the value
111        of entPhysicalIndex, which is capable of providing
112        bandwidth oversubscription feature."
113    INDEX           { entPhysicalIndex }
114    ::= { chmcOversubModuleTable 1 }
115
116ChmcOversubModuleEntry ::= SEQUENCE {
117        chmcOversubModuleCapabilities BITS,
118        chmcOversubModOversubStatus   INTEGER
119}
120
121chmcOversubModuleCapabilities OBJECT-TYPE
122    SYNTAX          BITS {
123                        oversubConfigModuleLevel(0),
124                        oversubConfigPortGroupLevel(1),
125                        clearblockConfigPortGroupLevel(2)
126                    }
127    MAX-ACCESS      read-only
128    STATUS          current
129    DESCRIPTION
130        "Indicates the attributes of this module with
131        respective to the bandwidth oversubscription feature.
132
133        oversubConfigModuleLevel(0) -
134              This bit is set if configuration of bandwidth
135              oversubscription is supported at module level.
136
137        oversubConfigPortGroupLevel(1) -
138              This bit is set if configuration of bandwidth
139              oversubscription is supported at port group
140              level.
141
142        clearblockConfigPortGroupLevel(2) -
143              This bit is set if configuration of clearing
144              of HoL blocking is supported at port group
145              level."
146    ::= { chmcOversubModuleEntry 1 }
147
148chmcOversubModOversubStatus OBJECT-TYPE
149    SYNTAX          INTEGER  {
150                        enabledOnAllPortGroups(1),
151                        disabledOnAllPortGroups(2),
152                        portGroupSpecific(3) -- read-only
153                    }
154    MAX-ACCESS      read-write
155    STATUS          current
156    DESCRIPTION
157        "Specifies the state of the bandwidth oversubscription
158        feature for this module.
159
160        enabledOnAllPortGroups --
161                           the bandwidth oversubscription feature
162                           is enabled on all port groups of this
163                           module.
164
165        disabledOnAllPortGroups --
166                           the bandwidth oversubscription feature
167                           is disabled on all port groups of this
168                           module.
169
170        portGroupSpecific --
171                           the bandwidth oversubscription feature
172                           is enabled on some port groups of this
173                           module while being disabled at the
174                           remaining port groups of this module.
175                           This value is a read-only value and
176                           can not be set on any instance of
177                           this object.
178
179        This object will only be configurable when the
180        instance value of chmcOversubModuleCapabilities of this
181        entry has the 'oversubConfigModuleLevel' bit set to 1."
182    ::= { chmcOversubModuleEntry 2 }
183
184
185
186chmcOversubPortGroupTable OBJECT-TYPE
187    SYNTAX          SEQUENCE OF ChmcOversubPortGroupEntry
188    MAX-ACCESS      not-accessible
189    STATUS          current
190    DESCRIPTION
191        "Contains information for managing bandwidth
192        oversubscription and clearing of HoL blocking
193        features for port groups of the physical modules
194        capable of providing bandwidth oversubscription
195        feature."
196    ::= { chmcOversubscription 2 }
197
198chmcOversubPortGroupEntry OBJECT-TYPE
199    SYNTAX          ChmcOversubPortGroupEntry
200    MAX-ACCESS      not-accessible
201    STATUS          current
202    DESCRIPTION
203        "Each entry contains management information for a
204        specific port group on a specific physical module as
205        indicated by the value of entPhysicalIndex, which is
206        capable of providing bandwidth oversubscription feature."
207    INDEX           {
208                        entPhysicalIndex,
209                        chmcOversubPortGrpIndex
210                    }
211    ::= { chmcOversubPortGroupTable 1 }
212
213ChmcOversubPortGroupEntry ::= SEQUENCE {
214        chmcOversubPortGrpIndex          Unsigned32,
215        chmcOversubPortGrpIfIndexList    CiscoInterfaceIndexList,
216        chmcOversubPortGrpOversubStatus  INTEGER,
217        chmcOversubPortGrpClearBlkStatus INTEGER
218}
219
220chmcOversubPortGrpIndex OBJECT-TYPE
221    SYNTAX          Unsigned32 (1..4294967295)
222    MAX-ACCESS      not-accessible
223    STATUS          current
224    DESCRIPTION
225        "A unique value assigned to a specific port group on a
226        module."
227    ::= { chmcOversubPortGroupEntry 1 }
228
229chmcOversubPortGrpIfIndexList OBJECT-TYPE
230    SYNTAX          CiscoInterfaceIndexList
231    MAX-ACCESS      read-only
232    STATUS          current
233    DESCRIPTION
234        "Contains ifIndex values for the list of the ports in
235        the port group."
236    ::= { chmcOversubPortGroupEntry 2 }
237
238chmcOversubPortGrpOversubStatus OBJECT-TYPE
239    SYNTAX          INTEGER  {
240                        other(1), -- read-only
241                        enabled(2),
242                        disabled(3)
243                    }
244    MAX-ACCESS      read-write
245    STATUS          current
246    DESCRIPTION
247        "Specifies the state of the bandwidth oversubscription
248        feature on this port group.
249
250        other     - none of the following. This value is a
251                    read-only value and can not be set on
252                    any instance of this object.
253
254        enabled   - this port group is enabled to operate
255                    in bandwidth oversubscription mode.
256
257        disabled  - this port group is disabled to operate
258                    in bandwidth oversubscription mode. The
259                    first port indicated by the first four
260                    bytes of the value of
261                    chmcOversubPortGrpIfIndexList of this
262                    port group will keep its administrative
263                    status and the remaining ports of this port
264                    group will be administratively shut down.
265
266        This object will only be configurable when the instance value
267        of chmcOversubModuleCapabilities for the corresponding module
268        has the 'oversubConfigPortGroupLevel' bit set to 1."
269    ::= { chmcOversubPortGroupEntry 3 }
270
271chmcOversubPortGrpClearBlkStatus OBJECT-TYPE
272    SYNTAX          INTEGER  {
273                        other(1), -- read-only
274                        enabled(2),
275                        disabled(3)
276                    }
277    MAX-ACCESS      read-write
278    STATUS          current
279    DESCRIPTION
280        "Specifies the state of the clearing of HoL blocking
281        feature on this port group.
282
283        other     - none of the following. This value is a
284                    read-only value and can not be set on
285                    any instance of this object.
286
287        enabled   - the clearing of HoL blocking feature is
288                    enabled.
289
290        disabled  - the clearing of HoL blocking feature
291                    is disabled.
292
293        This object will only take effect when the instance value
294        of chmcOversubPortGrpOversubStatus of this entry is 'enabled'.
295
296        This object will only be configurable when the instance
297        value of chmcOversubPortGrpOversubStatus of this entry is
298        'enabled' and the instance value of
299        chmcOversubModuleCapabilities for the corresponding module
300        has the 'clearblockConfigPortGroupLevel' bit set to 1."
301    ::= { chmcOversubPortGroupEntry 4 }
302
303-- The hw-module operational mode group
304
305chmcOperModePortGroupTable OBJECT-TYPE
306    SYNTAX          SEQUENCE OF ChmcOperModePortGroupEntry
307    MAX-ACCESS      not-accessible
308    STATUS          current
309    DESCRIPTION
310        "Contains information for managing operational mode
311        features for port groups of the physical modules
312        capable of providing operational mode configuration."
313    ::= { chmcOperationalMode 1 }
314
315chmcOperModePortGroupEntry OBJECT-TYPE
316    SYNTAX          ChmcOperModePortGroupEntry
317    MAX-ACCESS      not-accessible
318    STATUS          current
319    DESCRIPTION
320        "Each entry contains operational mode information for a
321        specific port group on a specific physical module as
322        indicated by the value of entPhysicalIndex, which is
323        capable of providing operational mode configuration."
324    INDEX           {
325                        entPhysicalIndex,
326                        chmcOperModePortGrpIndex
327                    }
328    ::= { chmcOperModePortGroupTable 1 }
329
330ChmcOperModePortGroupEntry ::= SEQUENCE {
331        chmcOperModePortGrpIndex          Unsigned32,
332        chmcOperModePortGrpOperMode       INTEGER,
333        chmcOperModePortGrpIfIndexList    CiscoInterfaceIndexList
334}
335
336chmcOperModePortGrpIndex OBJECT-TYPE
337    SYNTAX          Unsigned32 (1..4294967295)
338    MAX-ACCESS      not-accessible
339    STATUS          current
340    DESCRIPTION
341        "A unique value assigned to a specific port group on a
342        module."
343    ::= { chmcOperModePortGroupEntry 1 }
344
345chmcOperModePortGrpOperMode OBJECT-TYPE
346    SYNTAX          INTEGER  {
347                        other(1), -- read-only
348                        tenGigabitEthernet(2),
349                        fortyGigabitEthernet(3)
350                    }
351    MAX-ACCESS      read-write
352    STATUS          current
353    DESCRIPTION
354        "Specifies the operational mode of the port group.
355
356        other     - none of the following. This value is a
357                    read-only value and can not be set on
358                    any instance of this object.
359
360        tenGigabitEthernet   - this port group is operated with
361                               10 Gigibit Ethernet port mode.
362
363        forthGigabitEthernet - this port group is operated with
364                               40 Gigabit Ethernet port mode.
365
366        Modification on the instance value of this object may cause
367        the corresponding module to be reset."
368    ::= { chmcOperModePortGroupEntry 2 }
369
370chmcOperModePortGrpIfIndexList OBJECT-TYPE
371    SYNTAX          CiscoInterfaceIndexList
372    MAX-ACCESS      read-only
373    STATUS          current
374    DESCRIPTION
375        "Contains ifIndex values for the list of the ports in
376        the port group. The instance value of this object may be
377        changed  after modification on the corresponding instance
378        value of chmcOperModePortGrpOperMode."
379    ::= { chmcOperModePortGroupEntry 3 }
380
381
382-- Conformance information
383
384chmcHwModuleControlMIBCompliances  OBJECT IDENTIFIER
385    ::= { ciscoHwModuleControlMIBConform 1 }
386
387chmcHwModuleControlMIBGroups  OBJECT IDENTIFIER
388    ::= { ciscoHwModuleControlMIBConform 2 }
389
390
391-- Compliance statements
392
393chmcHwModuleControlMIBCompliance MODULE-COMPLIANCE
394    STATUS          deprecated
395    DESCRIPTION
396        "The compliance statement for CISCO-HW-MODULE-CONTROL-MIB."
397    MODULE          -- this module
398    GROUP           ciscoHmcMIBOversubBaseGroup
399    DESCRIPTION
400        "This group is mandatory for devices that support either
401        the bandwidth oversubscription feature alone or both the
402        bandwidth oversubscription and the clearing of HoL
403        blocking feature."
404
405    GROUP           ciscoHmcMIBOversubPgClearBlkGrp
406    DESCRIPTION
407        "This group is mandatory for devices that support the
408        clearing of HoL blocking feature."
409
410    OBJECT          chmcOversubModOversubStatus
411    MIN-ACCESS      read-only
412    DESCRIPTION
413        "Write access is not required."
414
415    OBJECT          chmcOversubPortGrpOversubStatus
416    MIN-ACCESS      read-only
417    DESCRIPTION
418        "Write access is not required."
419
420    OBJECT          chmcOversubPortGrpClearBlkStatus
421    MIN-ACCESS      read-only
422    DESCRIPTION
423        "Write access is not required."
424    ::= { chmcHwModuleControlMIBCompliances 1 }
425
426chmcHwModuleControlMIBCompliance1 MODULE-COMPLIANCE
427    STATUS          current
428    DESCRIPTION
429        "The compliance statement for CISCO-HW-MODULE-CONTROL-MIB."
430    MODULE          -- this module
431    GROUP           ciscoHmcMIBOversubBaseGroup
432    DESCRIPTION
433        "This group is mandatory for devices that support either
434        the bandwidth oversubscription feature alone or both the
435        bandwidth oversubscription and the clearing of HoL
436        blocking feature."
437
438    GROUP           ciscoHmcMIBOversubPgClearBlkGrp
439    DESCRIPTION
440        "This group is mandatory for devices that support the
441        clearing of HoL blocking feature."
442
443    GROUP           ciscoHmcMIBOperModeGroup
444    DESCRIPTION
445        "This group is mandatory for devices that supports the
446        port group operational mode feature."
447
448    OBJECT          chmcOversubModOversubStatus
449    MIN-ACCESS      read-only
450    DESCRIPTION
451        "Write access is not required."
452
453    OBJECT          chmcOversubPortGrpOversubStatus
454    MIN-ACCESS      read-only
455    DESCRIPTION
456        "Write access is not required."
457
458    OBJECT          chmcOversubPortGrpClearBlkStatus
459    MIN-ACCESS      read-only
460    DESCRIPTION
461        "Write access is not required."
462
463    OBJECT          chmcOperModePortGrpOperMode
464    MIN-ACCESS      read-only
465    DESCRIPTION
466        "Write access is not required."
467
468    ::= { chmcHwModuleControlMIBCompliances 2 }
469
470-- Units of Conformance
471
472ciscoHmcMIBOversubBaseGroup OBJECT-GROUP
473    OBJECTS         {
474                        chmcOversubModuleCapabilities,
475                        chmcOversubModOversubStatus,
476                        chmcOversubPortGrpIfIndexList,
477                        chmcOversubPortGrpOversubStatus
478                    }
479    STATUS          current
480    DESCRIPTION
481        "A collection of objects providing information about
482        the bandwidth oversubscription and/or clearing of HoL
483        blocking features for hardware modules capable of
484        providing such features."
485    ::= { chmcHwModuleControlMIBGroups 1 }
486
487ciscoHmcMIBOversubPgClearBlkGrp OBJECT-GROUP
488    OBJECTS         { chmcOversubPortGrpClearBlkStatus }
489    STATUS          current
490    DESCRIPTION
491        "A collection of objects describing the clearing
492        of HoL blocking support at port group level for
493        each hardware module capable of providing such
494        feature."
495    ::= { chmcHwModuleControlMIBGroups 2 }
496
497ciscoHmcMIBOperModeGroup OBJECT-GROUP
498    OBJECTS         {
499                        chmcOperModePortGrpOperMode,
500                        chmcOperModePortGrpIfIndexList
501                    }
502    STATUS          current
503    DESCRIPTION
504        "A collection of objects providing the operational
505        mode information at port group level for each
506        physical module capable of providing such feature."
507    ::= { chmcHwModuleControlMIBGroups 3 }
508
509END
510