Blame man/snmp-bridge-mib.1

Packit fcad23
'\" t
Packit fcad23
.\"     Title: snmp-bridge-mib
Packit fcad23
.\"    Author: Jens Osterkamp <jens@linux.vnet.ibm.com>
Packit fcad23
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
Packit fcad23
.\"      Date: 03/26/2010
Packit fcad23
.\"    Manual: Net-SNMP
Packit fcad23
.\"    Source: http://www.ibm.com/ v6
Packit fcad23
.\"  Language: English
Packit fcad23
.\"
Packit fcad23
.TH "SNMP\-BRIDGE\-MIB" 1 "26 Mar 2010" "http://www\&.ibm\&.com/ v6" "Net\-SNMP"
Packit fcad23
.\" -----------------------------------------------------------------
Packit fcad23
.\" * set default formatting
Packit fcad23
.\" -----------------------------------------------------------------
Packit fcad23
.\" disable hyphenation
Packit fcad23
.nh
Packit fcad23
.\" disable justification (adjust text to left margin only)
Packit fcad23
.ad l
Packit fcad23
.\" -----------------------------------------------------------------
Packit fcad23
.\" * MAIN CONTENT STARTS HERE *
Packit fcad23
.\" -----------------------------------------------------------------
Packit fcad23
.SH "NAME"
Packit fcad23
snmp-bridge-mib \- provide Linux bridge information via SNMP
Packit fcad23
.SH "SYNOPSIS"
Packit fcad23
.HP \w'\fBsnmp\-bridge\-mib\fR\ 'u
Packit fcad23
\fBsnmp\-bridge\-mib\fR {bridge}
Packit fcad23
.SH "ARGUMENTS"
Packit fcad23
.PP
Packit fcad23
The following arguments are required:
Packit fcad23
.PP
Packit fcad23
\fBbridge\fR
Packit fcad23
.RS 4
Packit fcad23
The name of the Linux bridge for which you want to provide information via SNMP, e\&.g\&. br0\&.
Packit fcad23
.RE
Packit fcad23
.SH "DESCRIPTION"
Packit fcad23
.PP
Packit fcad23
The snmp\-bridge\-mib is an extension to net\-snmp\&. It collects information about a bridge in a Linux system and exports them for query from other (remote) systems for management purposes\&.
Packit fcad23
.SH "CONFIGURATION:"
Packit fcad23
.PP
Packit fcad23
The preferred method of snmp\-bridge\-mib to attach to net\-snmp is agentx\&. For this to work, you will have to add the following line to /etc/snmp/snmpd\&.conf,
Packit fcad23
.sp
Packit fcad23
.if n \{\
Packit fcad23
.RS 4
Packit fcad23
.\}
Packit fcad23
.nf
Packit fcad23
    master agentx
Packit fcad23
    
Packit fcad23
.fi
Packit fcad23
.if n \{\
Packit fcad23
.RE
Packit fcad23
.\}
Packit fcad23
.PP
Packit fcad23
restart snmpd and start snmp\-bridge\-mib\&. snmp\-bridge\-mib will then connect to the running snmpd daemon\&.
Packit fcad23
.PP
Packit fcad23
Another way of attaching snmp\-bridge\-mib to is to run it as an embedded perl module\&. You have to add
Packit fcad23
.sp
Packit fcad23
.if n \{\
Packit fcad23
.RS 4
Packit fcad23
.\}
Packit fcad23
.nf
Packit fcad23
    perl do "path to location of snmp\-bridge\-mib"
Packit fcad23
    
Packit fcad23
.fi
Packit fcad23
.if n \{\
Packit fcad23
.RE
Packit fcad23
.\}
Packit fcad23
.PP
Packit fcad23
and restart snmpd\&.
Packit fcad23
.SH "EXAMPLE:"
Packit fcad23
.PP
Packit fcad23
Follow the instructions in this manpage and type
Packit fcad23
.sp
Packit fcad23
.if n \{\
Packit fcad23
.RS 4
Packit fcad23
.\}
Packit fcad23
.nf
Packit fcad23
    perl /usr/bin/snmp\-bridge\-mib br0
Packit fcad23
    
Packit fcad23
.fi
Packit fcad23
.if n \{\
Packit fcad23
.RE
Packit fcad23
.\}
Packit fcad23
.PP
Packit fcad23
You\'ll get the following output:
Packit fcad23
.sp
Packit fcad23
.if n \{\
Packit fcad23
.RS 4
Packit fcad23
.\}
Packit fcad23
.nf
Packit fcad23
     registering at \&.1\&.3\&.6\&.1\&.2\&.1\&.17
