.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
.\"
.\" 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" ''
'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 turned on, 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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Info::Layer3::Foundry 3pm"
.TH Info::Layer3::Foundry 3pm "2011-09-28" "perl v5.12.4" "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::Foundry \- SNMP Interface to Foundry Network Devices
.SH "AUTHOR"
.IX Header "AUTHOR"
Max Baker
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 9
\& # Let SNMP::Info determine the correct subclass for you. 
\& my $foundry = new SNMP::Info(
\&                          AutoSpecify => 1,
\&                          Debug       => 1,
\&                          DestHost    => \*(Aqmyswitch\*(Aq,
\&                          Community   => \*(Aqpublic\*(Aq,
\&                          Version     => 1
\&                        ) 
\&    or die "Can\*(Aqt connect to DestHost.\en";
\&
\& my $class = $foundry\->class();
\&
\& print "SNMP::Info determined this device to fall under subclass : $class\en";
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Abstraction subclass for Foundry Networks devices.
.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 $foundry = new SNMP::Info::Layer3::Foundry(...);
.Ve
.SS "Inherited Classes"
.IX Subsection "Inherited Classes"
.IP "SNMP::Info::Layer3;" 4
.IX Item "SNMP::Info::Layer3;"
.PD 0
.IP "SNMP::Info::FDP;" 4
.IX Item "SNMP::Info::FDP;"
.IP "SNMP::Info::LLDP;" 4
.IX Item "SNMP::Info::LLDP;"
.PD
.SS "Required MIBs"
.IX Subsection "Required MIBs"
.IP "\fIFOUNDRY-SN-ROOT-MIB\fR" 4
.IX Item "FOUNDRY-SN-ROOT-MIB"
.PD 0
.IP "\fIFOUNDRY-SN-AGENT-MIB\fR" 4
.IX Item "FOUNDRY-SN-AGENT-MIB"
.IP "\fIFOUNDRY-SN-SWITCH-GROUP-MIB\fR" 4
.IX Item "FOUNDRY-SN-SWITCH-GROUP-MIB"
.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::FDP 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 value from \s-1SNMP\s0
.ie n .IP "$foundry\->\fImodel()\fR" 4
.el .IP "\f(CW$foundry\fR\->\fImodel()\fR" 4
.IX Item "$foundry->model()"
Returns model type.  Checks \f(CW$foundry\fR\->\fIid()\fR against the \fIFOUNDRY-SN-ROOT-MIB\fR
and removes '\f(CW\*(C`sn\*(C'\fR'.  EdgeIron models determined through \fIENTITY-MIB\fR.
.ie n .IP "$foundry\->\fIvendor()\fR" 4
.el .IP "\f(CW$foundry\fR\->\fIvendor()\fR" 4
.IX Item "$foundry->vendor()"
Returns 'foundry'
.ie n .IP "$foundry\->\fIos()\fR" 4
.el .IP "\f(CW$foundry\fR\->\fIos()\fR" 4
.IX Item "$foundry->os()"
Returns 'foundry'
.ie n .IP "$foundry\->\fIos_ver()\fR" 4
.el .IP "\f(CW$foundry\fR\->\fIos_ver()\fR" 4
.IX Item "$foundry->os_ver()"
Returns the software version
.ie n .IP "$foundry\->\fImac()\fR" 4
.el .IP "\f(CW$foundry\fR\->\fImac()\fR" 4
.IX Item "$foundry->mac()"
Returns \s-1MAC\s0 Address of root port.
.Sp
(\f(CW\*(C`ifPhysAddress.1\*(C'\fR)
.ie n .IP "$foundry\->\fIchassis()\fR" 4
.el .IP "\f(CW$foundry\fR\->\fIchassis()\fR" 4
.IX Item "$foundry->chassis()"
Returns Chassis type.
.Sp
(\f(CW\*(C`entPhysicalDescr.1\*(C'\fR)
.ie n .IP "$foundry\->\fIserial()\fR" 4
.el .IP "\f(CW$foundry\fR\->\fIserial()\fR" 4
.IX Item "$foundry->serial()"
Returns serial number of device.
.ie n .IP "$foundry\->\fItemp()\fR" 4
.el .IP "\f(CW$foundry\fR\->\fItemp()\fR" 4
.IX Item "$foundry->temp()"
Returns the chassis temperature
.Sp
(\f(CW\*(C`snChasActualTemperature\*(C'\fR)
.ie n .IP "$foundry\->\fIps1_type()\fR" 4
.el .IP "\f(CW$foundry\fR\->\fIps1_type()\fR" 4
.IX Item "$foundry->ps1_type()"
Returns the Description for the power supply
.Sp
(\f(CW\*(C`snChasPwrSupplyDescription.1\*(C'\fR)
.ie n .IP "$foundry\->\fIps1_status()\fR" 4
.el .IP "\f(CW$foundry\fR\->\fIps1_status()\fR" 4
.IX Item "$foundry->ps1_status()"
Returns the status of the power supply.
.Sp
(\f(CW\*(C`snChasPwrSupplyOperStatus.1\*(C'\fR)
.ie n .IP "$foundry\->\fIfan()\fR" 4
.el .IP "\f(CW$foundry\fR\->\fIfan()\fR" 4
.IX Item "$foundry->fan()"
Returns the status of the chassis fan.
.Sp
(\f(CW\*(C`snChasFanOperStatus.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\s0\*(R" in SNMP::Info::Layer3 for details.
.SS "Global Methods imported from SNMP::Info::FDP"
.IX Subsection "Global Methods imported from SNMP::Info::FDP"
See documentation in \*(L"\s-1GLOBALS\s0\*(R" in SNMP::Info::FDP for details.
.SS "Global Methods imported from SNMP::Info::LLDP"
.IX Subsection "Global Methods imported from SNMP::Info::LLDP"
See documentation in \*(L"\s-1GLOBALS\s0\*(R" in SNMP::Info::LLDP 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"
.ie n .IP "$foundry\->\fIinterfaces()\fR" 4
.el .IP "\f(CW$foundry\fR\->\fIinterfaces()\fR" 4
.IX Item "$foundry->interfaces()"
Returns reference to hash of interface names to iids.
.ie n .IP "$foundry\->\fIi_ignore()\fR" 4
.el .IP "\f(CW$foundry\fR\->\fIi_ignore()\fR" 4
.IX Item "$foundry->i_ignore()"
Returns reference to hash of interfaces to be ignored.
.Sp
Ignores interfaces with descriptions of  tunnel,loopback,null
.ie n .IP "$foundry\->\fIi_duplex()\fR" 4
.el .IP "\f(CW$foundry\fR\->\fIi_duplex()\fR" 4
.IX Item "$foundry->i_duplex()"
Returns reference to hash of interface link duplex status.
.Sp
Crosses \f(CW$foundry\fR\->\fIsw_duplex()\fR with \f(CW$foundry\fR\->\fIsw_index()\fR
.ie n .IP "$foundry\->\fIstp_p_state()\fR" 4
.el .IP "\f(CW$foundry\fR\->\fIstp_p_state()\fR" 4
.IX Item "$foundry->stp_p_state()"
"The port's current state as defined by application of the Spanning Tree
Protocol.
.Sp
Skipped if device is an EdgeIron 24G due to reports of hangs.
.Sp
(\f(CW\*(C`dot1dStpPortState\*(C'\fR)
.ie n .SS "Foundry Switch Port Information Table (""snSwPortIfTable"")"
.el .SS "Foundry Switch Port Information Table (\f(CWsnSwPortIfTable\fP)"
.IX Subsection "Foundry Switch Port Information Table (snSwPortIfTable)"
.ie n .IP "$foundry\->\fIsw_index()\fR" 4
.el .IP "\f(CW$foundry\fR\->\fIsw_index()\fR" 4
.IX Item "$foundry->sw_index()"
Returns reference to hash.  Maps Table to Interface \s-1IID\s0.
.Sp
(\f(CW\*(C`snSwPortIfIndex\*(C'\fR)
.ie n .IP "$foundry\->\fIsw_duplex()\fR" 4
.el .IP "\f(CW$foundry\fR\->\fIsw_duplex()\fR" 4
.IX Item "$foundry->sw_duplex()"
Returns reference to hash.   Current duplex status for switch ports.
.Sp
(\f(CW\*(C`snSwPortInfoChnMode\*(C'\fR)
.ie n .IP "$foundry\->\fIsw_type()\fR" 4
.el .IP "\f(CW$foundry\fR\->\fIsw_type()\fR" 4
.IX Item "$foundry->sw_type()"
Returns reference to hash.  Current Port Type .
.Sp
(\f(CW\*(C`snSwPortInfoMediaType\*(C'\fR)
.ie n .IP "$foundry\->\fIsw_speed()\fR" 4
.el .IP "\f(CW$foundry\fR\->\fIsw_speed()\fR" 4
.IX Item "$foundry->sw_speed()"
Returns reference to hash.  Current Port Speed.
.Sp
(\f(CW\*(C`snSwPortInfoSpeed\*(C'\fR)
.SS "Topology information"
.IX Subsection "Topology information"
Based upon the software version devices may support Foundry Discovery
Protocol (\s-1FDP\s0) and Link Layer Discovery Protocol (\s-1LLDP\s0). These
methods will query both and return the combination of all information. As a
result, there may be identical topology information returned from the two
protocols causing duplicate entries.  It is the calling program's
responsibility to identify any duplicate entries and remove duplicates if
necessary.
.ie n .IP "$foundry\->\fIhasCDP()\fR" 4
.el .IP "\f(CW$foundry\fR\->\fIhasCDP()\fR" 4
.IX Item "$foundry->hasCDP()"
Returns true if the device is running either \s-1FDP\s0 or \s-1LLDP\s0.
.ie n .IP "$foundry\->\fIc_if()\fR" 4
.el .IP "\f(CW$foundry\fR\->\fIc_if()\fR" 4
.IX Item "$foundry->c_if()"
Returns reference to hash.  Key: iid Value: local device port (interfaces)
.ie n .IP "$foundry\->\fIc_ip()\fR" 4
.el .IP "\f(CW$foundry\fR\->\fIc_ip()\fR" 4
.IX Item "$foundry->c_ip()"
Returns reference to hash.  Key: iid Value: remote IPv4 address
.Sp
If multiple entries exist with the same local port, \fIc_if()\fR, with the same IPv4
address, \fIc_ip()\fR, it may be a duplicate entry.
.Sp
If multiple entries exist with the same local port, \fIc_if()\fR, with different
IPv4 addresses, \fIc_ip()\fR, there is either a non\-FDP/LLDP device in between two
or more devices or multiple devices which are not directly connected.
.Sp
Use the data from the Layer2 Topology Table below to dig deeper.
.ie n .IP "$foundry\->\fIc_port()\fR" 4
.el .IP "\f(CW$foundry\fR\->\fIc_port()\fR" 4
.IX Item "$foundry->c_port()"
Returns reference to hash. Key: iid Value: remote port (interfaces)
.ie n .IP "$foundry\->\fIc_id()\fR" 4
.el .IP "\f(CW$foundry\fR\->\fIc_id()\fR" 4
.IX Item "$foundry->c_id()"
Returns reference to hash. Key: iid Value: string value used to identify the
chassis component associated with the remote system.
.ie n .IP "$foundry\->\fIc_platform()\fR" 4
.el .IP "\f(CW$foundry\fR\->\fIc_platform()\fR" 4
.IX Item "$foundry->c_platform()"
Returns reference to hash.  Key: iid Value: Remote Device Type
.SS "Table Methods imported from SNMP::Info::Layer3"
.IX Subsection "Table Methods imported from SNMP::Info::Layer3"
See documentation in \*(L"\s-1TABLE\s0 \s-1METHODS\s0\*(R" in SNMP::Info::Layer3 for details.
.SS "Table Methods imported from SNMP::Info::FDP"
.IX Subsection "Table Methods imported from SNMP::Info::FDP"
See documentation in \*(L"\s-1TABLE\s0 \s-1METHODS\s0\*(R" in SNMP::Info::FDP 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\s0 \s-1METHODS\s0\*(R" in SNMP::Info::LLDP for details.