.\" $Id: pollcisco.man,v 1.4 2012/02/03 19:49:59 ksb Exp $
.\" by Kevin Braunsdorf
.\" $Compile: Display%h
.\" $Display: ${nroff-groff} -Tascii -man %f | ${PAGER:-less}
.\" $Install: %b -mDeinstall %o %f && cp %f $DESTDIR/usr/local/man/man8/pollcisco.8
.\" $Deinstall: ${rm-rm} -f $DESTDIR/usr/local/man/[cm]a[nt]8/pollcisco.8*
.TH POLLCISCO 8L LOCAL
.SH NAME
pollcisco \- walk a Cisco SNMP MIB to update PEG port statistics
.SH SYNOPSIS
.ds PN "pollcisco
\fI\*(PN\fP [\fB\-Dx\fP] [\fB\-c\fP\~\fIread\fP] [\fB\-H\fP\~\fIsample\fP] [\fB\-N\fP\~\fInode\fP] [\fB\-p\fP\~\fIdelay\fP] [\fIswitch\fP]
.br
\fI\*(PN\fP \fB\-h\fP
.br
\fI\*(PN\fP \fB\-V\fP

.SH DESCRIPTION
The performance and engineering site accepts 8 scaler port statistics
under the \fBnet.cvu\fP RRD type.  This program sends those data source to PEG
by walking the SNMP MIB for a single local switch.  An alternate sampler
is available (see \fBnetworkstats\fP(8l)) if you can't poll the switch,
but it must be run on every host as it reads the local \fInetstat\fP counters
and is far more expensive.
.P
If you need to report under a different switch name (than the DNS name or
IP address) use the \fB\-N\fP option to change the effective name.

.SH OPTIONS
.TP
\fB\-D\fP
Display RRD path of each network port we may sample, then exit.
This is used to tell the PEG guys what RRD files to build (once) when
we setup a new switch.
.TP
\fB\-c\fP \fIread\fP
Specify a snmp read-community to access the switch.
.TP
\fB\-H\fP \fIsample\fP[:\fIport\fP]
Specify the sample collection host, running \fBrrdd\fP(8l).
Optionally specify the \fBrrdd\fP update \fIport\fP (otherwise 31415).
.TP
\fB\-h\fP
Print a brief help message.
.TP
\fB\-N\fP \fInode\fP
Use this node name, rather than the \fIswitch\fP name.
In same cases the switch might not be in DNS, so we may use the
management IP address (from RFC 1918 space), but give it a
sane name on PEG.
.TP
\fB\-p\fP \fIdelay\fP
Update persistantly, about every \fIdelay\fP seconds.
.TP
\fB\-V\fP
Output only the standard version information.
.TP
\fB\-x\fP
Trace updates on \fIstderr\fP.

.SH EXAMPLES
This  program is usually driven from \fBcron\fP(8), or started for
a single local switch at system boot.
.TP
/usr/local/libexec/pollcisco \-p 117 \-N lab101.player 10.7.5.250
Poll the local switch on IP \fB10.7.5.250\fP, but tell PEG it
is named "switch/lab101.player".

.SH BUGS
One needs to know an SNMP read-only community string to sample each
switch, local policy must allow that access.

.SH AUTHORS
Kevin Braunsdorf, NPC Guild with help from other NPCs
.br
peg within-no-spamming_hat ksb.npcguild.org

.SH "SEE ALSO"
sh(1), rrdup(1l), networkstats(8l)