.\" 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::Layer7::APC 3pm" .TH Info::Layer7::APC 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::Layer7::APC \- SNMP Interface to APC UPS devices .SH "AUTHOR" .IX Header "AUTHOR" Jeroen van Ingen .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 9 \& # Let SNMP::Info determine the correct subclass for you. \& my $apc = 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 = $apc\->class(); \& print "SNMP::Info determined this device to fall under subclass : $class\en"; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Provides abstraction to the configuration information obtainable from a \&\s-1APC UPS\s0 via \s-1SNMP. \s0 .PP For speed or debugging purposes you can call the subclass directly, but not after determining a more specific class using the method above. .PP .Vb 1 \& my $apc = new SNMP::Info::Layer7::APC(...); .Ve .SS "Inherited Classes" .IX Subsection "Inherited Classes" .IP "SNMP::Info::Layer7" 4 .IX Item "SNMP::Info::Layer7" .SS "Required MIBs" .IX Subsection "Required MIBs" .PD 0 .IP "\fIPOWERNET-MIB\fR" 4 .IX Item "POWERNET-MIB" .PD .PP All required MIBs can be found in the netdisco-mibs package. .SH "GLOBALS" .IX Header "GLOBALS" These are methods that return scalar value from \s-1SNMP\s0 .ie n .IP "$apc\->\fIos()\fR" 4 .el .IP "\f(CW$apc\fR\->\fIos()\fR" 4 .IX Item "$apc->os()" Returns \f(CW\*(Aqaos\*(Aq\fR .ie n .IP "$apc\->\fIos_bin()\fR" 4 .el .IP "\f(CW$apc\fR\->\fIos_bin()\fR" 4 .IX Item "$apc->os_bin()" \&\f(CW\*(C`POWERNET\-MIB::experimental.2.4.1.4.2\*(C'\fR .ie n .IP "$apc\->\fIos_ver()\fR" 4 .el .IP "\f(CW$apc\fR\->\fIos_ver()\fR" 4 .IX Item "$apc->os_ver()" \&\f(CW\*(C`POWERNET\-MIB::experimental.2.4.1.4.1\*(C'\fR .ie n .IP "$apc\->\fIserial()\fR" 4 .el .IP "\f(CW$apc\fR\->\fIserial()\fR" 4 .IX Item "$apc->serial()" Combines the \s-1UPS\s0 serial \f(CW\*(C`upsAdvIdentSerialNumber.0\*(C'\fR with the management card serial \f(CW\*(C`POWERNET\-MIB::experimental.2.4.1.2.1\*(C'\fR into a pretty string. .ie n .IP "$apc\->\fIvendor()\fR" 4 .el .IP "\f(CW$apc\fR\->\fIvendor()\fR" 4 .IX Item "$apc->vendor()" Returns \f(CW\*(Aqapc\*(Aq\fR .ie n .IP "$apc\->\fImodel()\fR" 4 .el .IP "\f(CW$apc\fR\->\fImodel()\fR" 4 .IX Item "$apc->model()" \&\f(CW\*(C`upsBasicIdentModel.0\*(C'\fR .ie n .IP "$apc\->\fIps1_type()\fR" 4 .el .IP "\f(CW$apc\fR\->\fIps1_type()\fR" 4 .IX Item "$apc->ps1_type()" Returns '\s-1UPS\s0 status' .ie n .IP "$apc\->\fIps1_status()\fR" 4 .el .IP "\f(CW$apc\fR\->\fIps1_status()\fR" 4 .IX Item "$apc->ps1_status()" Returns the main \s-1UPS\s0 status from \f(CW\*(C`upsBasicOutputStatus.0\*(C'\fR .ie n .IP "$apc\->\fIps2_type()\fR" 4 .el .IP "\f(CW$apc\fR\->\fIps2_type()\fR" 4 .IX Item "$apc->ps2_type()" Returns 'Battery status' .ie n .IP "$apc\->\fIps2_status()\fR" 4 .el .IP "\f(CW$apc\fR\->\fIps2_status()\fR" 4 .IX Item "$apc->ps2_status()" Returns the battery status from \f(CW\*(C`upsBasicBatteryStatus.0\*(C'\fR .SS "Globals imported from SNMP::Info::Layer7" .IX Subsection "Globals imported from SNMP::Info::Layer7" See documentation in \*(L"\s-1GLOBALS\*(R"\s0 in SNMP::Info::Layer7 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 "Overrides" .IX Subsection "Overrides" .SS "Table Methods imported from SNMP::Info::Layer7" .IX Subsection "Table Methods imported from SNMP::Info::Layer7" See documentation in \*(L"\s-1TABLE METHODS\*(R"\s0 in SNMP::Info::Layer7 for details. .SH "MUNGES" .IX Header "MUNGES" .SH "SET METHODS" .IX Header "SET METHODS" These are methods that provide \s-1SNMP\s0 set functionality for overridden methods or provide a simpler interface to complex set operations. See \&\*(L"\s-1SETTING DATA VIA SNMP\*(R"\s0 in SNMP::Info for general information on set operations.