File: mrtg-mibhelp.1

package info (click to toggle)
mrtg 2.16.2-3
  • links: PTS, VCS
  • area: main
  • in suites: lenny
  • size: 5,508 kB
  • ctags: 1,238
  • sloc: perl: 25,056; ansic: 4,560; sh: 1,391; makefile: 244; php: 227; awk: 225; csh: 49; exp: 16
file content (336 lines) | stat: -rw-r--r-- 9,760 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "MRTG-MIBHELP 1"
.TH MRTG-MIBHELP 1 "2008-05-16" "2.16.2" "mrtg"
.SH "NAME"
mrtg\-mibhelp \- A Table of some interesting OIDs
.SH "OVERVIEW"
.IX Header "OVERVIEW"
This File Contains a collection of interesting \s-1MIB\s0 Entries ...
mrtg knows about their names ... depending on the \s-1ASN\s0.1 Syntax
you may have to put \fBgauge\fR into the \fBOptions[]:\fR parameter.
.PP
For information about how to create a \fBTarget[]:\fR parameter which
references these \s-1MIB\s0 entries, please consult mrtg\-reference.
.SH "MIB LIST"
.IX Header "MIB LIST"
.Sh "ifOperStatus"
.IX Subsection "ifOperStatus"
.Vb 4
\& Descriptor:            ifOperStatus
\& Identifier:            1.3.6.1.2.1.2.2.1.8
\& ASN.1 Syntax:          INTEGER
\& Enumeration:           up 1, down 2, testing 3
.Ve
.PP
The current operational state of the interface.
The \fItesting\fR\|(3) state indicates that no operational
packets can be passed.
.Sh "ifAdminStatus"
.IX Subsection "ifAdminStatus"
.Vb 4
\& Descriptor:            ifAdminStatus
\& Identifier:            1.3.6.1.2.1.2.2.1.7
\& ASN.1 Syntax:          INTEGER
\& Enumeration:           up 1, down 2, testing 3
.Ve
.PP
The current administrative state of the interface.
The \fItesting\fR\|(3) state indicates that no operational
packets can be passed.
.Sh "ifInOctets"
.IX Subsection "ifInOctets"
.Vb 3
\& Descriptor:            ifInOctets
\& Identifier:            1.3.6.1.2.1.2.2.1.10
\& ASN.1 Syntax:          Counter32
.Ve
.PP
The total number of octets received on the
interface, including framing characters.
.Sh "ifInUcastPkts"
.IX Subsection "ifInUcastPkts"
.Vb 3
\& Descriptor:            ifInUcastPkts
\& Identifier:            1.3.6.1.2.1.2.2.1.11
\& ASN.1 Syntax:          Counter32
.Ve
.PP
The number of subnetwork-unicast packets
delivered to a higher-layer protocol.
.Sh "ifInNUcastPkts"
.IX Subsection "ifInNUcastPkts"
.Vb 3
\& Descriptor:            ifInNUcastPkts
\& Identifier:            1.3.6.1.2.1.2.2.1.12
\& ASN.1 Syntax:          Counter32
.Ve
.PP
The number of non-unicast (i.e., subnetwork\-
broadcast or subnetwork\-multicast) packets
delivered to a higher-layer protocol.
.Sh "ifInDiscards"
.IX Subsection "ifInDiscards"
.Vb 3
\& Descriptor:            ifInDiscards
\& Identifier:            1.3.6.1.2.1.2.2.1.13
\& ASN.1 Syntax:          Counter32
.Ve
.PP
The number of inbound packets which were chosen
to be discarded even though no errors had been
detected to prevent their being deliverable to a
higher-layer protocol.  One possible reason for
discarding such a packet could be to free up
buffer space.
.Sh "ifInErrors"
.IX Subsection "ifInErrors"
.Vb 3
\& Descriptor:            ifInErrors
\& Identifier:            1.3.6.1.2.1.2.2.1.14
\& ASN.1 Syntax:          Counter32
.Ve
.PP
The number of inbound packets that contained
errors preventing them from being deliverable to a
higher-layer protocol.
.Sh "ifInUnknownProtos"
.IX Subsection "ifInUnknownProtos"
.Vb 3
\& Descriptor:            ifInUnknownProtos
\& Identifier:            1.3.6.1.2.1.2.2.1.15
\& ASN.1 Syntax:          Counter32
.Ve
.PP
The number of packets received via the interface
which were discarded because of an unknown or
unsupported protocol.
.Sh "ifOutOctets"
.IX Subsection "ifOutOctets"
.Vb 3
\& Descriptor:            ifOutOctets
\& Identifier:            1.3.6.1.2.1.2.2.1.16
\& ASN.1 Syntax:          Counter32
.Ve
.PP
The total number of octets transmitted out of the
interface, including framing characters.
.Sh "ifOutUcastPkts"
.IX Subsection "ifOutUcastPkts"
.Vb 3
\& Descriptor:            ifOutUcastPkts
\& Identifier:            1.3.6.1.2.1.2.2.1.17
\& ASN.1 Syntax:          Counter32
.Ve
.PP
The total number of packets that higher-level
protocols requested be transmitted to a
subnetwork-unicast address, including those that
were discarded or not sent.
.Sh "ifOutNUcastPkts"
.IX Subsection "ifOutNUcastPkts"
.Vb 3
\& Descriptor:             ifOutNUcastPkts
\& Identifier:            1.3.6.1.2.1.2.2.1.18
\& ASN.1 Syntax:          Counter32
.Ve
.PP
The total number of packets that higher-level
protocols requested be transmitted to a non\-
unicast (i.e., a subnetwork-broadcast or
subnetwork\-multicast) address, including those
that were discarded or not sent.
.Sh "ifOutDiscards"
.IX Subsection "ifOutDiscards"
.Vb 3
\& Descriptor:             ifOutDiscards
\& Identifier:            1.3.6.1.2.1.2.2.1.19
\& ASN.1 Syntax:          Counter32
.Ve
.PP
The number of outbound packets which were chosen
to be discarded even though no errors had been
detected to prevent their being transmitted.  One
possible reason for discarding such a packet could
be to free up buffer space.
.Sh "ifOutErrors"
.IX Subsection "ifOutErrors"
.Vb 3
\& Descriptor:             ifOutErrors
\& Identifier:            1.3.6.1.2.1.2.2.1.20
\& ASN.1 Syntax:          Counter32
.Ve
.PP
The number of outbound packets that could not be
transmitted because of errors.
.Sh "ifOutQLen"
.IX Subsection "ifOutQLen"
.Vb 3
\& Descriptor:             ifOutQLen
\& Identifier:            1.3.6.1.2.1.2.2.1.21
\& ASN.1 Syntax:          Unsigned32
.Ve
.PP
The length of the output packet queue (in
packets).
.Sh "frInOctets"
.IX Subsection "frInOctets"
From: Simon Ferrett <simonf@world.net>
.PP
.Vb 2
\& 'frInOctets' => '1.3.6.1.2.1.10.32.2.1.9'
\& 'frOutOctets' => '1.3.6.1.2.1.10.32.2.1.7'
.Ve
.PP
which when used in the form:
.PP
.Vb 1
\& frInOctets.pp.dd&frOutOctets.pp.dd:community@cisco.router
.Ve
.PP
where pp is the physical port that the frame relay pvc is
defined on and dd is the \s-1DLCI\s0 of the pvc gets you the in
and out octets for just that pvc.
.Sh "ifAdminHack and ifOperHack"
.IX Subsection "ifAdminHack and ifOperHack"
The return values of ifAdminStatus and ifOperStatus are not very usefull
for graphing. Use ifOperHack and ifAdminHack instead. They return 1 for
\&\s-1UP\s0 and 0 otherwise.
.PP
Note these are not real \s-1MIB\s0 entities but mrtg hacks
.Sh "PseudoZero and PseudoOne"
.IX Subsection "PseudoZero and PseudoOne"
will return 0 and 1 respectively
.PP
Note these are not real \s-1MIB\s0 entities but mrtg hacks
.SH "AUTHOR"
.IX Header "AUTHOR"
Tobias Oetiker <tobi@oetiker.ch>