.\" 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::PowerEthernet 3pm"
.TH Info::PowerEthernet 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::PowerEthernet \- SNMP Interface to data stored in
POWER\-ETHERNET\-MIB.
.SH "AUTHOR"
.IX Header "AUTHOR"
Bill Fenner
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 9
\& # Let SNMP::Info determine the correct subclass for you. 
\& my $poe = new SNMP::Info(
\&                          AutoSpecify => 1,
\&                          Debug       => 1,
\&                          DestHost    => \*(Aqmyswitch\*(Aq,
\&                          Community   => \*(Aqpublic\*(Aq,
\&                          Version     => 2
\&                        ) 
\&    or die "Can\*(Aqt connect to DestHost.\en";
\&
\& my $class      = $poe\->class();
\& print "SNMP::Info determined this device to fall under subclass : $class\en";
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fIPOWER-ETHERNET-MIB\fR is used to describe PoE (\s-1IEEE 802\s0.3af)
.PP
Create or use a device subclass that inherit this class.  Do not use directly.
.PP
For debugging purposes you can call this class directly as you would
SNMP::Info
.PP
.Vb 1
\& my $poe = new SNMP::Info::PowerEthernet (...);
.Ve
.SS "Inherited Classes"
.IX Subsection "Inherited Classes"
none.
.SS "Required MIBs"
.IX Subsection "Required MIBs"
.IP "\fIPOWER-ETHERNET-MIB\fR" 4
.IX Item "POWER-ETHERNET-MIB"
.SH "GLOBALS"
.IX Header "GLOBALS"
none.
.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 "Power Port Table"
.IX Subsection "Power Port Table"
Selected values from the \f(CW\*(C`pethPsePortTable\*(C'\fR
.ie n .IP "$poe\->\fIpeth_port_admin()\fR" 4
.el .IP "\f(CW$poe\fR\->\fIpeth_port_admin()\fR" 4
.IX Item "$poe->peth_port_admin()"
Administrative status: is this port permitted to deliver power?
.Sp
\&\f(CW\*(C`pethPsePortAdminEnable\*(C'\fR
.ie n .IP "$poe\->\fIpeth_port_status()\fR" 4
.el .IP "\f(CW$poe\fR\->\fIpeth_port_status()\fR" 4
.IX Item "$poe->peth_port_status()"
Current status: is this port delivering power, searching, disabled, etc?
.Sp
\&\f(CW\*(C`pethPsePortDetectionStatus\*(C'\fR
.ie n .IP "$poe\->\fIpeth_port_class()\fR" 4
.el .IP "\f(CW$poe\fR\->\fIpeth_port_class()\fR" 4
.IX Item "$poe->peth_port_class()"
Device class: if status is delivering power, this represents the 802.3af
class of the device being powered.
.Sp
\&\f(CW\*(C`pethPsePortPowerClassifications\*(C'\fR
.ie n .IP "$poe\->\fIpeth_port_ifindex()\fR" 4
.el .IP "\f(CW$poe\fR\->\fIpeth_port_ifindex()\fR" 4
.IX Item "$poe->peth_port_ifindex()"
A mapping function from the \f(CW\*(C`pethPsePortTable\*(C'\fR \s-1INDEX\s0 of
module.port to an \f(CW\*(C`ifIndex\*(C'\fR.  The default mapping ignores the
module (returning undef if there are any module values greater
than 1) and returns the port number, assuming that there is a
1:1 mapping.
.Sp
This mapping is more or less left up to the device vendor to
implement; the \s-1MIB\s0 gives only very weak guidance.
A given device class may implement its own version
of this function (e.g., see Info::CiscoPower).
.ie n .IP "$poe\->\fIpeth_port_neg_power()\fR" 4
.el .IP "\f(CW$poe\fR\->\fIpeth_port_neg_power()\fR" 4
.IX Item "$poe->peth_port_neg_power()"
The power, in milliwatts, that has been committed to this port.
This value is derived from the 802.3af class of the device being
powered, but may be overridden by a subclass that has information
from another source (e.g., if a different protocol, such as \s-1CDP,\s0
was used to negotiate the power level.)
.SS "Power Supply Table"
.IX Subsection "Power Supply Table"
.ie n .IP "$poe\->\fIpeth_power_watts()\fR" 4
.el .IP "\f(CW$poe\fR\->\fIpeth_power_watts()\fR" 4
.IX Item "$poe->peth_power_watts()"
The power supply's capacity, in watts.
.Sp
\&\f(CW\*(C`pethMainPsePower\*(C'\fR
.ie n .IP "$poe\->\fIpeth_power_status()\fR" 4
.el .IP "\f(CW$poe\fR\->\fIpeth_power_status()\fR" 4
.IX Item "$poe->peth_power_status()"
The power supply's operational status.
.Sp
\&\f(CW\*(C`pethMainPseOperStatus\*(C'\fR
.ie n .IP "$poe\->\fIpeth_power_consumption()\fR" 4
.el .IP "\f(CW$poe\fR\->\fIpeth_power_consumption()\fR" 4
.IX Item "$poe->peth_power_consumption()"
How much power, in watts, this power supply has been committed to
deliver.  (Note: certain devices seem to supply this value in milliwatts,
so be cautious interpreting it.)
.Sp
\&\f(CW\*(C`pethMainPseConsumptionPower\*(C'\fR
.ie n .IP "$poe\->\fIpeth_power_threshold()\fR" 4
.el .IP "\f(CW$poe\fR\->\fIpeth_power_threshold()\fR" 4
.IX Item "$poe->peth_power_threshold()"
The threshold (in percent) of consumption required to raise an
alarm.
.Sp
\&\f(CW\*(C`pethMainPseUsageThreshold\*(C'\fR