Packit fcad23
     running as a subagent\&.
Packit fcad23
     dot1qbridge agent started\&.
Packit fcad23
     NET\-SNMP version 5\&.4\&.2\&.1 AgentX subagent connected
Packit fcad23
     
Packit fcad23
.fi
Packit fcad23
.if n \{\
Packit fcad23
.RE
Packit fcad23
.\}
Packit fcad23
.PP
Packit fcad23
Now it\'s time for a first test:
Packit fcad23
.sp
Packit fcad23
.if n \{\
Packit fcad23
.RS 4
Packit fcad23
.\}
Packit fcad23
.nf
Packit fcad23
    $ export MIBS=+BRIDGE\-MIB
Packit fcad23
    $ snmpwalk localhost \&.1\&.3\&.6\&.1\&.2\&.1\&.17
Packit fcad23
    
Packit fcad23
.fi
Packit fcad23
.if n \{\
Packit fcad23
.RE
Packit fcad23
.\}
Packit fcad23
.PP
Packit fcad23
The output produced should look like
Packit fcad23
.sp
Packit fcad23
.if n \{\
Packit fcad23
.RS 4
Packit fcad23
.\}
Packit fcad23
.nf
Packit fcad23
    BRIDGE\-MIB::dot1dStpBridgeHelloTime = INTEGER: 199 centi\-seconds
Packit fcad23
    BRIDGE\-MIB::dot1dStpBridgeForwardDelay = INTEGER: 1499 centi\-seconds
Packit fcad23
    BRIDGE\-MIB::dot1dStpPort\&.1 = INTEGER: 1
Packit fcad23
    BRIDGE\-MIB::dot1dStpPort\&.3 = INTEGER: 3
Packit fcad23
    BRIDGE\-MIB::dot1dStpPortPriority\&.1 = INTEGER: 32
Packit fcad23
    BRIDGE\-MIB::dot1dStpPortPriority\&.3 = INTEGER: 32
Packit fcad23
    BRIDGE\-MIB::dot1dStpPortState\&.1 = INTEGER: disabled(1)
Packit fcad23
    BRIDGE\-MIB::dot1dStpPortState\&.3 = INTEGER: disabled(1)
Packit fcad23
    BRIDGE\-MIB::dot1dStpPortEnable\&.1 = INTEGER: disabled(2)
Packit fcad23
    BRIDGE\-MIB::dot1dStpPortEnable\&.3 = INTEGER: disabled(2)
Packit fcad23
    BRIDGE\-MIB::dot1dStpPortPathCost\&.1 = INTEGER: 2
Packit fcad23
    BRIDGE\-MIB::dot1dStpPortPathCost\&.3 = INTEGER: 4
Packit fcad23
    BRIDGE\-MIB::dot1dStpPortDesignatedRoot\&.1 = STRING: "8000\&.001018382c78"
Packit fcad23
    BRIDGE\-MIB::dot1dStpPortDesignatedRoot\&.3 = STRING: "8000\&.001018382c78"
Packit fcad23
    BRIDGE\-MIB::dot1dStpPortDesignatedCost\&.1 = INTEGER: 0
Packit fcad23
    BRIDGE\-MIB::dot1dStpPortDesignatedCost\&.3 = INTEGER: 0
Packit fcad23
    BRIDGE\-MIB::dot1dStpPortDesignatedBridge\&.1 = STRING: "8000\&.001018382c78"
Packit fcad23
    BRIDGE\-MIB::dot1dStpPortDesignatedBridge\&.3 = STRING: "8000\&.001018382c78"
Packit fcad23
    BRIDGE\-MIB::dot1dStpPortDesignatedPort\&.1 = STRING: "32769"
Packit fcad23
    BRIDGE\-MIB::dot1dStpPortDesignatedPort\&.3 = STRING: "32770"
Packit fcad23
    BRIDGE\-MIB::dot1dStpPortPathCost32\&.1 = INTEGER: 2
Packit fcad23
    BRIDGE\-MIB::dot1dStpPortPathCost32\&.3 = INTEGER: 4
Packit fcad23
    BRIDGE\-MIB::dot1dTpLearnedEntryDiscards = Counter32: 0
Packit fcad23
    BRIDGE\-MIB::dot1dTpAgingTime = INTEGER: 300 seconds
