.\" 
.\" Copyright (c) 2008, Stefan Walter
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without 
.\" modification, are permitted provided that the following conditions 
.\" are met:
.\" 
.\"     * Redistributions of source code must retain the above 
.\"       copyright notice, this list of conditions and the 
.\"       following disclaimer.
.\"     * Redistributions in binary form must reproduce the 
.\"       above copyright notice, this list of conditions and 
.\"       the following disclaimer in the documentation and/or 
.\"       other materials provided with the distribution.
.\"     * The names of contributors to this software may not be 
.\"       used to endorse or promote products derived from this 
.\"       software without specific prior written permission.
.\" 
.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
.\" COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 
.\" OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 
.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 
.\" THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH 
.\" DAMAGE.
.\" 
.\"
.\" CONTRIBUTORS
.\"  Stef Walter <stef@memberwebs.com>
.\"
.Dd April, 2006
.Dt bsnmp-pcap 8
.Os bsnmp-pcap 
.Sh NAME
.Nm bsnmp-pcap
.Nd an SNMP module which captures network traffic and reports the number of 
packets captured, and the throughput.
.Sh DESCRIPTION
.Nm
is a module for 
.Xr bsnmpd 1
which allows you to measure arbitrary network traffic. It uses the 
.Xr pcap 3
library (ie: think tcpdump) to filter traffic and then allows you to measure 
the throughput in packets or octets. 
.Pp
Multiple flows of traffic can be measured by the module.
.Pp
.Sh MIBS
The counters will be available as a table under the following MIB:
.Bd -literal -offset indent
 .1.3.6.1.4.1.12325.1.1112
.Ed
.Pp 
Or if the appropriate MIB.txt files have been installed:
.Bd -literal -offset indent
 enterprises.fokus.begemot.pcap
.Ed
.Pp
The following SNMP MIBs are available for use (where X is the counter index):
.Bl -tag -width Fl
.It Ar pcap.pcapCount
The number of network monitors present.
.It Ar pcap.pcapTable.pcapEntry.pcapIndex.X
The index of the network monitor.
.It Ar pcap.pcapTable.pcapEntry.pcapDescr.X
A human readable description of the network monitor (may be an empty string). 
.It Ar pcap.pcapTable.pcapEntry.pcapDevice.X
The network device that traffic is being monitored on.
.It Ar pcap.pcapTable.pcapEntry.pcapFilter.X
The filter used to select certain network packets for monitoring. Uses the 
.Xr tcpdump 1
syntax.
.It Ar pcap.pcapTable.pcapEntry.pcapOctets.X
The number of octets seen by the monitor.
.It Ar pcap.pcapTable.pcapEntry.pcapPackets.X
The number of packets seen by the monitor.
.El
.Sh OPTIONS
To activate the 
.Nm
module you must load the module in 
.Pa /etc/snmpd.config
and use the pingDevice and pingFilter SNMP MIBs in the same file 
to configure the traffic that you'd like to monitor.
.Sh EXAMPLES
The following example has two monitors. The first monitors all TCP traffic on 
port 80. The second monitors all broadcast traffic.
.Pp
The following would be added to 
.Pa /etc/snmpd.config:
.Bd -literal -offset indent
begemotSnmpdModulePath."pcap" = "/usr/local/lib/snmp_pcap.so"
%ping
pcapDescr.1 = "Websites"
pcapDevice.1 = "em0"
pcapFilter.1 = "tcp port 80"

pcapDescr.1 = "Broadcast"
pcapDevice.1 = "em0"
pcapFilter.1 = "broadcast"
.Ed
.Sh SEE ALSO
.Xr bsnmpd 1 ,
.Xr tcpdump 1
.Sh AUTHOR
.An Stef Walter Aq stef@memberwebs.com