debian man page for snmp::info::powerethernet

Info::PowerEthernet(3pm)				User Contributed Perl Documentation				  Info::PowerEthernet(3pm)

NAME
       SNMP::Info::PowerEthernet - SNMP Interface to data stored in POWER-ETHERNET-MIB.

AUTHOR
       Bill Fenner

SYNOPSIS
	# Let SNMP::Info determine the correct subclass for you.
	my $poe = new SNMP::Info(
				 AutoSpecify => 1,
				 Debug	     => 1,
				 DestHost    => 'myswitch',
				 Community   => 'public',
				 Version     => 2
			       )
	   or die "Can't connect to DestHost.
";

	my $class      = $poe->class();
	print "SNMP::Info determined this device to fall under subclass : $class
";

DESCRIPTION
       POWER-ETHERNET-MIB is used to describe PoE (IEEE 802.3af)

       Create or use a device subclass that inherit this class.  Do not use directly.

       For debugging purposes you can call this class directly as you would SNMP::Info

	my $poe = new SNMP::Info::PowerEthernet (...);

   Inherited Classes
       none.

   Required MIBs
       POWER-ETHERNET-MIB

GLOBALS
       none.

TABLE METHODS
       These are methods that return tables of information in the form of a reference to a hash.

   Power Port Table
       Selected values from the "pethPsePortTable"

       $poe->peth_port_admin()
	   Administrative status: is this port permitted to deliver power?

	   "pethPsePortAdminEnable"

       $poe->peth_port_status()
	   Current status: is this port delivering power, searching, disabled, etc?

	   "pethPsePortDetectionStatus"

       $poe->peth_port_class()
	   Device class: if status is delivering power, this represents the 802.3af class of the device being powered.

	   "pethPsePortPowerClassifications"

       $poe->peth_port_ifindex()
	   A mapping function from the "pethPsePortTable" INDEX of module.port to an "ifIndex".  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.

	   This mapping is more or less left up to the device vendor to implement; the MIB gives only very weak guidance.  A given device class
	   may implement its own version of this function (e.g., see Info::CiscoPower).

       $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 CDP, was
	   used to negotiate the power level.)

   Power Supply Table
       $poe->peth_power_watts()
	   The power supply's capacity, in watts.

	   "pethMainPsePower"

       $poe->peth_power_status()
	   The power supply's operational status.

	   "pethMainPseOperStatus"

       $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.)

	   "pethMainPseConsumptionPower"

       $poe->peth_power_threshold()
	   The threshold (in percent) of consumption required to raise an alarm.

	   "pethMainPseUsageThreshold"

perl v5.12.4							    2011-09-28						  Info::PowerEthernet(3pm)