.\" 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::Layer3::Nexus 3pm"
.TH SNMP::Info::Layer3::Nexus 3pm "2023-02-21" "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::Layer3::Nexus \- SNMP Interface to Cisco Nexus Switches running
NX\-OS
.SH "AUTHOR"
.IX Header "AUTHOR"
Eric Miller
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 10
\& # Let SNMP::Info determine the correct subclass for you.
\& my $nexus = new SNMP::Info(
\&                                                AutoSpecify => 1,
\&                                                Debug       => 1,
\&                                                # These arguments are passed directly to SNMP::Session
\&                                                DestHost    => \*(Aqmyswitch\*(Aq,
\&                                                Community   => \*(Aqpublic\*(Aq,
\&                                                Version     => 2
\&                                                )
\&        or die "Can\*(Aqt connect to DestHost.\en";
\&
\& my $class      = $nexus\->class();
\& print "SNMP::Info determined this device to fall under subclass : $class\en";
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Abstraction subclass for Cisco Nexus Switches running NX-OS.
.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 $nexus = new SNMP::Info::Layer3::Nexus(...);
.Ve
.SS "Inherited Classes"
.IX Subsection "Inherited Classes"
.IP "SNMP::Info::Layer3::CiscoSwitch" 4
.IX Item "SNMP::Info::Layer3::CiscoSwitch"
.SS "Required MIBs"
.IX Subsection "Required MIBs"
.PD 0
.IP "\fICISCO-ENTITY-VENDORTYPE-OID-MIB\fR" 4
.IX Item "CISCO-ENTITY-VENDORTYPE-OID-MIB"
.IP "\fICISCO-CONTEXT-MAPPING-MIB\fR" 4
.IX Item "CISCO-CONTEXT-MAPPING-MIB"
.IP "Inherited Classes' MIBs" 4
.IX Item "Inherited Classes' MIBs"
.PD
See \*(L"Required MIBs\*(R" in SNMP::Info::Layer3::CiscoSwitch for its own \s-1MIB\s0
requirements.
.SH "GLOBALS"
.IX Header "GLOBALS"
These are methods that return a scalar value from \s-1SNMP\s0
.ie n .IP "$nexus\->\fBos()\fR" 4
.el .IP "\f(CW$nexus\fR\->\fBos()\fR" 4
.IX Item "$nexus->os()"
Returns \f(CW\*(Aqnx\-os\*(Aq\fR
.ie n .IP "$nexus\->\fBos_ver()\fR" 4
.el .IP "\f(CW$nexus\fR\->\fBos_ver()\fR" 4
.IX Item "$nexus->os_ver()"
Returns operating system version extracted from \f(CW\*(C`sysDescr\*(C'\fR.
.ie n .IP "$nexus\->\fBserial()\fR" 4
.el .IP "\f(CW$nexus\fR\->\fBserial()\fR" 4
.IX Item "$nexus->serial()"
Returns the serial number of the chassis from \fIENTITY-MIB\fR.
.ie n .IP "$nexus\->\fBmodel()\fR" 4
.el .IP "\f(CW$nexus\fR\->\fBmodel()\fR" 4
.IX Item "$nexus->model()"
Tries to reference \f(CW$nexus\fR\->\fBid()\fR to \fICISCO-ENTITY-VENDORTYPE-OID-MIB\fR
.Sp
Removes \f(CW\*(AqcevChassis\*(Aq\fR for readability.
.ie n .IP "$nexus\->\fBmac()\fR" 4
.el .IP "\f(CW$nexus\fR\->\fBmac()\fR" 4
.IX Item "$nexus->mac()"
\&\f(CW\*(C`dot1dBaseBridgeAddress\*(C'\fR
.SS "Overrides"
.IX Subsection "Overrides"
\fI\s-1IP\s0 Address Table\fR
.IX Subsection "IP Address Table"
.PP
Each entry in this table is an \s-1IP\s0 address in use on this device.  Some
versions do not index the table with the IPv4 address in accordance with
the \s-1MIB\s0 definition, these overrides correct that behavior.
.PP
Also, the table is augmented with \s-1IP\s0 addresses in use by \s-1UDP\s0 sockets on the
device, as determined by checking \fIRFC1213\-MIB::udpLocalAddress\fR. Valid
addresses from this table (any IPv4 that is not localhost, 0.0.0.0, Class D
(multicast) or Class E (experimental) are added as a /32 on interface \s-1ID 0.\s0
This is a workaround to determine possible \s-1VPC\s0 Keepalive \s-1IP\s0 addresses on the
device, which are probably advertised by \s-1CDP/LLDP\s0 to neighbors.
.ie n .IP "$nexus\->\fBip_index()\fR" 4
.el .IP "\f(CW$nexus\fR\->\fBip_index()\fR" 4
.IX Item "$nexus->ip_index()"
Maps the \s-1IP\s0 Table to the \s-1IID\s0
.Sp
(\f(CW\*(C`ipAdEntIfIndex\*(C'\fR)
.ie n .IP "$nexus\->\fBip_table()\fR" 4
.el .IP "\f(CW$nexus\fR\->\fBip_table()\fR" 4
.IX Item "$nexus->ip_table()"
Maps the Table to the \s-1IP\s0 address
.Sp
(\f(CW\*(C`ipAdEntAddr\*(C'\fR)
.ie n .IP "$nexus\->\fBip_netmask()\fR" 4
.el .IP "\f(CW$nexus\fR\->\fBip_netmask()\fR" 4
.IX Item "$nexus->ip_netmask()"
Gives netmask setting for \s-1IP\s0 table entry.
.Sp
(\f(CW\*(C`ipAdEntNetMask\*(C'\fR)
.ie n .IP "$nexus\->\fBip_broadcast()\fR" 4
.el .IP "\f(CW$nexus\fR\->\fBip_broadcast()\fR" 4
.IX Item "$nexus->ip_broadcast()"
Gives broadcast address for \s-1IP\s0 table entry.
.Sp
(\f(CW\*(C`ipAdEntBcastAddr\*(C'\fR)
.ie n .IP "$nexus\->\fBlldp_lport_desc()\fR" 4
.el .IP "\f(CW$nexus\fR\->\fBlldp_lport_desc()\fR" 4
.IX Item "$nexus->lldp_lport_desc()"
On nx-os 6 only this will return data from \f(CW\*(C`lldpLocPortId\*(C'\fR instead of
the expected \f(CW\*(C`lldpLocPortDesc\*(C'\fR. For all other nx-os versions uses the
function from SNMP::Info::LLDP.
.SS "Globals imported from SNMP::Info::Layer3::CiscoSwitch"
.IX Subsection "Globals imported from SNMP::Info::Layer3::CiscoSwitch"
See documentation in \*(L"\s-1GLOBALS\*(R"\s0 in SNMP::Info::Layer3::CiscoSwitch 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 "Table Methods imported from SNMP::Info::Layer3::CiscoSwitch"
.IX Subsection "Table Methods imported from SNMP::Info::Layer3::CiscoSwitch"
See documentation in \*(L"\s-1TABLE METHODS\*(R"\s0 in SNMP::Info::Layer3::CiscoSwitch for
details.