1.\" 2.\" Copyright (c) 2006, Stefan Walter 3.\" All rights reserved. 4.\" 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 8.\" 9.\" * Redistributions of source code must retain the above 10.\" copyright notice, this list of conditions and the 11.\" following disclaimer. 12.\" * Redistributions in binary form must reproduce the 13.\" above copyright notice, this list of conditions and 14.\" the following disclaimer in the documentation and/or 15.\" other materials provided with the distribution. 16.\" * The names of contributors to this software may not be 17.\" used to endorse or promote products derived from this 18.\" software without specific prior written permission. 19.\" 20.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 21.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 22.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 23.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 24.\" COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 25.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 26.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 27.\" OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 28.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 29.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 30.\" THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH 31.\" DAMAGE. 32.\" 33.\" 34.\" CONTRIBUTORS 35.\" Stefan Walter <stef@memberwebs.com> 36.\" 37.Dd August, 2006 38.Dt rrdbotd 8 39.Os rrdbot 40.Sh NAME 41.Nm rddbotd 42.Nd an SNMP poller which writes to an round robin database 43.Sh SYNOPSIS 44.Nm 45.Op Fl M 46.Op Fl b Ar bindaddr 47.Op Fl c Ar confdir 48.Op Fl w Ar workdir 49.Op Fl m Ar mibdir 50.Op Fl d Ar debuglevel 51.Op Fl p Ar pidfile 52.Op Fl r Ar retries 53.Op Fl t Ar timeout 54.Nm 55.Fl V 56.Sh DESCRIPTION 57.Nm 58is an SNMP polling daemon which writes the polled values to an 59.Xr rrdtool 1 60RRD database. An can poll many different SNMP sources in an efficient manner. 61.Pp 62Table queries are supported, where the OID index of a certain value is not 63known beforehand, or may change regularly. 64.Pp 65In addition multiple SNMP agents may be specified for a certain value. If 66one SNMP agent cannot be contacted or errors for some reason, another one 67will be tried. 68.Pp 69The configuration (eg: SNMP sources, polling intervals) are located in files 70in a directory, with one configuration file per RRD. The format of the 71configuration files are described in: 72.Xr rrdbot.conf 5 73.Sh OPTIONS 74The options are as follows. 75.Bl -tag -width Fl 76.It Fl b Ar bindaddr 77Address to bind to and send SNMP packets from. 78.It Fl c Ar confdir 79The directory in which configuration files are stored. See below for info 80on the various file locations. 81.It Fl d Ar debuglevel 82Don't detach from the console and run as a daemon. In addition the 83.Ar debuglevel 84argument specifies what level of error messages to display. 0 being 85the least, 4 the most. 86.It Fl m Ar mibdir 87The directory in which to look for MIB files. The default directory is 88usually sufficient. 89.It Fl M 90Display MIB parsing warnings. 91.It Fl p Ar pidfile 92Specifies a location for the a process id file to be written to. This file 93contains the process id of 94.Nm 95and can be used to stop the daemon. 96.It Fl r Ar retries 97The number of times to retry sending an SNMP packet. Defaults to 3 retries. 98.It Fl t Ar timeout 99The amount of time (in seconds) to wait for an SNMP response. Defaults to 1005 seconds. 101.It Fl V 102Prints the version of 103.Nm 104and the locations of the configuration files, RRD files etc. 105.It Fl w Ar workdir 106The default directory where to look for RRD files. See below for info on 107the various file locations. 108.El 109.Sh FILE LOCATIONS 110To determine the default location for the configuration files and RRD files 111run this command: 112.Bd -literal -offset indent 113# rrdbotd -V 114.Ed 115.Pp 116The configuration files for SNMP pollers are laid out in a directory tree, 117with one file per RRD. Subdirectories can be used to organize the 118configuration files. The contents of the configuration files are described 119in 120.Xr rrdbot.conf 5 . 121.Pp 122By default the RRD files mirror the directory structure and names of the 123configuration files, with an 124.Pa .rrd 125extension appended to the filename. 126.Pp 127For example if your configuration files are in a structure like the following: 128.Bd -literal -offset indent 129/usr/local/etc/rrdbot/ 130 gateways/ 131 gateway-load.conf 132 gateway-traffic.conf 133 temperature/ 134 inside-temperature.conf 135 outside-temperature.conf 136 machine-load.conf 137.Ed 138.Pp 139Then the default RRD files would be in a similar directory structure: 140.Bd -literal -offset indent 141/var/db/rrdbot/ 142 gateways/ 143 gateway-load.conf.rrd 144 gateway-traffic.conf.rrd 145 temperature/ 146 inside-temperature.conf.rrd 147 outside-temperature.conf.rrd 148 machine-load.conf.rrd 149.Ed 150.Pp 151The default location for an RRD file can be overridden by using the 152.Ar rrd 153option in the configuration file. 154.Pp 155You can use the 156.Xr rrdbot-create 8 157tool to create the needed RRD files in the appropriate places. 158.Sh SEE ALSO 159.Xr rrdbot.conf 5 , 160.Xr rrdbot-create 8 , 161.Xr rrdbot-get 1 , 162.Xr rrdtool 1 163.Sh AUTHOR 164.An Stef Walter Aq stef@memberwebs.com 165