Blame doc/mrtg-mibhelp.1

Packit 667938
.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
Packit 667938
.\"
Packit 667938
.\" Standard preamble:
Packit 667938
.\" ========================================================================
Packit 667938
.de Sp \" Vertical space (when we can't use .PP)
Packit 667938
.if t .sp .5v
Packit 667938
.if n .sp
Packit 667938
..
Packit 667938
.de Vb \" Begin verbatim text
Packit 667938
.ft CW
Packit 667938
.nf
Packit 667938
.ne \\$1
Packit 667938
..
Packit 667938
.de Ve \" End verbatim text
Packit 667938
.ft R
Packit 667938
.fi
Packit 667938
..
Packit 667938
.\" Set up some character translations and predefined strings.  \*(-- will
Packit 667938
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
Packit 667938
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
Packit 667938
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
Packit 667938
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
Packit 667938
.\" nothing in troff, for use with C<>.
Packit 667938
.tr \(*W-
Packit 667938
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
Packit 667938
.ie n \{\
Packit 667938
.    ds -- \(*W-
Packit 667938
.    ds PI pi
Packit 667938
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
Packit 667938
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
Packit 667938
.    ds L" ""
Packit 667938
.    ds R" ""
Packit 667938
.    ds C` ""
Packit 667938
.    ds C' ""
Packit 667938
'br\}
Packit 667938
.el\{\
Packit 667938
.    ds -- \|\(em\|
Packit 667938
.    ds PI \(*p
Packit 667938
.    ds L" ``
Packit 667938
.    ds R" ''
Packit 667938
.    ds C`
Packit 667938
.    ds C'
Packit 667938
'br\}
Packit 667938
.\"
Packit 667938
.\" Escape single quotes in literal strings from groff's Unicode transform.
Packit 667938
.ie \n(.g .ds Aq \(aq
Packit 667938
.el       .ds Aq '
Packit 667938
.\"
Packit 667938
.\" If the F register is turned on, we'll generate index entries on stderr for
Packit 667938
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
Packit 667938
.\" entries marked with X<> in POD.  Of course, you'll have to process the
Packit 667938
.\" output yourself in some meaningful fashion.
Packit 667938
.\"
Packit 667938
.\" Avoid warning from groff about undefined register 'F'.
Packit 667938
.de IX
Packit 667938
..
Packit 667938
.nr rF 0
Packit 667938
.if \n(.g .if rF .nr rF 1
Packit 667938
.if (\n(rF:(\n(.g==0)) \{
Packit 667938
.    if \nF \{
Packit 667938
.        de IX
Packit 667938
.        tm Index:\\$1\t\\n%\t"\\$2"
Packit 667938
..
Packit 667938
.        if !\nF==2 \{
Packit 667938
.            nr % 0
Packit 667938
.            nr F 2
Packit 667938
.        \}
Packit 667938
.    \}
Packit 667938
.\}
Packit 667938
.rr rF
Packit 667938
.\"
Packit 667938
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
Packit 667938
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
Packit 667938
.    \" fudge factors for nroff and troff
Packit 667938
.if n \{\
Packit 667938
.    ds #H 0
Packit 667938
.    ds #V .8m
Packit 667938
.    ds #F .3m
Packit 667938
.    ds #[ \f1
Packit 667938
.    ds #] \fP
Packit 667938
.\}
Packit 667938
.if t \{\
Packit 667938
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
Packit 667938
.    ds #V .6m
Packit 667938
.    ds #F 0
Packit 667938
.    ds #[ \&
Packit 667938
.    ds #] \&
Packit 667938
.\}
Packit 667938
.    \" simple accents for nroff and troff
Packit 667938
.if n \{\
Packit 667938
.    ds ' \&
Packit 667938
.    ds ` \&
Packit 667938
.    ds ^ \&
Packit 667938
.    ds , \&
Packit 667938
.    ds ~ ~
Packit 667938
.    ds /
Packit 667938
.\}
Packit 667938
.if t \{\
Packit 667938
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
Packit 667938
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
Packit 667938
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
Packit 667938
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
Packit 667938
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
Packit 667938
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
Packit 667938
.\}
Packit 667938
.    \" troff and (daisy-wheel) nroff accents
Packit 667938
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
Packit 667938
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
Packit 667938
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
Packit 667938
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
Packit 667938
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
Packit 667938
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
Packit 667938
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
Packit 667938
.ds ae a\h'-(\w'a'u*4/10)'e
Packit 667938
.ds Ae A\h'-(\w'A'u*4/10)'E
Packit 667938
.    \" corrections for vroff
Packit 667938
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
Packit 667938
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
Packit 667938
.    \" for low resolution devices (crt and lpr)
Packit 667938
.if \n(.H>23 .if \n(.V>19 \
Packit 667938
\{\
Packit 667938
.    ds : e
Packit 667938
.    ds 8 ss
Packit 667938
.    ds o a
Packit 667938
.    ds d- d\h'-1'\(ga
Packit 667938
.    ds D- D\h'-1'\(hy
Packit 667938
.    ds th \o'bp'
Packit 667938
.    ds Th \o'LP'
Packit 667938
.    ds ae ae
Packit 667938
.    ds Ae AE
Packit 667938
.\}
Packit 667938
.rm #[ #] #H #V #F C
Packit 667938
.\" ========================================================================
Packit 667938
.\"
Packit 667938
.IX Title "MRTG-MIBHELP 1"
Packit 667938
.TH MRTG-MIBHELP 1 "2018-07-13" "2.17.7" "mrtg"
Packit 667938
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
Packit 667938
.\" way too many mistakes in technical documents.
Packit 667938
.if n .ad l
Packit 667938
.nh
Packit 667938
.SH "NAME"
Packit 667938
mrtg\-mibhelp \- A Table of some interesting OIDs
Packit 667938
.SH "OVERVIEW"
Packit 667938
.IX Header "OVERVIEW"
Packit 667938
This File Contains a collection of interesting \s-1MIB\s0 Entries ...
Packit 667938
mrtg knows about their names ... depending on the \s-1ASN.1\s0 Syntax
Packit 667938
you may have to put \fBgauge\fR into the \fBOptions[]:\fR parameter.
Packit 667938
.PP
Packit 667938
For information about how to create a \fBTarget[]:\fR parameter which
Packit 667938
references these \s-1MIB\s0 entries, please consult mrtg-reference.
Packit 667938
.SH "MIB LIST"
Packit 667938
.IX Header "MIB LIST"
Packit 667938
.SS "ifOperStatus"
Packit 667938
.IX Subsection "ifOperStatus"
Packit 667938
.Vb 4
Packit 667938
\& Descriptor:            ifOperStatus
Packit 667938
\& Identifier:            1.3.6.1.2.1.2.2.1.8
Packit 667938
\& ASN.1 Syntax:          INTEGER
Packit 667938
\& Enumeration:           up 1, down 2, testing 3
Packit 667938
.Ve
Packit 667938
.PP
Packit 667938
The current operational state of the interface.
Packit 667938
The \fItesting\fR\|(3) state indicates that no operational
Packit 667938
packets can be passed.
Packit 667938
.SS "ifAdminStatus"
Packit 667938
.IX Subsection "ifAdminStatus"
Packit 667938
.Vb 4
Packit 667938
\& Descriptor:            ifAdminStatus
Packit 667938
\& Identifier:            1.3.6.1.2.1.2.2.1.7
Packit 667938
\& ASN.1 Syntax:          INTEGER
Packit 667938
\& Enumeration:           up 1, down 2, testing 3
Packit 667938
.Ve
Packit 667938
.PP
Packit 667938
The current administrative state of the interface.
Packit 667938
The \fItesting\fR\|(3) state indicates that no operational
Packit 667938
packets can be passed.
Packit 667938
.SS "ifInOctets"
Packit 667938
.IX Subsection "ifInOctets"
Packit 667938
.Vb 3
Packit 667938
\& Descriptor:            ifInOctets
Packit 667938
\& Identifier:            1.3.6.1.2.1.2.2.1.10
Packit 667938
\& ASN.1 Syntax:          Counter32
Packit 667938
.Ve
Packit 667938
.PP
Packit 667938
The total number of octets received on the
Packit 667938
interface, including framing characters.
Packit 667938
.SS "ifInUcastPkts"
Packit 667938
.IX Subsection "ifInUcastPkts"
Packit 667938
.Vb 3
Packit 667938
\& Descriptor:            ifInUcastPkts
Packit 667938
\& Identifier:            1.3.6.1.2.1.2.2.1.11
Packit 667938
\& ASN.1 Syntax:          Counter32
Packit 667938
.Ve
Packit 667938
.PP
Packit 667938
The number of subnetwork-unicast packets
Packit 667938
delivered to a higher-layer protocol.
Packit 667938
.SS "ifInNUcastPkts"
Packit 667938
.IX Subsection "ifInNUcastPkts"
Packit 667938
.Vb 3
Packit 667938
\& Descriptor:            ifInNUcastPkts
Packit 667938
\& Identifier:            1.3.6.1.2.1.2.2.1.12
Packit 667938
\& ASN.1 Syntax:          Counter32
Packit 667938
.Ve
Packit 667938
.PP
Packit 667938
The number of non-unicast (i.e., subnetwork\-
Packit 667938
broadcast or subnetwork-multicast) packets
Packit 667938
delivered to a higher-layer protocol.
Packit 667938
.SS "ifInDiscards"
Packit 667938
.IX Subsection "ifInDiscards"
Packit 667938
.Vb 3
Packit 667938
\& Descriptor:            ifInDiscards
Packit 667938
\& Identifier:            1.3.6.1.2.1.2.2.1.13
Packit 667938
\& ASN.1 Syntax:          Counter32
Packit 667938
.Ve
Packit 667938
.PP
Packit 667938
The number of inbound packets which were chosen
Packit 667938
to be discarded even though no errors had been
Packit 667938
detected to prevent their being deliverable to a
Packit 667938
higher-layer protocol.  One possible reason for
Packit 667938
discarding such a packet could be to free up
Packit 667938
buffer space.
Packit 667938
.SS "ifInErrors"
Packit 667938
.IX Subsection "ifInErrors"
Packit 667938
.Vb 3
Packit 667938
\& Descriptor:            ifInErrors
Packit 667938
\& Identifier:            1.3.6.1.2.1.2.2.1.14
Packit 667938
\& ASN.1 Syntax:          Counter32
Packit 667938
.Ve
Packit 667938
.PP
Packit 667938
The number of inbound packets that contained
Packit 667938
errors preventing them from being deliverable to a
Packit 667938
higher-layer protocol.
Packit 667938
.SS "ifInUnknownProtos"
Packit 667938
.IX Subsection "ifInUnknownProtos"
Packit 667938
.Vb 3
Packit 667938
\& Descriptor:            ifInUnknownProtos
Packit 667938
\& Identifier:            1.3.6.1.2.1.2.2.1.15
Packit 667938
\& ASN.1 Syntax:          Counter32
Packit 667938
.Ve
Packit 667938
.PP
Packit 667938
The number of packets received via the interface
Packit 667938
which were discarded because of an unknown or
Packit 667938
unsupported protocol.
Packit 667938
.SS "ifOutOctets"
Packit 667938
.IX Subsection "ifOutOctets"
Packit 667938
.Vb 3
Packit 667938
\& Descriptor:            ifOutOctets
Packit 667938
\& Identifier:            1.3.6.1.2.1.2.2.1.16
Packit 667938
\& ASN.1 Syntax:          Counter32
Packit 667938
.Ve
Packit 667938
.PP
Packit 667938
The total number of octets transmitted out of the
Packit 667938
interface, including framing characters.
Packit 667938
.SS "ifOutUcastPkts"
Packit 667938
.IX Subsection "ifOutUcastPkts"
Packit 667938
.Vb 3
Packit 667938
\& Descriptor:            ifOutUcastPkts
Packit 667938
\& Identifier:            1.3.6.1.2.1.2.2.1.17
Packit 667938
\& ASN.1 Syntax:          Counter32
Packit 667938
.Ve
Packit 667938
.PP
Packit 667938
The total number of packets that higher-level
Packit 667938
protocols requested be transmitted to a
Packit 667938
subnetwork-unicast address, including those that
Packit 667938
were discarded or not sent.
Packit 667938
.SS "ifOutNUcastPkts"
Packit 667938
.IX Subsection "ifOutNUcastPkts"
Packit 667938
.Vb 3
Packit 667938
\& Descriptor:             ifOutNUcastPkts
Packit 667938
\& Identifier:            1.3.6.1.2.1.2.2.1.18
Packit 667938
\& ASN.1 Syntax:          Counter32
Packit 667938
.Ve
Packit 667938
.PP
Packit 667938
The total number of packets that higher-level
Packit 667938
protocols requested be transmitted to a non\-
Packit 667938
unicast (i.e., a subnetwork-broadcast or
Packit 667938
subnetwork-multicast) address, including those
Packit 667938
that were discarded or not sent.
Packit 667938
.SS "ifOutDiscards"
Packit 667938
.IX Subsection "ifOutDiscards"
Packit 667938
.Vb 3
Packit 667938
\& Descriptor:             ifOutDiscards
Packit 667938
\& Identifier:            1.3.6.1.2.1.2.2.1.19
Packit 667938
\& ASN.1 Syntax:          Counter32
Packit 667938
.Ve
Packit 667938
.PP
Packit 667938
The number of outbound packets which were chosen
Packit 667938
to be discarded even though no errors had been
Packit 667938
detected to prevent their being transmitted.  One
Packit 667938
possible reason for discarding such a packet could
Packit 667938
be to free up buffer space.
Packit 667938
.SS "ifOutErrors"
Packit 667938
.IX Subsection "ifOutErrors"
Packit 667938
.Vb 3
Packit 667938
\& Descriptor:             ifOutErrors
Packit 667938
\& Identifier:            1.3.6.1.2.1.2.2.1.20
Packit 667938
\& ASN.1 Syntax:          Counter32
Packit 667938
.Ve
Packit 667938
.PP
Packit 667938
The number of outbound packets that could not be
Packit 667938
transmitted because of errors.
Packit 667938
.SS "ifOutQLen"
Packit 667938
.IX Subsection "ifOutQLen"
Packit 667938
.Vb 3
Packit 667938
\& Descriptor:             ifOutQLen
Packit 667938
\& Identifier:            1.3.6.1.2.1.2.2.1.21
Packit 667938
\& ASN.1 Syntax:          Unsigned32
Packit 667938
.Ve
Packit 667938
.PP
Packit 667938
The length of the output packet queue (in
Packit 667938
packets).
Packit 667938
.SS "frInOctets"
Packit 667938
.IX Subsection "frInOctets"
Packit 667938
From: Simon Ferrett <simonf@world.net>
Packit 667938
.PP
Packit 667938
.Vb 2
Packit 667938
\& \*(AqfrInOctets\*(Aq => \*(Aq1.3.6.1.2.1.10.32.2.1.9\*(Aq
Packit 667938
\& \*(AqfrOutOctets\*(Aq => \*(Aq1.3.6.1.2.1.10.32.2.1.7\*(Aq
Packit 667938
.Ve
Packit 667938
.PP
Packit 667938
which when used in the form:
Packit 667938
.PP
Packit 667938
.Vb 1
Packit 667938
\& frInOctets.pp.dd&frOutOctets.pp.dd:community@cisco.router
Packit 667938
.Ve
Packit 667938
.PP
Packit 667938
where pp is the physical port that the frame relay pvc is
Packit 667938
defined on and dd is the \s-1DLCI\s0 of the pvc gets you the in
Packit 667938
and out octets for just that pvc.
Packit 667938
.SS "ifAdminHack and ifOperHack"
Packit 667938
.IX Subsection "ifAdminHack and ifOperHack"
Packit 667938
The return values of ifAdminStatus and ifOperStatus are not very useful
Packit 667938
for graphing. Use ifOperHack and ifAdminHack instead. They return 1 for
Packit 667938
\&\s-1UP\s0 and 0 otherwise.
Packit 667938
.PP
Packit 667938
Note these are not real \s-1MIB\s0 entities but mrtg hacks
Packit 667938
.SS "PseudoZero and PseudoOne"
Packit 667938
.IX Subsection "PseudoZero and PseudoOne"
Packit 667938
will return 0 and 1 respectively
Packit 667938
.PP
Packit 667938
Note these are not real \s-1MIB\s0 entities but mrtg hacks
Packit 667938
.SH "AUTHOR"
Packit 667938
.IX Header "AUTHOR"
Packit 667938
Tobias Oetiker <tobi@oetiker.ch>