.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.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" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Mon::SNMP 3pm"
.TH Mon::SNMP 3pm "2021-01-04" "perl v5.32.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Mon::SNMP \- decode SNMP trap
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Mon::SNMP;
\&
\&    $trap = new Mon::SNMP;
\&
\&    $trap\->buffer($snmptrap);
\&
\&    %traphash = $trap\->decode;
\&
\&    $error = $trap\->error;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Mon::SNMP provides methods to decode \s-1SNMP\s0 trap PDUs. It is based on
Graham Barr's Convert::BER module, and its purpose is to provide
\&\s-1SNMP\s0 trap handling to \*(L"mon\*(R".
.PP
It is not complete, so don't bother trying to use it unless you are
ready to debug and write some code.
.SH "METHODS"
.IX Header "METHODS"
.IP "\fBnew\fR" 4
.IX Item "new"
creates a new Mon::SNMP object.
.IP "\fBbuffer\fR ( buffer )" 4
.IX Item "buffer ( buffer )"
Assigns a raw \s-1SNMP\s0 trap message to the object.
.IP "\fBdecode\fR" 4
.IX Item "decode"
Decodes a \s-1SNMP\s0 trap message, and returns a hash of the variable
assignments for the \s-1SNMP\s0 header and trap protocol data unit of the
associated message. The hash consists of the following members:
.Sp
.Vb 8
\&        version         =>      SNMP version (1)
\&        community       =>      community string
\&        ent_OID         =>      enterprise OID of originating agent
\&        agentaddr       =>      IP address of originating agent
\&        generic_trap    =>      /COLDSTART|WARMSTART|LINKDOWN|LINKUP|AUTHFAIL|EGPNEIGHBORLOSS|ENTERPRISESPECIFIC/
\&        specific_trap   =>      specific trap type (integer)
\&        timeticks       =>      timeticks (integer)
\&        varbindlist     =>      { oid1 => value, oid2 => value, ... }
.Ve
.SH "ERRORS"
.IX Header "ERRORS"
All methods return a hash with no elements upon errors which they detect,
and the detail of the error is available from the
.SH "EXAMPLES"
.IX Header "EXAMPLES"
.Vb 1
\&    use Mon::SNMP;
\&
\&    $trap = new Mon::SNMP;
\&
\&    $trap\->buffer($snmptrap);
\&
\&    %traphash = $trap\->decode;
\&
\&    foreach $oid (keys $traphash{"varbindlist"}) {
\&        $val = $traphash{"varbindlist"}{$oid};
\&        print "oid($oid) = val($val)\en";
\&    }
.Ve
.SH "ENVIRONMENT"
.IX Header "ENVIRONMENT"
None.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Graham Barr's Convert::BER module.
.SH "NOTES"
.IX Header "NOTES"
.SH "CAVEATS"
.IX Header "CAVEATS"
Mon::SNMP depends upon Convert::BER to do the real work.