cblmd.conf(5)

NAME
cblmd.conf - Configuration for Cheap Bastard Latency Monitor Daemon

DESCRIPTION
The cblmd.conf file is the configuration file for cblmd(1).

The configuration file contains keywords entries, keyword and value pair entries and block entries.

Keyword entries enable a feature. Some keyword enabled features may accept an optional value.

Example of a keyword entry:

  compression

Keyword and value pair entries are separated by one or more spaces or tabs. The value may be a quoted string.

Example of keyword and value pair entries:

  source      eth0
  location    "LaCrosse, WI"

Block entries start with a keyword wrapped in angles brackets, an opening angle bracking (<) followed by a keyword and ended with a closing angle bracket (>). A block entry may contain keyword entries and keyword and value pair entries. The block entry is completed by an opening bracking and slash (</) followed by a matching keyword and ended with a closing angle bracket (>).

Example of a block entry:

  <database>
      host    192.168.55.4
      port    3306
  </database>

Any characters following a # or ; character is considered a comment and will be ignored. Empty lines are ignored.

OPTIONS
Options can be given in any order. The available options heavily match up with command line arguments.

Preferences

source <IP|INTERFACE>
    Source traffic from specified IP address or INTERFACE. (Default: first found)

port <PORT>
    Listen for incoming traffic on specified PORT. (Default: 7447)

interface <INTERFACE>
    Listen for incoming traffic on specified IP address or INTERFACE. (Default: any)

name <STRING>
    Descriptive name for probe. Will be used to display results via web interface. Specifying "short" will result in the hostname up to the first dot. (Default: hostname)

location <STRING>
    Location of probe. Will be used to display results via web interface. (Default: none)

description <STRING>
    Description of the probe. Will be used to display results via web interface. (Default: none)

rate <PPM>
    The rate at which to transmit packets per minute (PPM) from this probe. The rate is used per ToS marking. (Default: 120)

Block: <dscp>
    Transmit packets marked with specified DSCP markings and priority. Values of 0 to 64 are valid for DSCP values. Priority allows vconfig(8) to map the specified priority (skb-priority) to the egress VLAN priority. Values of 1 to 7 are valid for priority. May be specified multiple times. Some settings require root privileges. (Default: 0:0)

Block: <precedence>
    Transmit packets marked with specified DSCP markings and priority. Values of 1 to 7 are valid for precedence. Priority allows vconfig(8) to map the specified priority (skb-priority) to the egress VLAN priority. Values of 1 to 7 are valid for priority. May be specified multiple times. Some settings require root privileges. (Default: 0:0)

Block: <tos>
    Transmit packets marked with specified ToS markings and priority. ToS is an 8 bit field within the IP header. Bits 2-7 are used for DSCP or bits 5-7 for Precedence. Values of 0 to 224 are valid for ToS values. A ToS value of 0 will provide Best Effort (DSCP: 0, Prec: 0). A ToS value of 64 will provide Assured Forwarding (DSCP: 16, Prec: 2). A ToS value of 128 will provide Network Control (DSCP: 32, Prec: 4). A ToS value of 192 will provide Network Control (DSCP: 48, Prec: 6). ToS values of 160 or more require root access. Priority allows vconfig(8) to map the specified priority (skb-priority) to the egress VLAN priority. Values of 1 to 7 are valid for priority. May be specified multiple times. Some settings require root privileges. (Default: 0:0)

maxttl <NUM>
    Maximum allowed one way TTL (time to live) in milliseconds between probes. (Default: 1000)

maxage <NUM>
    Maximum age in second a probe may be out of contact with the database before being considered dead. (Default: 90)

key <STRING>
    Key used to verify authorization of incoming packets. (Default: o-soraizu)

size <BYTES>
    Size of transmited packet payload. (Default: 64)

pattern <STRING>
    Pattern to load into packets payload. (Default: kusabana)

fragment [on|yes|1]
    Allow fragmentation of outgoing packets by disabling the DF (don't fragment) bit within the packet. (Default: off)

ttl <NUM>
    Set outgoing packets time to live (TTL) to the specified value. Values between 1 and 255 are valid. (Default: 64)

Block: <disable>
    Disable the internal tracking of a feature such as OTT (one-way trip time), JTR (jitter), TOS, (type of service), OOO (out of order packets) or DUP (duplicate packets). This argument may be specified multiple times to disable more than one feature. (Default: none)

Block: <snmptrap>
    Send SNMP traps to HOST on PORT using COMMUNITY and VERSION. If INFORM enabled, any SNMP v2 trap will require an acknowledgment from the trap receiver or HOST (Default: none). PORT may be any value between 1 and 65535. (Default: 162) COMMUNITY may be any alphanumeric value. (Default: public) VERSION may be v1 or v2. (Default: v2) INFORM may be 0 or 1. (Default: 0)

Database

Block: <database>
    Use the specified MySQL database to store results and communicate between probes. HOSTNAME and PORT may be used to specify the MySQL server to connect to, or SOCKET may optionally be used to connect to a local MySQL server. NAME is the database name. USERNAME and PASSWORD may be used to specify authentification information. COMPRESSION may be specified to compress data to the MySQL server over low bandwidth connections.

Process

user <USER>
    Run as user USER. (Default: current)

group <GROUP>
    Run as group GROUP. (Default: current)

chroot <DIR>
    Change root to DIRectory. (Default: none)

stats [FILE]
    Write statistics information to FILE. (Default: /var/run/cblmd.stat)

nice [[+/-]NUM]
    Run with a nice value of NUM. Values of -20 to 19 are valid. (Default: -10)

debug [LEVEL]"
    Set the debug level to INT. Values of 1 to 9 are valid. (Default: off)

EXAMPLES
Transmit from eth1 on port 7447. Connect to the database named cblm on the MySQL server at 192.168.55.4 using username cblm and password o-soraizu. Send SNMP v2 traps for all alarms to 192.168.33.1 using community public. Send SNMP v1 traps for all alarms to 192.168.55.1 using community public.

  source   eth1
  port     7447
  <database>
      hostname   192.168.55.4
      name       cblm
      username   cblm
      password   o-soraizu
  </database>
  <snmptrap>
      host       192.168.33.1
      community  public
      version    v2c
  </snmptrap>
  <snmptrap>
      host       192.168.55.1
      community  public
      version    v1
  </snmptrap>

Transmit from eth1 at a rate of 30 PPM for DSCP values 0, 24 and 40 with 255 byte packets. Set the probe name to the short version of the servers hostname. Connect to the database named cblm on the MySQL server at 192.168.55.4 using username cblm and password o-soraizu. Send SNMP v2 traps for all alarms to 192.168.33.1 using community public.

  source   eth1
  rate     30
  size     255
  name     short
  <dscp>
    0
    24
    40
  </dscp>
  <database>
    hostname   192.168.55.4
    name       cblm
    username   cblm
    password   o-soraizu
  </database>
  <snmptrap>
      host       192.168.33.1
      community  public
      version    v2c
  </snmptrap>

SEE ALSO
cblmd(1)

COPYRIGHT
Copyright (C) 2004-2008 Digital Genesis Software. All rights reserved.
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License <http://www.gnu.org/copyleft/gpl.html>
for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

AUTHOR
James M. Sella <@BUGREPORT@>