Packit fcad23
    BRIDGE\-MIB::dot1dTpFdbAddress\&.\'\&.\&.\&.8,x\' = STRING: 0:10:18:38:2c:78
Packit fcad23
    BRIDGE\-MIB::dot1dTpFdbAddress\&.\'\&.!^/B|\' = STRING: 0:21:5e:2f:42:7c
Packit fcad23
    BRIDGE\-MIB::dot1dTpFdbPort\&.\'\&.\&.\&.8,x\' = INTEGER: 1
Packit fcad23
    BRIDGE\-MIB::dot1dTpFdbPort\&.\'\&.!^/B|\' = INTEGER: 3
Packit fcad23
    BRIDGE\-MIB::dot1dTpFdbStatus\&.\'\&.\&.\&.8,x\' = INTEGER: learned(3)
Packit fcad23
    BRIDGE\-MIB::dot1dTpFdbStatus\&.\'\&.!^/B|\' = INTEGER: learned(3)
Packit fcad23
    BRIDGE\-MIB::dot1dTpPort\&.1 = INTEGER: 1
Packit fcad23
    BRIDGE\-MIB::dot1dTpPort\&.3 = INTEGER: 3
Packit fcad23
    BRIDGE\-MIB::dot1dTpPortMaxInfo\&.1 = INTEGER: 1500 bytes
Packit fcad23
    BRIDGE\-MIB::dot1dTpPortMaxInfo\&.3 = INTEGER: 1500 bytes
Packit fcad23
    BRIDGE\-MIB::dot1dTpPortInFrames\&.1 = Counter32: 18082 frames
Packit fcad23
    BRIDGE\-MIB::dot1dTpPortInFrames\&.3 = Counter32: 1546072 frames
Packit fcad23
    BRIDGE\-MIB::dot1dTpPortOutFrames\&.1 = Counter32: 11601 frames
Packit fcad23
    BRIDGE\-MIB::dot1dTpPortOutFrames\&.3 = Counter32: 10988 frames
Packit fcad23
    BRIDGE\-MIB::dot1dTpPortInDiscards\&.1 = Counter32: 0 frames
Packit fcad23
    BRIDGE\-MIB::dot1dTpPortInDiscards\&.3 = Counter32: 0 frames
Packit fcad23
    
Packit fcad23
.fi
Packit fcad23
.if n \{\
Packit fcad23
.RE
Packit fcad23
.\}
Packit fcad23
.SH "BUGS"
Packit fcad23
.sp
Packit fcad23
.RS 4
Packit fcad23
.ie n \{\
Packit fcad23
\h'-04' 1.\h'+01'\c
Packit fcad23
.\}
Packit fcad23
.el \{\
Packit fcad23
.sp -1
Packit fcad23
.IP "  1." 4.2
Packit fcad23
.\}
Packit fcad23
snmp\-bridge\-mib currently only supports one bridge which has to be specified on the commandline\&.
Packit fcad23
.RE
Packit fcad23
.sp
Packit fcad23
.RS 4
Packit fcad23
.ie n \{\
Packit fcad23
\h'-04' 2.\h'+01'\c
Packit fcad23
.\}
Packit fcad23
.el \{\
Packit fcad23
.sp -1
Packit fcad23
.IP "  2." 4.2
Packit fcad23
.\}
Packit fcad23
Not all elements of RFC 4188 because they are either not available in sysfs or difficult to extract from the existing data\&.
Packit fcad23
.RE
Packit fcad23
.PP
Packit fcad23
.SH "SEE ALSO"
Packit fcad23
.PP
Packit fcad23
\fBsnmpd.conf\fR(5),
Packit fcad23
\fBNet::SNMP\fR(3)
Packit fcad23
.SH "AUTHOR"
Packit fcad23
.PP
Packit fcad23
\fBJens Osterkamp\fR <\&jens@linux\&.vnet\&.ibm\&.com\&>
Packit fcad23
.RS 4
Packit fcad23
Developer
Packit fcad23
.RE
Packit fcad23
.SH "COPYRIGHT"
Packit fcad23
.br
Packit fcad23
Copyright \(co 2009, 2010 IBM Corp., All Rights Reserved
Packit fcad23
.br
Packit fcad23
.PP
Packit fcad23
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
Packit fcad23
.PP
Packit fcad23
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software\&.
Packit fcad23
.PP
Packit fcad23
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT\&. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE\&.
Packit fcad23
.sp