.\" 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::Juniper 3pm" .TH Info::Layer3::Juniper 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::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" .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\->\fIvendor()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fIvendor()\fR" 4 .IX Item "$juniper->vendor()" Returns 'juniper' .ie n .IP "$juniper\->\fIos()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fIos()\fR" 4 .IX Item "$juniper->os()" Returns 'junos' .ie n .IP "$juniper\->\fIlayers()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fIlayers()\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\->\fIos_ver()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fIos_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\->\fImodel()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fImodel()\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\->\fIserial()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fIserial()\fR" 4 .IX Item "$juniper->serial()" Returns serial number .Sp (\f(CW\*(C`jnxBoxSerialNo.0\*(C'\fR) .ie n .IP "$juniper\->\fImac()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fImac()\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\->\fIbox_descr()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fIbox_descr()\fR" 4 .IX Item "$juniper->box_descr()" The name, model, or detailed description of the device. .Sp (\f(CW\*(C`jnxBoxDescr.0\*(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\->\fIqb_fdb_index()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fIqb_fdb_index()\fR" 4 .IX Item "$juniper->qb_fdb_index()" Returns reference to hash: key = \s-1VLAN ID,\s0 value = \s-1FDB ID.\s0 .ie n .IP "$juniper\->\fIv_index()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fIv_index()\fR" 4 .IX Item "$juniper->v_index()" (\f(CW\*(C`jnxExVlanTag\*(C'\fR) .ie n .IP "$juniper\->\fIv_name()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fIv_name()\fR" 4 .IX Item "$juniper->v_name()" (\f(CW\*(C`jnxExVlanName\*(C'\fR) .ie n .IP "$juniper\->\fIv_type()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fIv_type()\fR" 4 .IX Item "$juniper->v_type()" (\f(CW\*(C`jnxExVlanType\*(C'\fR) .ie n .IP "$juniper\->\fIi_trunk()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fIi_trunk()\fR" 4 .IX Item "$juniper->i_trunk()" (\f(CW\*(C`jnxExVlanPortAccessMode\*(C'\fR) .ie n .IP "$juniper\->\fIi_vlan()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fIi_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 .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\->\fIe_index()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fIe_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\->\fIe_class()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fIe_class()\fR" 4 .IX Item "$juniper->e_class()" Returns reference to hash. Key: \s-1IID,\s0 Value: General hardware type. .ie n .IP "$juniper\->\fIe_descr()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fIe_descr()\fR" 4 .IX Item "$juniper->e_descr()" Returns reference to hash. Key: \s-1IID,\s0 Value: Human friendly name .ie n .IP "$juniper\->\fIe_hwver()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fIe_hwver()\fR" 4 .IX Item "$juniper->e_hwver()" Returns reference to hash. Key: \s-1IID,\s0 Value: Hardware version .ie n .IP "$juniper\->\fIe_vendor()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fIe_vendor()\fR" 4 .IX Item "$juniper->e_vendor()" Returns reference to hash. Key: \s-1IID,\s0 Value: juniper .ie n .IP "$juniper\->\fIe_serial()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fIe_serial()\fR" 4 .IX Item "$juniper->e_serial()" Returns reference to hash. Key: \s-1IID,\s0 Value: Serial number .ie n .IP "$juniper\->\fIe_pos()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fIe_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\->\fIe_type()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fIe_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\->\fIe_parent()\fR" 4 .el .IP "\f(CW$juniper\fR\->\fIe_parent()\fR" 4 .IX Item "$juniper->e_parent()" Returns reference to hash. Key: \s-1IID,\s0 Value: The value of \fIe_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\->\fIe_fru()\fR" 4 .el .IP "\f(CW$entity\fR\->\fIe_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.