.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" 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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Info::Layer3::Pf 3pm"
.TH Info::Layer3::Pf 3pm "2016-12-21" "perl v5.24.1" "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"
SNMP::Info::Layer3::Pf \- SNMP Interface to FreeBSD\-Based Firewalls using Pf /Pf Sense
.SH "AUTHOR"
.IX Header "AUTHOR"
Max Baker
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 10
\& # Let SNMP::Info determine the correct subclass for you. 
\& my $pf = new SNMP::Info(
\&                        AutoSpecify => 1,
\&                        Debug       => 1,
\&                        # These arguments are passed directly to SNMP::Session
\&                        DestHost    => \*(Aqmyswitch\*(Aq,
\&                        Community   => \*(Aqpublic\*(Aq,
\&                        Version     => 2
\&                        ) 
\&    or die "Can\*(Aqt connect to DestHost.\en";
\&
\& my $class      = $pf\->class();
\& print "SNMP::Info determined this device to fall under subclass : $class\en";
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Subclass for Free-BSD PF-Based devices
.SH "LLDP Support"
.IX Header "LLDP Support"
\&\s-1LLDP\s0 Support is included but untested in this Device Class.  It is reported
that the available \s-1CDP/LLDP\s0 modules for net-snmp don't work on FreeBSD (on
which pfSense is based) as they assume certain Linux specific Ethernet
structures.  This problem is apparently solved on \s-1PF\s0 based firewall appliances
by using the ladvd package, for which a port may be found here:
<http://www.freshports.org/net/ladvd/>.  I'm not sure if this module ties into 
Net-SNMP or not.
.SS "Inherited Classes"
.IX Subsection "Inherited Classes"
.IP "SNMP::Info::Layer3" 4
.IX Item "SNMP::Info::Layer3"
.PD 0
.IP "SNMP::Info::LLDP" 4
.IX Item "SNMP::Info::LLDP"
.PD
.SS "Required MIBs"
.IX Subsection "Required MIBs"
.IP "\fIFOKUS-MIB\fR" 4
.IX Item "FOKUS-MIB"
.PD 0
.IP "Inherited Classes' MIBs" 4
.IX Item "Inherited Classes' MIBs"
.PD
See \*(L"Required MIBs\*(R" in SNMP::Info::Layer3 for its own \s-1MIB\s0 requirements.
.Sp
See \*(L"Required MIBs\*(R" in SNMP::Info::LLDP for its own \s-1MIB\s0 requirements.
.SH "GLOBALS"
.IX Header "GLOBALS"
These are methods that return scalar values from \s-1SNMP\s0
.ie n .IP "$pf\->\fIvendor()\fR" 4
.el .IP "\f(CW$pf\fR\->\fIvendor()\fR" 4
.IX Item "$pf->vendor()"
.Vb 1
\&    Returns \*(AqFreeBSD\*(Aq
.Ve
.ie n .IP "$pf\->\fImodel()\fR" 4
.el .IP "\f(CW$pf\fR\->\fImodel()\fR" 4
.IX Item "$pf->model()"
Grabs the os version from \f(CW\*(C`sysDescr\*(C'\fR
.ie n .IP "$pf\->\fIos()\fR" 4
.el .IP "\f(CW$pf\fR\->\fIos()\fR" 4
.IX Item "$pf->os()"
Returns 'Pf'
.ie n .IP "$pf\->\fIos_ver()\fR" 4
.el .IP "\f(CW$pf\fR\->\fIos_ver()\fR" 4
.IX Item "$pf->os_ver()"
Tries to reference \f(CW$pf\fR\->\fIid()\fR to one of the product MIBs listed above.
Will probably return a truncation of the default \s-1OID\s0 for pf-based systems 
\&\f(CW\*(C`enterprises.12325.1.1.2.1.1\*(C'\fR.
.SS "Global Methods imported from SNMP::Info::Layer3"
.IX Subsection "Global Methods imported from SNMP::Info::Layer3"
See documentation in \*(L"\s-1GLOBALS\*(R"\s0 in SNMP::Info::Layer3 for details.
.SH "TABLE METHODS"
.IX Header "TABLE METHODS"
These are methods that return tables of information in the form of a reference
to a hash.
.SS "Table Methods imported from SNMP::Info::Layer3"
.IX Subsection "Table Methods imported from SNMP::Info::Layer3"
See documentation in \*(L"\s-1TABLE METHODS\*(R"\s0 in SNMP::Info::Layer3 for details.
.SS "Table Methods imported from SNMP::Info::LLDP"
.IX Subsection "Table Methods imported from SNMP::Info::LLDP"
See documentation in \*(L"\s-1TABLE METHODS\*(R"\s0 in SNMP::Info::LLDP for details.