alexandergall / dbeacon Goto Github PK

This is dbeacon, a multicast connectivity monitoring tool.

Update: As of 2010 dbeacon is no longer being developed. The source code is
        still available for reference but unfortunately it's the result of
		some quick organic development back in 2005 (initially it supported
		another protocol that was being used at the time). I'm also
		re-licensing the code from GPL to MIT. The original README follows.

dbeacon is a Multicast Beacon written in C++. The main purpose of a beacon is
to monitor other beacon's reachability and collect statistics such as loss,
delay and jitter between beacons. dbeacon supports both IPv4 and IPv6
multicast, collecting information via ASM and SSM.

dbeacon was originally IPv6-only, designed to be used in the m6bone.

  Copyright (c) 2005-7, Hugo Santos <[email protected]>

  http://fivebits.net/proj/dbeacon/

  o Ideas, IPv4 port, SSM pushing by Hoerdt Mickael;
  o Ideas and testing by Sebastien Chaumontet;
  o SSM Ping originaly by Stig Venaas
    - first proposed by Pavan Namburi, Kamil Sarac and Kevin C. Almeroth;
  o Bernhard Schmidt provided valuable resources and helped during testing.

Running
-------

Usage: dbeacon [OPTIONS...]

  -n NAME, -name NAME    Specifies the beacon name
  -a MAIL                Supply administration contact
  -i IN, -interface IN   Use IN instead of the default interface for multicast
  -b BEACON_ADDR[/PORT]  Multicast group address to send probes to
  -S [GROUP_ADDR[/PORT]] Enables SSM reception/sending on optional GROUP_ADDR/PORT
  -O                     Disables the joining of SSM groups but still sends via SSM.
                         Use this option if your operating system has problems with SSM
  -B ADDR                Bootstraps by joining the specified address
  -P, -ssmping           Enable the SSMPing server capability
  -s ADDR                Bind to local address
  -d [FILE]              Dump periodic reports to dump.xml or specified file
  -I N, -interval N      Interval between dumps. Defaults to 5 secs
  -W URL, -website URL   Specify a website to announce.
  -Wm URL, -matrix URL   Specify your matrix URL
  -Wl URL, -lg URL       Specify your LG URL
                         will announce an URL for that type instead
  -C CC                  Specify your two letter Country Code
  -L program             Launch program after each dump.
                         The first argument will be the dump filename
  -F flag                Set a dbeacon flag to be announced.
                         Available flags are: ssmping
  -4, -ipv4              Force IPv4 usage
  -6, -ipv6              Force IPv6 usage
  -v                     be verbose (use several for more verbosity)
  -U                     Dump periodic bandwidth usage reports to stdout
  -D, -daemon            fork to the background (daemonize)
  -pidfile FILE          Specifies the PID filename to use
  -syslog                Outputs using syslog facility.
  -c FILE                Specifies the configuration file
  -V, -version           Outputs version information and leaves

To join our experimental deployment in the m6bone use:

	./dbeacon -a YOURMAIL -n SITENAME -b ff1e::1:f00d:beac -S

Only use -S if are running Linux >= 2.6.11. There were some problems with SSM in earlier versions.

If you are interested in running the matrix script also use -d so dbeacon exports statistic information to dump.xml.

A more complete command line would be

	./dbeacon -a MAIL -n NAME -b ff1e::1:f00d:beac -S -W http://yoursite.com -Wm http://yoursite.com/matrix/ -d