.\" 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::Altiga 3pm" .TH Info::Layer3::Altiga 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::Altiga \- SNMP Interface to Cisco (formerly Altiga) VPN concentrators .SH "AUTHOR" .IX Header "AUTHOR" Jeroen van Ingen Schenau .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 9 \& # Let SNMP::Info determine the correct subclass for you. \& my $altiga = new SNMP::Info( \& AutoSpecify => 1, \& Debug => 1, \& DestHost => \*(Aqmy_vpn_host\*(Aq, \& Community => \*(Aqpublic\*(Aq, \& Version => 1 \& ) \& or die "Can\*(Aqt connect to DestHost.\en"; \& \& my $class = $altiga\->class(); \& print "SNMP::Info determined this device to fall under subclass : $class\en"; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Subclass for Cisco (formerly Altiga) \s-1VPN\s0 concentrators .SS "Inherited Classes" .IX Subsection "Inherited Classes" .IP "SNMP::Info::Layer3" 4 .IX Item "SNMP::Info::Layer3" .SS "Required MIBs" .IX Subsection "Required MIBs" .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. .SH "Class Variables (options)" .IX Header "Class Variables (options)" .ie n .IP "$SNMP::Info::Layer3::Altiga::int_include_vpn" 4 .el .IP "\f(CW$SNMP::Info::Layer3::Altiga::int_include_vpn\fR" 4 .IX Item "$SNMP::Info::Layer3::Altiga::int_include_vpn" Variable to modify behavior of \*(L"interfaces\*(R" subroutine. .Sp .Vb 3 \& * When set to 0, "interfaces" returns only fixed interfaces from the IF\-MIB, \& * When set to 1, "interfaces" returns fixed interfaces from IF\-MIB and \& LAN\-to\-LAN tunnels from ALTIGA\-SESSION\-MIB (default) .Ve .SH "GLOBALS" .IX Header "GLOBALS" These are methods that return scalar value from \s-1SNMP\s0 .ie n .IP "$altiga\->\fIvendor()\fR" 4 .el .IP "\f(CW$altiga\fR\->\fIvendor()\fR" 4 .IX Item "$altiga->vendor()" Returns 'altiga' .ie n .IP "$altiga\->\fIos()\fR" 4 .el .IP "\f(CW$altiga\fR\->\fIos()\fR" 4 .IX Item "$altiga->os()" Returns 'altiga' .ie n .IP "$altiga\->\fIos_ver()\fR" 4 .el .IP "\f(CW$altiga\fR\->\fIos_ver()\fR" 4 .IX Item "$altiga->os_ver()" Tries to determine \s-1OS\s0 version from the \f(CW\*(C`sysDescr.0\*(C'\fR field. Returns version or \f(CW\*(C`sysDescr.0\*(C'\fR .ie n .IP "$altiga\->\fIfan()\fR" 4 .el .IP "\f(CW$altiga\fR\->\fIfan()\fR" 4 .IX Item "$altiga->fan()" Combines results from \f(CW\*(C`fan1_alarm\*(C'\fR, \f(CW\*(C`fan2_alarm\*(C'\fR, and \f(CW\*(C`fam3_alarm\*(C'\fR methods. .ie n .IP "$altiga\->\fIps1_status()\fR" 4 .el .IP "\f(CW$altiga\fR\->\fIps1_status()\fR" 4 .IX Item "$altiga->ps1_status()" Combines \f(CW\*(C`ps1_3v_alarm\*(C'\fR and \f(CW\*(C`ps1_5v_alarm\*(C'\fR methods. .ie n .IP "$altiga\->\fIps2_status()\fR" 4 .el .IP "\f(CW$altiga\fR\->\fIps2_status()\fR" 4 .IX Item "$altiga->ps2_status()" Combines \f(CW\*(C`ps2_3v_alarm\*(C'\fR and \f(CW\*(C`ps2_5v_alarm\*(C'\fR methods. .SH "TABLE METHODS" .IX Header "TABLE METHODS" These are methods that return tables of information in the form of a reference to a hash. .ie n .IP "$altiga\->\fIinterfaces()\fR" 4 .el .IP "\f(CW$altiga\fR\->\fIinterfaces()\fR" 4 .IX Item "$altiga->interfaces()" This method overrides the \fIinterfaces()\fR method inherited from SNMP::Info. It provides a mapping between the Interface Table Index (iid) and the physical port name, adding a port number to the port name to prevent duplicate names. .ie n .IP "$altiga\->\fIi_lastchange()\fR" 4 .el .IP "\f(CW$altiga\fR\->\fIi_lastchange()\fR" 4 .IX Item "$altiga->i_lastchange()" Filters out the results depending on the value of \f(CW$SNMP::Info::Layer3::Altiga::int_include_vpn\fR .ie n .IP "$altiga\->\fIi_type()\fR" 4 .el .IP "\f(CW$altiga\fR\->\fIi_type()\fR" 4 .IX Item "$altiga->i_type()" Filters out the results depending on the value of \f(CW$SNMP::Info::Layer3::Altiga::int_include_vpn\fR .SH "MUNGES" .IX Header "MUNGES" .IP "\fImunge_alarm()\fR" 4 .IX Item "munge_alarm()" Changes \f(CW\*(C`true\*(C'\fR and \f(CW\*(C`false\*(C'\fR to \f(CW\*(C`FAIL\*(C'\fR, \f(CW\*(C`OK\*(C'\fR, and \f(CW\*(C`(n/a)\*(C'\fR.