.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35) .\" .\" 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::Juniper 3pm" .TH SNMP::Info::Layer3::Juniper 3pm "2019-02-25" "perl v5.28.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::Juniper \- SNMP Interface to L3 Juniper Devices .SH "AUTHOR" .IX Header "AUTHOR" Bill Fenner .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 9 \& # Let SNMP::Info determine the correct subclass for you. \& my $juniper = new SNMP::Info( \& AutoSpecify => 1, \& Debug => 1, \& DestHost => \*(Aqmyrouter\*(Aq, \& Community => \*(Aqpublic\*(Aq, \& Version => 2 \& ) \& or die "Can\*(Aqt connect to DestHost.\en"; \& \& my $class = $juniper\->class(); \& print "SNMP::Info determined this device to fall under subclass : $class\en"; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Subclass for Juniper Devices running \s-1JUNOS\s0 .SS "Inherited Classes" .IX Subsection "Inherited Classes" .IP "SNMP::Info::Layer3" 4 .IX Item "SNMP::Info::Layer3" .PD 0 .IP "SNMP::Info::LLDP" 4 .IX Item "SNMP::Info::LLDP" .PD .SS "Required MIBs" .IX Subsection "Required MIBs" .ie n .IP "\fIJUNIPER-VLAN-MIB\fR dated ""200901090000Z"" or later." 4 .el .IP "\fIJUNIPER-VLAN-MIB\fR dated ``200901090000Z'' or later." 4 .IX Item "JUNIPER-VLAN-MIB dated 200901090000Z or later." .PD 0 .IP "\fIJUNIPER-CHASSIS-DEFINES-MIB\fR" 4 .IX Item "JUNIPER-CHASSIS-DEFINES-MIB" .IP "\fIJUNIPER-MIB\fR" 4 .IX Item "JUNIPER-MIB" .IP "\fIJUNIPER-VIRTUALCHASSIS-MIB\fR" 4 .IX Item "JUNIPER-VIRTUALCHASSIS-MIB" .IP "\fI\s-1JUNIPER\-L2ALD\-MIB\s0\fR" 4 .IX Item "JUNIPER-L2ALD-MIB" .PD .SS "Inherited Classes' MIBs" .IX Subsection "Inherited Classes' MIBs" See \*(L"Required MIBs\*(R" in SNMP::Info::Layer3 for its own \s-1MIB\s0 requirements. .PP 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 "$juniper\->\fBvendor()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fBvendor()\fR" 4 .IX Item "$juniper->vendor()" Returns 'juniper' .ie n .IP "$juniper\->\fBos()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fBos()\fR" 4 .IX Item "$juniper->os()" Returns 'junos' .ie n .IP "$juniper\->\fBlayers()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fBlayers()\fR" 4 .IX Item "$juniper->layers()" Checks forwarding table for Layer 2 support since some routers with switches do not report layers properly. .ie n .IP "$juniper\->\fBos_ver()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fBos_ver()\fR" 4 .IX Item "$juniper->os_ver()" Returns the software version extracted first from \f(CW\*(C`sysDescr\*(C'\fR or \&\f(CW\*(C`lldpLocSysDesc\*(C'\fR if not available in \f(CW\*(C`sysDescr\*(C'\fR. .ie n .IP "$juniper\->\fBmodel()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fBmodel()\fR" 4 .IX Item "$juniper->model()" Returns the model from \f(CW\*(C`sysObjectID\*(C'\fR, with \f(CW\*(C`jnxProductName\*(C'\fR removed from the beginning. .ie n .IP "$juniper\->\fBserial()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fBserial()\fR" 4 .IX Item "$juniper->serial()" Returns serial number .Sp (\f(CW\*(C`jnxBoxSerialNo\*(C'\fR) .ie n .IP "$juniper\->\fBmac()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fBmac()\fR" 4 .IX Item "$juniper->mac()" Returns the \s-1MAC\s0 address used by this bridge when it must be referred to in a unique fashion. .Sp (\f(CW\*(C`dot1dBaseBridgeAddress\*(C'\fR) .ie n .IP "$juniper\->\fBbox_descr()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fBbox_descr()\fR" 4 .IX Item "$juniper->box_descr()" The name, model, or detailed description of the device. .Sp (\f(CW\*(C`jnxBoxDescr\*(C'\fR) .ie n .IP "$juniper\->\fBversion()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fBversion()\fR" 4 .IX Item "$juniper->version()" (\f(CW\*(C`jnxVirtualChassisMemberSWVersion\*(C'\fR) .ie n .IP "$juniper\->\fBvc_model()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fBvc_model()\fR" 4 .IX Item "$juniper->vc_model()" (\f(CW\*(C`jnxVirtualChassisMemberModel\*(C'\fR) .SS "Globals imported from SNMP::Info::Layer3" .IX Subsection "Globals imported from SNMP::Info::Layer3" See documentation in \*(L"\s-1GLOBALS\*(R"\s0 in SNMP::Info::Layer3 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\*(R"\s0 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. .ie n .IP "$juniper\->\fBqb_fdb_index()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fBqb_fdb_index()\fR" 4 .IX Item "$juniper->qb_fdb_index()" Returns reference to hash: key = \s-1FDB ID,\s0 value = \s-1VLAN ID.\s0 .ie n .IP "$juniper\->\fBv_index()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fBv_index()\fR" 4 .IX Item "$juniper->v_index()" Returns (\f(CW\*(C`jnxL2aldVlanTag\*(C'\fR) or (\f(CW\*(C`jnxExVlanTag\*(C'\fR) depending upon switch software version .ie n .IP "$juniper\->\fBv_name()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fBv_name()\fR" 4 .IX Item "$juniper->v_name()" Returns (\f(CW\*(C`jnxL2aldVlanName\*(C'\fR) or (\f(CW\*(C`jnxExVlanName\*(C'\fR) depending upon switch software version .ie n .IP "$juniper\->\fBv_type()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fBv_type()\fR" 4 .IX Item "$juniper->v_type()" Returns (\f(CW\*(C`jnxL2aldVlanType\*(C'\fR) or (\f(CW\*(C`jnxExVlanType\*(C'\fR) depending upon switch software version .ie n .IP "$juniper\->\fBi_trunk()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fBi_trunk()\fR" 4 .IX Item "$juniper->i_trunk()" (\f(CW\*(C`jnxExVlanPortAccessMode\*(C'\fR) .ie n .IP "$juniper\->\fBi_vlan()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fBi_vlan()\fR" 4 .IX Item "$juniper->i_vlan()" Returns a mapping between \f(CW\*(C`ifIndex\*(C'\fR and the \s-1PVID\s0 or default \s-1VLAN.\s0 .ie n .IP "$juniper\->\fBi_vlan_membership()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fBi_vlan_membership()\fR" 4 .IX Item "$juniper->i_vlan_membership()" Returns reference to hash of arrays: key = \f(CW\*(C`ifIndex\*(C'\fR, value = array of \s-1VLAN\s0 IDs. These are the VLANs which are members of the egress list for the port. .ie n .IP "$juniper\->\fBi_vlan_membership_untagged()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fBi_vlan_membership_untagged()\fR" 4 .IX Item "$juniper->i_vlan_membership_untagged()" Returns reference to hash of arrays: key = \f(CW\*(C`ifIndex\*(C'\fR, value = array of \s-1VLAN\s0 IDs. These are the VLANs which are members of the untagged egress list for the port. .ie n .IP "$juniper\->\fBpeth_port_ifindex()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fBpeth_port_ifindex()\fR" 4 .IX Item "$juniper->peth_port_ifindex()" Returns reference to a hash: key= PowerEthernet \s-1MIB\s0 interface number, value = \f(CW\*(C`ifIndex\*(C'\fR. As Juniper does not provide a mapping function, this does it manually. For example, ge\-0/0/1 registers as PowerEthernet interface '1.2' .SS "Pseudo \fIENTITY-MIB\fP information" .IX Subsection "Pseudo ENTITY-MIB information" These methods emulate \fIENTITY-MIB\fR Physical Table methods using \&\fIJUNIPER-MIB\fR and \fIJUNIPER-VIRTUALCHASSIS-MIB\fR. .ie n .IP "$juniper\->\fBe_index()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fBe_index()\fR" 4 .IX Item "$juniper->e_index()" Returns reference to hash. Key: \s-1IID,\s0 Value: Integer, Indices are combined into a eight digit integer, each index is two digits padded with leading zero if required. .ie n .IP "$juniper\->\fBe_class()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fBe_class()\fR" 4 .IX Item "$juniper->e_class()" Returns reference to hash. Key: \s-1IID,\s0 Value: General hardware type. .ie n .IP "$juniper\->\fBe_descr()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fBe_descr()\fR" 4 .IX Item "$juniper->e_descr()" Returns reference to hash. Key: \s-1IID,\s0 Value: Human friendly name .ie n .IP "$juniper\->\fBe_hwver()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fBe_hwver()\fR" 4 .IX Item "$juniper->e_hwver()" Returns reference to hash. Key: \s-1IID,\s0 Value: Hardware version .ie n .IP "$juniper\->\fBe_vendor()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fBe_vendor()\fR" 4 .IX Item "$juniper->e_vendor()" Returns reference to hash. Key: \s-1IID,\s0 Value: juniper .ie n .IP "$juniper\->\fBe_serial()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fBe_serial()\fR" 4 .IX Item "$juniper->e_serial()" Returns reference to hash. Key: \s-1IID,\s0 Value: Serial number .ie n .IP "$juniper\->\fBe_pos()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fBe_pos()\fR" 4 .IX Item "$juniper->e_pos()" Returns reference to hash. Key: \s-1IID,\s0 Value: The relative position among all entities sharing the same parent. .ie n .IP "$juniper\->\fBe_type()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fBe_type()\fR" 4 .IX Item "$juniper->e_type()" Returns reference to hash. Key: \s-1IID,\s0 Value: Type of component/sub\-component as defined in \fIJUNIPER-CHASSIS-DEFINES-MIB\fR. .ie n .IP "$juniper\->\fBe_parent()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fBe_parent()\fR" 4 .IX Item "$juniper->e_parent()" Returns reference to hash. Key: \s-1IID,\s0 Value: The value of \fBe_index()\fR for the entity which 'contains' this entity. A value of zero indicates this entity is not contained in any other entity. .ie n .IP "$entity\->\fBe_fru()\fR" 4 .el .IP "\f(CW$entity\fR\->\fBe_fru()\fR" 4 .IX Item "$entity->e_fru()" \&\s-1BOOLEAN.\s0 Is a Field Replaceable unit? .Sp (\f(CW\*(C`entPhysicalFRU\*(C'\fR) .SS "Table Methods imported from SNMP::Info::Layer3" .IX Subsection "Table Methods imported from SNMP::Info::Layer3" See documentation in \*(L"\s-1TABLE METHODS\*(R"\s0 in SNMP::Info::Layer3 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 METHODS\*(R"\s0 in SNMP::Info::LLDP for details.