3 Copyright (C) 2002 Stanislav Sinyagin
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
19 $Id: rfc2863.if-mib.xml,v 1.1 2010-12-27 00:04:30 ivan Exp $
20 Stanislav Sinyagin <ssinyagin@yahoo.com>
25 RFC2863 IF-MIB definitions
31 <!-- Parameters which are included in search DB -->
32 <prop param="interface-name" prop="search" value="1"/>
33 <prop param="interface-macaddr" prop="search" value="1"/>
34 <prop param="interface-macaddr" prop="search" value="1"/>
35 <prop param="interface-nick" prop="search" value="1"/>
41 <!-- IF-MIB:ifTable -->
42 <def name="ifDescr" value="1.3.6.1.2.1.2.2.1.2" />
43 <def name="ifSpeed" value="1.3.6.1.2.1.2.2.1.5" />
44 <def name="ifPhysAddress" value="1.3.6.1.2.1.2.2.1.6" />
45 <def name="ifInOctets" value="1.3.6.1.2.1.2.2.1.10" />
46 <def name="ifInUcastPkts" value="1.3.6.1.2.1.2.2.1.11" />
47 <def name="ifInDiscards" value="1.3.6.1.2.1.2.2.1.13" />
48 <def name="ifInErrors" value="1.3.6.1.2.1.2.2.1.14" />
49 <def name="ifOutOctets" value="1.3.6.1.2.1.2.2.1.16" />
50 <def name="ifOutUcastPkts" value="1.3.6.1.2.1.2.2.1.17" />
51 <def name="ifOutDiscards" value="1.3.6.1.2.1.2.2.1.19" />
52 <def name="ifOutErrors" value="1.3.6.1.2.1.2.2.1.20" />
54 <!-- IF-MIB:ifXTable -->
55 <def name="ifName" value="1.3.6.1.2.1.31.1.1.1.1" />
56 <def name="ifHCInOctets" value="1.3.6.1.2.1.31.1.1.1.6" />
57 <def name="ifHCInUcastPkts" value="1.3.6.1.2.1.31.1.1.1.7" />
58 <def name="ifHCOutOctets" value="1.3.6.1.2.1.31.1.1.1.10" />
59 <def name="ifHCOutUcastPkts" value="1.3.6.1.2.1.31.1.1.1.11" />
61 <!-- RFC1213-MIB:ipAddrTable -->
62 <def name="ipAdEntIfIndex" value="1.3.6.1.2.1.4.20.1.2" />
64 <!-- Interface indices -->
65 <def name="IFIDX_DESCR" value="M($ifDescr, %interface-name%)" />
66 <def name="IFIDX_MAC" value="M($ifPhysAddress, %interface-macaddr%)" />
67 <def name="IFIDX_IP" value="V(ipAdEntIfIndex.%interface-ipaddr%)" />
68 <def name="IFIDX_IFINDEX" value="%interface-index%" />
74 <!-- Some parameters need to be at host level -->
75 <template name="rfc2863-ifmib-hostlevel">
76 <param name="ifindex-map" value="M(%ifindex-table%, %interface-name%)"/>
77 <param name="ifindex-table" value="$ifDescr" />
79 <!-- nodeid-interface is overwritten by devdiscover at the
80 interface level. This definition is here for backward compatibility
81 with older discovery results or for systems which do not use
83 <param name="nodeid-interface"
84 value="if//%nodeid-device%//%interface-nick%//"/>
88 <!-- Parameters for interfaces parent subtree -->
89 <template name="rfc2863-ifmib-subtree">
90 <param name="node-display-name" value="Interfaces"/>
91 <param name="comment" value="Interface traffic and error counters"/>
93 <param name="has-overview-shortcuts" value="yes"/>
94 <param name="overview-shortcuts" value="traffic,errors"/>
96 <param name="overview-subleave-name-traffic" value="InOut_bps"/>
97 <param name="overview-shortcut-text-traffic"
99 <param name="overview-shortcut-title-traffic"
100 value="Show traffic for all interfaces on one page"/>
101 <param name="overview-page-title-traffic"
102 value="Input/Output Graphs"/>
104 <param name="overview-subleave-name-errors"
105 value="Discards_In,Discards_Out,Errors_In,Errors_Out"/>
106 <param name="overview-shortcut-text-errors"
108 <param name="overview-shortcut-title-errors"
109 value="Show all interface errors on one page"/>
110 <param name="overview-page-title-errors"
111 value="Interface errors"/>
113 <param name="overview-subleave-name-bandwidth"
114 value="Bandwidth_Usage"/>
115 <param name="overview-shortcut-text-bandwidth"
116 value="All bandwidth"/>
117 <param name="overview-shortcut-title-bandwidth"
118 value="Show all bandwidth usage on one page"/>
119 <param name="overview-page-title-bandwidth"
120 value="Bandwidth usage"/>
122 <param name="descriptive-nickname" value="%system-id%:%interface-name%"/>
123 <param name="data-file" value="%system-id%_%interface-nick%_if-mib.rrd" />
124 <param name="graph-title" value="%descriptive-nickname%" />
125 <param name="collector-timeoffset-hashstring"
126 value="%system-id%:%interface-nick%" />
127 <param name="help-text">
128 The default view shows the device's network interfaces for which
129 the traffic statistics are available. Expanded view can be seen by
130 clicking the [%em('Show InOut_bps for all interfaces')%] shortcut.
131 It would show input/output graphs for all interfaces on a single page.
135 <template name="iftable-octets">
136 <leaf name="Bytes_In">
137 <param name="snmp-object" value="$ifInOctets.%ifindex-map%" />
138 <param name="rrd-ds" value="ifInOctets" />
139 <param name="rrd-create-dstype" value="COUNTER" />
140 <param name="ext-dstype" value="COUNTER32" />
141 <param name="comment" value="Input byte counter for the interface" />
142 <param name="graph-legend" value="Bytes in" />
143 <param name="vertical-label" value="Bps" />
144 <param name="graph-lower-limit" value="0" />
145 <param name="precedence" value="990" />
146 <param name="monitor-action-target" value="InOut_bps"/>
147 <param name="nodeid" value="%nodeid-interface%//inbytes"/>
150 <leaf name="Bytes_Out">
151 <param name="snmp-object" value="$ifOutOctets.%ifindex-map%" />
152 <param name="rrd-ds" value="ifOutOctets" />
153 <param name="rrd-create-dstype" value="COUNTER" />
154 <param name="ext-dstype" value="COUNTER32" />
155 <param name="comment" value="Output byte counter for the interface" />
156 <param name="graph-legend" value="Bytes out" />
157 <param name="vertical-label" value="Bps" />
158 <param name="graph-lower-limit" value="0" />
159 <param name="precedence" value="980" />
160 <param name="monitor-action-target" value="InOut_bps"/>
161 <param name="nodeid" value="%nodeid-interface%//outbytes"/>
164 <leaf name="InOut_bps">
165 <param name="comment" value="Input and Output bits per second graphs" />
166 <param name="vertical-label" value="bps" />
167 <param name="graph-lower-limit" value="0" />
168 <param name="rrd-hwpredict" value="disabled" />
169 <param name="precedence" value="1000" />
170 <param name="nodeid" value="%nodeid-interface%//inoutbit"/>
171 <param name="ds-type" value="rrd-multigraph" />
172 <param name="ds-names" value="in,out" />
174 <param name="ds-expr-in" value="{Bytes_In},8,*" />
175 <param name="graph-legend-in" value="Bits per second in" />
176 <param name="line-style-in" value="##BpsIn" />
177 <param name="line-color-in" value="##BpsIn" />
178 <param name="line-order-in" value="1" />
180 <param name="ds-expr-out" value="{Bytes_Out},8,*" />
181 <param name="graph-legend-out" value="Bits per second out" />
182 <param name="line-style-out" value="##BpsOut" />
183 <param name="line-color-out" value="##BpsOut" />
184 <param name="line-order-out" value="2" />
188 <!-- Some interface instances (e.g. serial subinterfaces in Coisco routers)
189 don't have UcastPkts and Errors counters -->
191 <template name="iftable-ucast-packets">
192 <leaf name="Packets_In">
193 <param name="snmp-object" value="$ifInUcastPkts.%ifindex-map%" />
194 <param name="rrd-ds" value="ifInUcastPkts" />
195 <param name="rrd-create-dstype" value="COUNTER" />
196 <param name="comment" value="Input packet counter for the interface" />
197 <param name="graph-legend" value="Packets in" />
198 <param name="vertical-label" value="pps" />
199 <param name="graph-lower-limit" value="0" />
200 <param name="precedence" value="890" />
201 <param name="nodeid" value="%nodeid-interface%//inpackets"/>
204 <leaf name="Packets_Out">
205 <param name="snmp-object" value="$ifOutUcastPkts.%ifindex-map%" />
206 <param name="rrd-ds" value="ifOutUcastPkts" />
207 <param name="rrd-create-dstype" value="COUNTER" />
208 <param name="comment" value="Output packet counter for the interface" />
209 <param name="graph-legend" value="Packets out" />
210 <param name="vertical-label" value="pps" />
211 <param name="graph-lower-limit" value="0" />
212 <param name="precedence" value="880" />
213 <param name="nodeid" value="%nodeid-interface%//outpackets"/>
217 <template name="iftable-discards-in">
218 <leaf name="Discards_In">
219 <param name="snmp-object" value="$ifInDiscards.%ifindex-map%" />
220 <param name="rrd-ds" value="ifInDiscards" />
221 <param name="rrd-create-dstype" value="COUNTER" />
222 <param name="rrd-hwpredict" value="disabled" />
223 <param name="comment" value="Input discards for the interface" />
224 <param name="graph-legend" value="Discards in" />
225 <param name="vertical-label" value="pps" />
226 <param name="graph-lower-limit" value="0" />
227 <param name="precedence" value="790" />
228 <param name="nodeid" value="%nodeid-interface%//indrops"/>
229 <param name="help-text">
230 Input discards may occur when the packets arrive from the interface
231 media, and the router is not able to process them. This can possibly
232 occur because of performance problems.
237 <template name="iftable-discards-out">
238 <leaf name="Discards_Out">
239 <param name="snmp-object" value="$ifOutDiscards.%ifindex-map%" />
240 <param name="rrd-ds" value="ifOutDiscards" />
241 <param name="rrd-create-dstype" value="COUNTER" />
242 <param name="rrd-hwpredict" value="disabled" />
243 <param name="comment" value="Output discards for the interface" />
244 <param name="graph-legend" value="Discards out" />
245 <param name="vertical-label" value="pps" />
246 <param name="graph-lower-limit" value="0" />
247 <param name="precedence" value="780" />
248 <param name="nodeid" value="%nodeid-interface%//outdrops"/>
249 <param name="help-text">
250 Output discards may occur when the router has prepared packets for
251 transmission, but the interface is not able to send them. This
252 may happen because of not enough available bandwidth on
253 the output interface.
258 <template name="iftable-errors-in">
259 <leaf name="Errors_In">
260 <param name="snmp-object" value="$ifInErrors.%ifindex-map%" />
261 <param name="rrd-ds" value="ifInErrors" />
262 <param name="rrd-create-dstype" value="COUNTER" />
263 <param name="rrd-hwpredict" value="disabled" />
264 <param name="comment" value="Input errors for the interface" />
265 <param name="graph-legend" value="Errors in" />
266 <param name="vertical-label" value="pps" />
267 <param name="graph-lower-limit" value="0" />
268 <param name="precedence" value="690" />
269 <param name="nodeid" value="%nodeid-interface%//inerr"/>
270 <param name="help-text">
271 Input errors usually mean that the interface receives broken packets
272 from the media. This migh be caused by problems with the physical
273 condition of the transmission media, or elecrical interference.
278 <template name="iftable-errors-out">
279 <leaf name="Errors_Out">
280 <param name="snmp-object" value="$ifOutErrors.%ifindex-map%" />
281 <param name="rrd-ds" value="ifOutErrors" />
282 <param name="rrd-create-dstype" value="COUNTER" />
283 <param name="rrd-hwpredict" value="disabled" />
284 <param name="comment" value="Output errors for the interface" />
285 <param name="graph-legend" value="Errors out" />
286 <param name="vertical-label" value="pps" />
287 <param name="graph-lower-limit" value="0" />
288 <param name="precedence" value="680" />
289 <param name="nodeid" value="%nodeid-interface%//outerr"/>
290 <param name="help-text">
291 Output errors occur when the interface is not able to send packets
292 to the media for some reasons.
298 <template name="ifxtable-hcoctets">
299 <leaf name="Bytes_In">
300 <param name="snmp-object" value="$ifHCInOctets.%ifindex-map%" />
301 <param name="snmp-object-type" value="COUNTER64" />
302 <param name="rrd-ds" value="ifHCInOctets" />
303 <param name="rrd-create-dstype" value="COUNTER" />
304 <param name="ext-dstype" value="COUNTER64" />
305 <param name="rrd-create-max" value="1e15"/>
306 <param name="ext-counter-max" value="1e15"/>
307 <param name="comment" value="Input byte counter for the interface" />
308 <param name="graph-legend" value="Bytes in" />
309 <param name="vertical-label" value="Bps" />
310 <param name="graph-lower-limit" value="0" />
311 <param name="precedence" value="990" />
312 <param name="monitor-action-target" value="InOut_bps"/>
313 <param name="nodeid" value="%nodeid-interface%//inbytes"/>
316 <leaf name="Bytes_Out">
317 <param name="snmp-object" value="$ifHCOutOctets.%ifindex-map%" />
318 <param name="snmp-object-type" value="COUNTER64" />
319 <param name="rrd-ds" value="ifHCOutOctets" />
320 <param name="rrd-create-dstype" value="COUNTER" />
321 <param name="ext-dstype" value="COUNTER64" />
322 <param name="rrd-create-max" value="1e15"/>
323 <param name="ext-counter-max" value="1e15"/>
324 <param name="comment" value="Output byte counter for the interface" />
325 <param name="graph-legend" value="Bytes out" />
326 <param name="vertical-label" value="Bps" />
327 <param name="graph-lower-limit" value="0" />
328 <param name="precedence" value="980" />
329 <param name="monitor-action-target" value="InOut_bps"/>
330 <param name="nodeid" value="%nodeid-interface%//outbytes"/>
333 <leaf name="InOut_bps">
334 <param name="comment" value="Input and Output bits per second graphs" />
335 <param name="vertical-label" value="bps" />
336 <param name="graph-lower-limit" value="0" />
337 <param name="rrd-hwpredict" value="disabled" />
338 <param name="precedence" value="1000" />
339 <param name="nodeid" value="%nodeid-interface%//inoutbit"/>
340 <param name="ds-type" value="rrd-multigraph" />
341 <param name="ds-names" value="in,out" />
343 <param name="ds-expr-in" value="{Bytes_In},8,*" />
344 <param name="graph-legend-in" value="Bits per second in" />
345 <param name="line-style-in" value="##BpsIn" />
346 <param name="line-color-in" value="##BpsIn" />
347 <param name="line-order-in" value="1" />
349 <param name="ds-expr-out" value="{Bytes_Out},8,*" />
350 <param name="graph-legend-out" value="Bits per second out" />
351 <param name="line-style-out" value="##BpsOut" />
352 <param name="line-color-out" value="##BpsOut" />
353 <param name="line-order-out" value="2" />
357 <template name="ifxtable-hcucast-packets">
358 <leaf name="Packets_In">
359 <param name="snmp-object" value="$ifHCInUcastPkts.%ifindex-map%" />
360 <param name="snmp-object-type" value="COUNTER64" />
361 <param name="rrd-ds" value="ifHCInUcastPkts" />
362 <param name="rrd-create-dstype" value="COUNTER" />
363 <param name="rrd-create-max" value="1e15"/>
364 <param name="comment" value="Input packet counter for the interface" />
365 <param name="graph-legend" value="Packets in" />
366 <param name="vertical-label" value="pps" />
367 <param name="graph-lower-limit" value="0" />
368 <param name="precedence" value="890" />
369 <param name="nodeid" value="%nodeid-interface%//inpackets"/>
372 <leaf name="Packets_Out">
373 <param name="snmp-object" value="$ifHCOutUcastPkts.%ifindex-map%" />
374 <param name="snmp-object-type" value="COUNTER64" />
375 <param name="rrd-ds" value="ifHCOutUcastPkts" />
376 <param name="rrd-create-dstype" value="COUNTER" />
377 <param name="rrd-create-max" value="1e15"/>
378 <param name="comment" value="Output packet counter for the interface" />
379 <param name="graph-legend" value="Packets out" />
380 <param name="vertical-label" value="pps" />
381 <param name="graph-lower-limit" value="0" />
382 <param name="precedence" value="880" />
383 <param name="nodeid" value="%nodeid-interface%//outpackets"/>
388 <!-- Bandwidth usage in percentage of megabits
389 100 * (bytes * 8 / 1e6) / limit = bytes / (limit * 1250) -->
390 <template name="interface-bandwidth-usage">
391 <leaf name="Bandwidth_Usage">
392 <param name="comment" value="Bandwidth usage graphs" />
393 <param name="vertical-label" value="percent" />
394 <param name="graph-lower-limit" value="0" />
395 <param name="graph-upper-limit" value="100" />
396 <param name="upper-limit" value="100" />
397 <param name="rrd-hwpredict" value="disabled" />
398 <param name="precedence" value="998" />
399 <param name="nodeid" value="%nodeid-interface%//bw"/>
400 <param name="ds-type" value="rrd-multigraph" />
401 <param name="ds-names" value="in,out" />
403 <param name="ds-expr-in"
404 value="{Bytes_In},%bandwidth-limit-in%,1250.0,*,/" />
405 <param name="graph-legend-in"
406 value="Input use of %bandwidth-limit-in% Mbps" />
407 <param name="line-style-in" value="##BpsIn" />
408 <param name="line-color-in" value="##BpsIn" />
409 <param name="line-order-in" value="1" />
411 <param name="ds-expr-out"
412 value="{Bytes_Out},%bandwidth-limit-out%,1250.0,*,/" />
413 <param name="graph-legend-out"
414 value="Output use of %bandwidth-limit-out% Mbps" />
415 <param name="line-style-out" value="##BpsOut" />
416 <param name="line-color-out" value="##BpsOut" />
417 <param name="line-order-out" value="2" />
423 <!-- ********************************************************************
425 Templates for read-only access to RRD files
427 ************************************************************************-->
429 <template name="read-iftable-octets">
430 <leaf name="Bytes_In">
431 <param name="ds-type" value="rrd-file" />
432 <param name="leaf-type" value="rrd-def" />
433 <param name="rrd-cf" value="AVERAGE" />
434 <param name="data-file"
435 value="%system-id%_%interface-nick%_if-mib.rrd" />
436 <param name="rrd-ds" value="ifInOctets" />
437 <param name="comment" value="Input byte counter for the interface" />
438 <param name="graph-legend" value="Bytes in" />
439 <param name="vertical-label" value="Bps" />
440 <param name="graph-lower-limit" value="0" />
441 <param name="precedence" value="990" />
442 <param name="monitor-action-target" value="InOut_bps"/>
445 <leaf name="Bytes_Out">
446 <param name="ds-type" value="rrd-file" />
447 <param name="leaf-type" value="rrd-def" />
448 <param name="rrd-cf" value="AVERAGE" />
449 <param name="data-file"
450 value="%system-id%_%interface-nick%_if-mib.rrd" />
451 <param name="rrd-ds" value="ifOutOctets" />
452 <param name="comment" value="Output byte counter for the interface" />
453 <param name="graph-legend" value="Bytes out" />
454 <param name="vertical-label" value="Bps" />
455 <param name="graph-lower-limit" value="0" />
456 <param name="precedence" value="980" />
457 <param name="monitor-action-target" value="InOut_bps"/>
460 <leaf name="InOut_bps">
461 <param name="comment" value="Input and Output bits per second graphs" />
462 <param name="vertical-label" value="bps" />
463 <param name="graph-lower-limit" value="0" />
464 <param name="rrd-hwpredict" value="disabled" />
465 <param name="precedence" value="1000" />
466 <param name="ds-type" value="rrd-multigraph" />
467 <param name="ds-names" value="in,out" />
469 <param name="ds-expr-in" value="{Bytes_In},8,*" />
470 <param name="graph-legend-in" value="Bits per second in" />
471 <param name="line-style-in" value="##BpsIn" />
472 <param name="line-color-in" value="##BpsIn" />
473 <param name="line-order-in" value="1" />
475 <param name="ds-expr-out" value="{Bytes_Out},8,*" />
476 <param name="graph-legend-out" value="Bits per second out" />
477 <param name="line-style-out" value="##BpsOut" />
478 <param name="line-color-out" value="##BpsOut" />
479 <param name="line-order-out" value="2" />
484 <template name="read-ifxtable-hcoctets">
485 <leaf name="Bytes_In">
486 <param name="ds-type" value="rrd-file" />
487 <param name="leaf-type" value="rrd-def" />
488 <param name="rrd-cf" value="AVERAGE" />
489 <param name="data-file"
490 value="%system-id%_%interface-nick%_if-mib.rrd" />
491 <param name="rrd-ds" value="ifHCInOctets" />
492 <param name="comment" value="Input byte counter for the interface" />
493 <param name="graph-legend" value="Bytes in" />
494 <param name="vertical-label" value="Bps" />
495 <param name="graph-lower-limit" value="0" />
496 <param name="monitor-action-target" value="InOut_bps"/>
499 <leaf name="Bytes_Out">
500 <param name="ds-type" value="rrd-file" />
501 <param name="leaf-type" value="rrd-def" />
502 <param name="rrd-cf" value="AVERAGE" />
503 <param name="data-file"
504 value="%system-id%_%interface-nick%_if-mib.rrd" />
505 <param name="rrd-ds" value="ifHCOutOctets" />
506 <param name="comment" value="Output byte counter for the interface" />
507 <param name="graph-legend" value="Bytes out" />
508 <param name="vertical-label" value="Bps" />
509 <param name="graph-lower-limit" value="0" />
510 <param name="monitor-action-target" value="InOut_bps"/>
513 <leaf name="InOut_bps">
514 <param name="comment" value="Input and Output bits per second graphs" />
515 <param name="vertical-label" value="bps" />
516 <param name="graph-lower-limit" value="0" />
517 <param name="rrd-hwpredict" value="disabled" />
518 <param name="precedence" value="1000" />
519 <param name="ds-type" value="rrd-multigraph" />
520 <param name="ds-names" value="in,out" />
522 <param name="ds-expr-in" value="{Bytes_In},8,*" />
523 <param name="graph-legend-in" value="Bits per second in" />
524 <param name="line-style-in" value="##BpsIn" />
525 <param name="line-color-in" value="##BpsIn" />
526 <param name="line-order-in" value="1" />
528 <param name="ds-expr-out" value="{Bytes_Out},8,*" />
529 <param name="graph-legend-out" value="Bits per second out" />
530 <param name="line-style-out" value="##BpsOut" />
531 <param name="line-color-out" value="##BpsOut" />
532 <param name="line-order-out" value="2" />