.\" 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::CiscoStpExtensions 3pm" .TH Info::CiscoStpExtensions 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::CiscoStpExtensions \- SNMP Interface to "CISCO\-STP\-EXTENSIONS\-MIB" .SH "AUTHOR" .IX Header "AUTHOR" Carlos Vicente .SH "SYNOPSIS" .IX Header "SYNOPSIS" .SH "DESCRIPTION" .IX Header "DESCRIPTION" Create or use a subclass of SNMP::Info that inherits this class. Do not use directly. .PP For debugging you can call \fInew()\fR directly as you would in SNMP::Info .PP .Vb 1 \& my $stpx = new SNMP::Info::CiscoStpExtensions(...); .Ve .SS "Inherited Classes" .IX Subsection "Inherited Classes" .IP "SNMP::Info" 4 .IX Item "SNMP::Info" .PD 0 .IP "SNMP::Info::Bridge" 4 .IX Item "SNMP::Info::Bridge" .PD .PP MIBs can be found at ftp://ftp.cisco.com/pub/mibs/v2/v2.tar.gz .SH "GLOBAL METHODS" .IX Header "GLOBAL METHODS" These are methods that return scalar values from \s-1SNMP\s0 .ie n .IP "$stpx\->\fIstp_ver()\fR" 4 .el .IP "\f(CW$stpx\fR\->\fIstp_ver()\fR" 4 .IX Item "$stpx->stp_ver()" Returns the particular \s-1STP\s0 version running on this device. Meant to override \fISNMP::Info::Brigde::stp_ver()\fR .Sp Values: \f(CW\*(C`pvstPlus\*(C'\fR, \f(CW\*(C`mistp\*(C'\fR, \f(CW\*(C`mistpPvstPlus\*(C'\fR, \f(CW\*(C`mst\*(C'\fR, \f(CW\*(C`rapidPvstPlus\*(C'\fR .Sp (\f(CW\*(C`stpxSpanningTreeType\*(C'\fR) .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 "$stpx\->\fImst_config_digest()\fR" 4 .el .IP "\f(CW$stpx\fR\->\fImst_config_digest()\fR" 4 .IX Item "$stpx->mst_config_digest()" Returns the Multiple Spanning Tree (\s-1MST\s0) configuration digest .Sp (\f(CW\*(C`stpxSMSTConfigDigest\*(C'\fR) .ie n .IP "$stpx\->\fImst_region_name()\fR" 4 .el .IP "\f(CW$stpx\fR\->\fImst_region_name()\fR" 4 .IX Item "$stpx->mst_region_name()" Returns the Multiple Spanning Tree (\s-1MST\s0) region name .Sp (\f(CW\*(C`stpxMSTRegionName\*(C'\fR) .ie n .IP "$stpx\->\fImst_region_rev()\fR" 4 .el .IP "\f(CW$stpx\fR\->\fImst_region_rev()\fR" 4 .IX Item "$stpx->mst_region_rev()" Returns the Multiple Spanning Tree (\s-1MST\s0) region name .Sp (\f(CW\*(C`stpxSMSTRegionRevision\*(C'\fR) .ie n .IP "$stpx\->\fImst_vlan2instance()\fR" 4 .el .IP "\f(CW$stpx\fR\->\fImst_vlan2instance()\fR" 4 .IX Item "$stpx->mst_vlan2instance()" Returns the mapping of vlan to \s-1MST\s0 instance in the form of a hash reference with key = \s-1VLAN\s0 id, value = \s-1STP\s0 instance .ie n .IP "$stpx\->\fIi_rootguard_enabled()\fR" 4 .el .IP "\f(CW$stpx\fR\->\fIi_rootguard_enabled()\fR" 4 .IX Item "$stpx->i_rootguard_enabled()" Returns 1 or 0 depending on whether \f(CW\*(C`RootGuard\*(C'\fR is enabled on a given port. Format is a hash reference with key = \f(CW\*(C`ifIndex\*(C'\fR, value = [1|0] .Sp (\f(CW\*(C`stpxRootGuardConfigEnabled\*(C'\fR) .ie n .IP "$stpx\->\fIi_loopguard_enabled()\fR" 4 .el .IP "\f(CW$stpx\fR\->\fIi_loopguard_enabled()\fR" 4 .IX Item "$stpx->i_loopguard_enabled()" Returns 1 or 0 depending on whether \f(CW\*(C`LoopGuard\*(C'\fR is enabled on a given port. Format is a hash reference with key = \f(CW\*(C`ifIndex\*(C'\fR, value = [1|0] .Sp (\f(CW\*(C`stpxLoopGuardConfigEnabled\*(C'\fR) .ie n .IP "$stpx\->\fIi_bpduguard_enabled()\fR" 4 .el .IP "\f(CW$stpx\fR\->\fIi_bpduguard_enabled()\fR" 4 .IX Item "$stpx->i_bpduguard_enabled()" Returns 1 or 0 depending on whether \f(CW\*(C`BpduGuard\*(C'\fR is enabled on a given port. Format is a hash reference with key = \f(CW\*(C`ifIndex\*(C'\fR, value = [1|0] .Sp (\f(CW\*(C`stpxFastStartPortBpduGuardMode\*(C'\fR) .ie n .IP "$stpx\->\fIi_bpdufilter_enabled()\fR" 4 .el .IP "\f(CW$stpx\fR\->\fIi_bpdufilter_enabled()\fR" 4 .IX Item "$stpx->i_bpdufilter_enabled()" Returns 1 or 0 depending on whether \f(CW\*(C`BpduFilter\*(C'\fR is enabled on a given port. Format is a hash reference with key = \f(CW\*(C`ifIndex\*(C'\fR, value = [1|0] .Sp (\f(CW\*(C`stpxFastStartBpduFilterEnable\*(C'\fR) .SH "MUNGES" .IX Header "MUNGES" .IP "\fIoct2str()\fR" 4 .IX Item "oct2str()" Unpacks H* into a string