1-- *****************************************************************
2-- CISCO-INTERFACETOPN-EXT-MIB
3--
4-- July 2005, Lilian Jiang
5--
6-- Copyright (c) 2005, 2010 by Cisco Systems Inc.
7-- All rights reserved.
8-- *****************************************************************
9
10CISCO-INTERFACETOPN-EXT-MIB DEFINITIONS ::= BEGIN
11
12IMPORTS
13    MODULE-IDENTITY,
14    OBJECT-TYPE
15        FROM SNMPv2-SMI
16    MODULE-COMPLIANCE,
17    OBJECT-GROUP
18        FROM SNMPv2-CONF
19    ciscoMgmt
20        FROM CISCO-SMI
21    interfaceTopNControlEntry
22        FROM INTERFACETOPN-MIB
23    VlanIndex
24        FROM Q-BRIDGE-MIB;
25
26
27ciscoInterfaceTopNExtMIB MODULE-IDENTITY
28    LAST-UPDATED    "201010190000Z"
29    ORGANIZATION    "Cisco Systems, Inc."
30    CONTACT-INFO
31            "Cisco Systems
32            Customer Service
33
34            Postal: 170 W Tasman Drive
35            San Jose, CA  95134
36            USA
37
38            Tel: +1 800 553-NETS
39
40            E-mail: cs-lan-switch-snmp@cisco.com"
41    DESCRIPTION
42        "This MIB module is an extension to INTERFACETOPN-MIB.
43        It provides additional management information for
44        sorting device interfaces."
45    REVISION        "201010190000Z"
46    DESCRIPTION
47        "Add fortyGigaEthernet
48        in citneInterfaceTopNInterfaceType"
49    REVISION        "200801150000Z"
50    DESCRIPTION
51        "Modified the object descriptions of
52        citneInterfaceTopNCounterType,
53        citneInterfaceTopNInterfaceType
54        and citneInterfaceTopNVlanNumber."
55    REVISION        "200603150000Z"
56    DESCRIPTION
57        "Initial version of this MIB module."
58    ::= { ciscoMgmt 482 }
59
60
61ciscoInterfaceTopNExtMIBNotifs  OBJECT IDENTIFIER
62    ::= { ciscoInterfaceTopNExtMIB 0 }
63
64ciscoInterfaceTopNExtMIBObjects  OBJECT IDENTIFIER
65    ::= { ciscoInterfaceTopNExtMIB 1 }
66
67ciscoInterfaceTopNExtMIBConform  OBJECT IDENTIFIER
68    ::= { ciscoInterfaceTopNExtMIB 2 }
69
70
71-- Interface Top N capability
72
73citneInterfaceTopNCaps OBJECT-TYPE
74    SYNTAX          BITS {
75                        utilization(0),
76                        bytes(1),
77                        packets(2),
78                        broadcast(3),
79                        multicast(4),
80                        overflow(5)
81                    }
82    MAX-ACCESS      read-only
83    STATUS          current
84    DESCRIPTION
85        "The type of interface counters the system is capable to
86        do sorting on, as an extension to the interfaceTopNCaps
87        defined in INTERFACETOPN-MIB.
88
89        utilization --  The interface bandwidth utilization in
90                        32-bit version. The utilization on
91                        ethernet interface is computed in the
92                        following methods:
93
94          Ethernet utilization: (for full duplex interface,
95                                 divide by 2)
96
97          10 Mbps         I/O-pkts * (9.6 + 6.4) + (0.8 * I/O-Bytes)
98          Ethernet Util = -----------------------------------------
99                          Interval * 10,000
100
101                          where 9.6 is interframe gap of Ethernet
102                          6.4 is preamble of Ethernet
103                          10,000 is 10Mbps
104
105          100 Mbps        I/O-pkts * (96 + 64) + (8 * I/O-Bytes)
106          Ethernet Util = --------------------------------------
107                          Interval * 1,000,000
108
109          1000 Mbps       I/O-pkts * (96 + 64) + (8 * I/O-Bytes)
110          Ethernet Util = --------------------------------------
111                          Interval * 10,000,000
112
113          10000Mbps       I/O-pkts * (96 + 64) + (8 * I/O-Bytes)
114          Ethernet Util = --------------------------------------
115                          Interval * 100,000,000
116
117          All other       I/O-pkts * (9.6 + 6.4) + (0.8 * I/O-Bytes)
118          Ethernet Util = ------------------------------------------
119                          Interval * N * 1,000
120                          (where N is N Mbps)
121
122        bytes -- the total number of bytes received and transmitted
123                 on the interface in 64-bit version.
124
125        packets -- the total number of packets received and
126                 transmitted on  the interface in 64-bit version.
127
128        broadcast -- the total number of broadcast packets received
129                 and transmitted on the interface in 64-bit version.
130
131        multicast -- the total number of multicast packets received
132                 and transmitted on the interface in 64-bit version.
133
134        overflow -- the total number of transmitted buffer overflow
135                 errors on the interface in 32-bit version."
136    ::= { ciscoInterfaceTopNExtMIBObjects 1 }
137-- Interface Top N Control Table
138
139citneInterfaceTopNControlTable OBJECT-TYPE
140    SYNTAX          SEQUENCE OF CitneInterfaceTopNControlEntry
141    MAX-ACCESS      not-accessible
142    STATUS          current
143    DESCRIPTION
144        "A table providing supplemental parameter information
145        for interfaceTopNControlTable as defined in
146        INTERFACETOPN-MIB."
147    ::= { ciscoInterfaceTopNExtMIBObjects 2 }
148
149citneInterfaceTopNControlEntry OBJECT-TYPE
150    SYNTAX          CitneInterfaceTopNControlEntry
151    MAX-ACCESS      not-accessible
152    STATUS          current
153    DESCRIPTION
154        "An entry providing supplemental parameter information
155        that control the creation of a report of the top
156        N ports according to several metrics."
157    AUGMENTS           { interfaceTopNControlEntry  }
158    ::= { citneInterfaceTopNControlTable 1 }
159
160CitneInterfaceTopNControlEntry ::= SEQUENCE {
161        citneInterfaceTopNCounterType   INTEGER,
162        citneInterfaceTopNInterfaceType INTEGER,
163        citneInterfaceTopNVlanNumber    VlanIndex
164}
165
166citneInterfaceTopNCounterType OBJECT-TYPE
167    SYNTAX          INTEGER  {
168                        none(1),
169                        utilization(2),
170                        bytes(3),
171                        packets(4),
172                        broadcast(5),
173                        multicast(6),
174                        overflow(7)
175                    }
176    MAX-ACCESS      read-create
177    STATUS          current
178    DESCRIPTION
179        "The particular counter type to be sampled, as
180        an extension to the interfaceTopNObjectVariable
181        defined in INTERFACETOPN-MIB.
182
183        Setting this object to the value of 'none' indicates
184        that the TopN sampling is based on the counter type
185        as specified by the corresponding
186        interfaceTopNObjectVariable for the same entry
187        in interfaceTopNControlTable; Setting this object
188        to a value other than 'none' indicates that the
189        TopN sampling is based on the counter type as
190        specified by this object instead of the
191        counter type as specified by the
192        corresponding interfaceTopNObjectVariable for
193        the same entry in interfaceTopNControlTable.
194
195        For entries in the interfaceTopNTable in the
196        INTERFACETOPN-MIB reported for counter type as specified
197        by this citneInterfaceTopNCounterType:
198        (1) The corresponding interfaceTopNDataSourceIndex will
199            point to the ifIndex of the sorted interfaces;
200        (2) If the sampled counter type is one of the following
201            32 bit counters:
202                   'utilization',
203                   'overflow',
204            the interfaceTopNValue object is used in
205            the corresponding entries in interfaceTopNTable.
206
207            If the sampled counter type is one of the following
208            64 bit counters:
209                   'bytes',
210                   'packets',
211                   'broadcast',
212                   'multicast',
213            the interfaceTopNValue64 object is used
214            in the corresponding entries in interfaceTopNTable.
215
216        This object may not be modified if the associated
217        interfaceTopNRowStatus object is equal to 'active'."
218    DEFVAL          { none }
219    ::= { citneInterfaceTopNControlEntry 1 }
220
221citneInterfaceTopNInterfaceType OBJECT-TYPE
222    SYNTAX          INTEGER  {
223                        all(1),
224                        ethernet(2),
225                        fastEthernet(3),
226                        gigaEthernet(4),
227                        tenGigaEthernet(5),
228                        portChannel(6),
229                        layer2(7),
230                        layer3(8),
231                        fortyGigaEthernet(9)
232                    }
233    MAX-ACCESS      read-create
234    STATUS          current
235    DESCRIPTION
236        "Specifies the interface type for the TopN sampling.
237
238        all -- all applicable interfaces in the system.
239
240        ethernet -- all Ethernet interfaces in the system.
241
242        fastEthernet -- all FastEthernet interfaces in the system.
243
244        gigaEthernet -- all GigabitEthernet interfaces in the
245                        system.
246
247        tenGigaEthernet -- all TenGigabitEthernet interfaces
248                           in the system.
249
250        portChannel -- all Port-channel interfaces in the system.
251
252        layer2 -- all layer-2 interfaces in the system.
253
254        layer3 -- all layer-3 interfaces in the system.
255
256        fortyGigaEthernet -- all FortyGigabitEthernet interfaces
257                           in the system.
258
259        This object may not be modified if the associated
260        interfaceTopNRowStatus object is equal to 'active'."
261    DEFVAL          { all }
262    ::= { citneInterfaceTopNControlEntry 2 }
263
264citneInterfaceTopNVlanNumber OBJECT-TYPE
265    SYNTAX          VlanIndex
266    MAX-ACCESS      read-create
267    STATUS          current
268    DESCRIPTION
269        "Specifies the Vlan number for the layer-2 interfaces when
270        the object value of citneInterfaceTopNInterfaceType
271        for the same entry is 'layer2'. If the object value
272        of citneInterfaceTopNVlanNumber is other than zero and
273        the corresponding citneInterfaceTopNInterfaceType is
274        'layer2' for the same entry, then it indicates all
275        layer-2 interfaces in that VLAN is sampled.  If the
276        object value of citneInterfaceTopNVlanNumber is zero
277        and the corresponding citneInterfaceTopNInterfaceType
278        is 'layer2' for the same entry, then it indicates all
279        layer-2 interfaces in the system regardless of their
280        Vlan number is sampled. If the object value of
281        citneInterfaceTopNInterfaceType is other than
282        'layer2', then citneInterfaceTopNVlanNumber has to take
283        the value of 0.
284
285        This object may not be modified if the associated
286        interfaceTopNRowStatus object is equal to 'active'."
287    DEFVAL          { 0 }
288    ::= { citneInterfaceTopNControlEntry 3 }
289
290
291-- Notifications
292-- (none defined)
293--
294-- Conformance
295
296ciscoIfTopNExtMIBCompliances  OBJECT IDENTIFIER
297    ::= { ciscoInterfaceTopNExtMIBConform 1 }
298
299ciscoIfTopNExtMIBGroups  OBJECT IDENTIFIER
300    ::= { ciscoInterfaceTopNExtMIBConform 2 }
301
302
303ciscoIfTopNExtMIBCompliance MODULE-COMPLIANCE
304    STATUS          current
305    DESCRIPTION
306        "Describes the requirements for conformance to the
307        Cisco InterfaceTopN Extention MIB."
308    MODULE          -- this module
309    MANDATORY-GROUPS { ciscoIfTopNExtCapsGroup }
310
311    GROUP           ciscoIfTopNExtControlGroup
312    DESCRIPTION
313        "This group is mandatory for systems which support
314        the supplemental parameters for the
315        interfaceTopNControlTable."
316
317    GROUP           ciscoIfTopNExtCtrlVlanGroup
318    DESCRIPTION
319        "This group is mandatory for systems which support
320        the supplemental vlan parameters for the
321        interfaceTopNControlTable."
322    ::= { ciscoIfTopNExtMIBCompliances 1 }
323
324-- Units of Conformance
325
326ciscoIfTopNExtCapsGroup OBJECT-GROUP
327    OBJECTS         { citneInterfaceTopNCaps }
328    STATUS          current
329    DESCRIPTION
330        "A collection of objects providing capability information
331        about supplemental counter type supported by the system."
332    ::= { ciscoIfTopNExtMIBGroups 1 }
333
334ciscoIfTopNExtControlGroup OBJECT-GROUP
335    OBJECTS         {
336                        citneInterfaceTopNCounterType,
337                        citneInterfaceTopNInterfaceType
338                    }
339    STATUS          current
340    DESCRIPTION
341        "A collection of objects providing information about
342        supplemental parameters for the
343        interfaceTopNControlTable."
344    ::= { ciscoIfTopNExtMIBGroups 2 }
345
346ciscoIfTopNExtCtrlVlanGroup OBJECT-GROUP
347    OBJECTS         { citneInterfaceTopNVlanNumber }
348    STATUS          current
349    DESCRIPTION
350        "A collection of objects providing information about
351        supplemental vlan parameters for the
352        interfaceTopNControlTable."
353    ::= { ciscoIfTopNExtMIBGroups 3 }
354
355END
356
357
358
359