.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" 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
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" 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 "SNMP::Info::Layer1::Bayhub 3pm"
.TH SNMP::Info::Layer1::Bayhub 3pm "2023-09-30" "perl v5.36.0" "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::Layer1::Bayhub \- SNMP Interface to Bay/Nortel/Avaya Hubs
.SH "AUTHOR"
.IX Header "AUTHOR"
Eric Miller
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    #Let SNMP::Info determine the correct subclass for you.
\&
\&    my $bayhub = 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 = $bayhub\->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
Bay hub device through \s-1SNMP.\s0  Also provides device \s-1MAC\s0 to port mapping through
the proprietary \s-1MIB.\s0
.SS "Inherited Classes"
.IX Subsection "Inherited Classes"
.IP "SNMP::Info::Layer2" 4
.IX Item "SNMP::Info::Layer2"
.PD 0
.IP "SNMP::Info::NortelStack" 4
.IX Item "SNMP::Info::NortelStack"
.IP "SNMP::Info::SONMP" 4
.IX Item "SNMP::Info::SONMP"
.PD
.SS "Required MIBs"
.IX Subsection "Required MIBs"
.IP "\fIS5\-ETHERNET\-COMMON\-MIB\fR" 4
.IX Item "S5-ETHERNET-COMMON-MIB"
.PD 0
.IP "\fIS5\-COMMON\-STATS\-MIB\fR" 4
.IX Item "S5-COMMON-STATS-MIB"
.PD
.SS "Inherited MIBs"
.IX Subsection "Inherited MIBs"
See \*(L"Required MIBs\*(R" in SNMP::Info::Layer2 for its \s-1MIB\s0 requirements.
.PP
See \*(L"Required MIBs\*(R" in SNMP::Info::NortelStack for its \s-1MIB\s0 requirements.
.PP
See \*(L"Required MIBs\*(R" in SNMP::Info::SONMP for its \s-1MIB\s0 requirements.
.SH "GLOBALS"
.IX Header "GLOBALS"
These are methods that return scalar value from \s-1SNMP\s0
.ie n .IP "$bayhub\->\fBvendor()\fR" 4
.el .IP "\f(CW$bayhub\fR\->\fBvendor()\fR" 4
.IX Item "$bayhub->vendor()"
Returns 'avaya'
.ie n .IP "$bayhub\->\fBos()\fR" 4
.el .IP "\f(CW$bayhub\fR\->\fBos()\fR" 4
.IX Item "$bayhub->os()"
Returns 'bay_hub'
.ie n .IP "$bayhub\->\fBmodel()\fR" 4
.el .IP "\f(CW$bayhub\fR\->\fBmodel()\fR" 4
.IX Item "$bayhub->model()"
Cross references \f(CW$bayhub\fR\->\fBid()\fR to the \fISYNOPTICS-MIB\fR and returns
the results.
.Sp
Removes either Baystack Hub, 5000, or 5005 depending on the model.
.SS "Overrides"
.IX Subsection "Overrides"
.ie n .IP "$bayhub\->\fBlayers()\fR" 4
.el .IP "\f(CW$bayhub\fR\->\fBlayers()\fR" 4
.IX Item "$bayhub->layers()"
Returns 00000011.  Class emulates Layer 2 functionality through proprietary
MIBs.
.ie n .IP "$bayhub\->\fBindex_factor()\fR" 4
.el .IP "\f(CW$bayhub\fR\->\fBindex_factor()\fR" 4
.IX Item "$bayhub->index_factor()"
Required by SNMP::Info::SONMP.  Number representing the number of ports
reserved per slot within the device \s-1MIB.\s0  Returns 256.
.ie n .IP "$bayhub\->\fBslot_offset()\fR" 4
.el .IP "\f(CW$bayhub\fR\->\fBslot_offset()\fR" 4
.IX Item "$bayhub->slot_offset()"
Required by SNMP::Info::SONMP.  Offset if slot numbering does not
start at 0.  Returns 0.
.SS "Globals imported from SNMP::Info::Layer2"
.IX Subsection "Globals imported from SNMP::Info::Layer2"
See \*(L"\s-1GLOBALS\*(R"\s0 in SNMP::Info::Layer2 for details.
.SS "Global Methods imported from SNMP::Info::NortelStack"
.IX Subsection "Global Methods imported from SNMP::Info::NortelStack"
See \*(L"\s-1GLOBALS\*(R"\s0 in SNMP::Info::NortelStack for details.
.SS "Global Methods imported from SNMP::Info::SONMP"
.IX Subsection "Global Methods imported from SNMP::Info::SONMP"
See \*(L"\s-1GLOBALS\*(R"\s0 in SNMP::Info::SONMP 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 "$bayhub\->\fBi_index()\fR" 4
.el .IP "\f(CW$bayhub\fR\->\fBi_index()\fR" 4
.IX Item "$bayhub->i_index()"
Returns reference to map of IIDs to Interface index.
.Sp
Since hubs do not support \f(CW\*(C`ifIndex\*(C'\fR, the interface index is created using the
formula (board * 256 + port).
.ie n .IP "$bayhub\->\fBinterfaces()\fR" 4
.el .IP "\f(CW$bayhub\fR\->\fBinterfaces()\fR" 4
.IX Item "$bayhub->interfaces()"
Returns reference to map of IIDs to physical ports.
.ie n .IP "$bayhub\->\fBi_duplex()\fR" 4
.el .IP "\f(CW$bayhub\fR\->\fBi_duplex()\fR" 4
.IX Item "$bayhub->i_duplex()"
Returns half, hubs do not support full duplex.
.ie n .IP "$bayhub\->\fBi_duplex_admin()\fR" 4
.el .IP "\f(CW$bayhub\fR\->\fBi_duplex_admin()\fR" 4
.IX Item "$bayhub->i_duplex_admin()"
Returns half, hubs do not support full duplex.
.ie n .IP "$bayhub\->\fBi_speed()\fR" 4
.el .IP "\f(CW$bayhub\fR\->\fBi_speed()\fR" 4
.IX Item "$bayhub->i_speed()"
Returns interface speed.
.ie n .IP "$bayhub\->\fBi_up()\fR" 4
.el .IP "\f(CW$bayhub\fR\->\fBi_up()\fR" 4
.IX Item "$bayhub->i_up()"
Returns (\f(CW\*(C`s5EnPortLinkStatus\*(C'\fR) for each port.  Translates on/off to up/down.
.ie n .IP "$bayhub\->\fBi_up_admin()\fR" 4
.el .IP "\f(CW$bayhub\fR\->\fBi_up_admin()\fR" 4
.IX Item "$bayhub->i_up_admin()"
Returns (\f(CW\*(C`s5EnPortPartStatus\*(C'\fR) for each port.
.ie n .IP "$bayhub\->set_i_up_admin(state, ifIndex)" 4
.el .IP "\f(CW$bayhub\fR\->set_i_up_admin(state, ifIndex)" 4
.IX Item "$bayhub->set_i_up_admin(state, ifIndex)"
Sets port state, must be supplied with state and port \f(CW\*(C`ifIndex\*(C'\fR
.Sp
State choices are 'up' or 'down'
.Sp
Example:
  my \f(CW%if_map\fR = reverse %{$bayhub\->\fBinterfaces()\fR};
  \f(CW$bayhub\fR\->set_i_up_admin('down', \f(CW$if_map\fR{'1.1'})
      or die \*(L"Couldn't change port state. \*(R",$bayhub\->\fBerror\fR\|(1);
.ie n .IP "$bayhub\->\fBbp_index()\fR" 4
.el .IP "\f(CW$bayhub\fR\->\fBbp_index()\fR" 4
.IX Item "$bayhub->bp_index()"
Simulates bridge \s-1MIB\s0 by returning reference to a hash containing the index for
both the keys and values.
.ie n .IP "$bayhub\->\fBfw_port()\fR" 4
.el .IP "\f(CW$bayhub\fR\->\fBfw_port()\fR" 4
.IX Item "$bayhub->fw_port()"
Returns reference to map of IIDs of the \f(CW\*(C`S5\-COMMON\-STATS\-MIB::s5CmSNodeTable\*(C'\fR
to the Interface index.
.ie n .IP "$bayhub\->\fBfw_mac()\fR" 4
.el .IP "\f(CW$bayhub\fR\->\fBfw_mac()\fR" 4
.IX Item "$bayhub->fw_mac()"
(\f(CW\*(C`s5CmSNodeMacAddr\*(C'\fR)
.SS "Pseudo \fIENTITY-MIB\fP Information"
.IX Subsection "Pseudo ENTITY-MIB Information"
These devices do not support \fIENTITY-MIB\fR.  These methods emulate Physical
Table methods using \fIS5\-CHASSIS\-MIB\fR.  See
\&\*(L"\s-1TABLE METHODS\*(R"\s0 in SNMP::Info::NortelStack for details.
.ie n .IP "$bayhub\->\fBe_index()\fR" 4
.el .IP "\f(CW$bayhub\fR\->\fBe_index()\fR" 4
.IX Item "$bayhub->e_index()"
Returns \fBns_e_index()\fR.
.ie n .IP "$bayhub\->\fBe_class()\fR" 4
.el .IP "\f(CW$bayhub\fR\->\fBe_class()\fR" 4
.IX Item "$bayhub->e_class()"
Returns \fBns_e_class()\fR.
.ie n .IP "$bayhub\->\fBe_descr()\fR" 4
.el .IP "\f(CW$bayhub\fR\->\fBe_descr()\fR" 4
.IX Item "$bayhub->e_descr()"
Returns \fBns_e_descr()\fR.
.ie n .IP "$bayhub\->\fBe_name()\fR" 4
.el .IP "\f(CW$bayhub\fR\->\fBe_name()\fR" 4
.IX Item "$bayhub->e_name()"
Returns \fBns_e_name()\fR.
.ie n .IP "$bayhub\->\fBe_fwver()\fR" 4
.el .IP "\f(CW$bayhub\fR\->\fBe_fwver()\fR" 4
.IX Item "$bayhub->e_fwver()"
Returns \fBns_e_fwver()\fR.
.ie n .IP "$bayhub\->\fBe_hwver()\fR" 4
.el .IP "\f(CW$bayhub\fR\->\fBe_hwver()\fR" 4
.IX Item "$bayhub->e_hwver()"
Returns \fBns_e_hwver()\fR.
.ie n .IP "$bayhub\->\fBe_parent()\fR" 4
.el .IP "\f(CW$bayhub\fR\->\fBe_parent()\fR" 4
.IX Item "$bayhub->e_parent()"
Returns \fBns_e_parent()\fR.
.ie n .IP "$bayhub\->\fBe_pos()\fR" 4
.el .IP "\f(CW$bayhub\fR\->\fBe_pos()\fR" 4
.IX Item "$bayhub->e_pos()"
Returns \fBns_e_pos()\fR.
.ie n .IP "$bayhub\->\fBe_serial()\fR" 4
.el .IP "\f(CW$bayhub\fR\->\fBe_serial()\fR" 4
.IX Item "$bayhub->e_serial()"
Returns \fBns_e_serial()\fR.
.ie n .IP "$bayhub\->\fBe_swver()\fR" 4
.el .IP "\f(CW$bayhub\fR\->\fBe_swver()\fR" 4
.IX Item "$bayhub->e_swver()"
Returns \fBns_e_swver()\fR.
.ie n .IP "$bayhub\->\fBe_type()\fR" 4
.el .IP "\f(CW$bayhub\fR\->\fBe_type()\fR" 4
.IX Item "$bayhub->e_type()"
Returns \fBns_e_type()\fR.
.ie n .IP "$bayhub\->\fBe_vendor()\fR" 4
.el .IP "\f(CW$bayhub\fR\->\fBe_vendor()\fR" 4
.IX Item "$bayhub->e_vendor()"
Returns \fBns_e_vendor()\fR.
.SS "Table Methods imported from SNMP::Info::Layer2"
.IX Subsection "Table Methods imported from SNMP::Info::Layer2"
See \*(L"\s-1TABLE METHODS\*(R"\s0 in SNMP::Info::Layer2 for details.
.SS "Table Methods imported from SNMP::Info::NortelStack"
.IX Subsection "Table Methods imported from SNMP::Info::NortelStack"
See \*(L"\s-1TABLE METHODS\*(R"\s0 in SNMP::Info::NortelStack for details.
.SS "Table Methods imported from SNMP::Info::SONMP"
.IX Subsection "Table Methods imported from SNMP::Info::SONMP"
See \*(L"\s-1TABLE METHODS\*(R"\s0 in SNMP::Info::SONMP for details.