src/collectd-tg.pod

   1 =head1 NAME
   2
   3 collectd-tg - Traffic generator for collectd.
   4
   5 =head1 SYNOPSIS
   6
   7 collectd-tg B<-n> I<num_vl> B<-H> I<num_hosts> B<-p> I<num_plugins> B<-i> I<interval> B<-d> I<dest> B<-D> I<dport>
   8
   9 =head1 DESCRIPTION
  10
  11 B<collectd-tg> generates bogus I<collectd> network traffic. While host, plugin
  12 and values are generated randomly, the generated traffic tries to mimic "real"
  13 traffic as closely as possible.
  14
  15 =head1 ARGUMENTS AND OPTIONS
  16
  17 The following options are understood by I<collectd-tg>. The order of the
  18 arguments generally doesn't matter, as long as no argument is passed more than
  19 once.
  20
  21 =over 4
  22
  23 =item B<-n> I<num_vl>
  24
  25 Sets the number of unique I<value lists> (VL) to generate. Defaults to 10000.
  26
  27 =item B<-H> I<num_hosts>
  28
  29 Sets the number of unique hosts to simulate. Defaults to 1000.
  30
  31 =item B<-p> I<num_plugins>
  32
  33 Sets the number of unique plugins to simulate. Defaults to 20.
  34
  35 =item B<-i> I<interval>
  36
  37 Sets the interval in which each I<value list> is dispatched. Defaults to 10.0
  38 seconds.
  39
  40 =item B<-d> I<dest>
  41
  42 Sets the destination to which to send the generated network traffic. Defaults
  43 to the IPv6 multicast address, C<ff18::efc0:4a42>.
  44
  45 =item B<-D> I<dport>
  46
  47 Sets the destination port or service to which to send the generated network
  48 traffic. Defaults to I<collectd's> default port, C<25826>.
  49
  50 =item B<-h>
  51
  52 Print usage summary.
  53
  54 =back
  55
  56 =head1 SEE ALSO
  57
  58 L<collectd(1)>,
  59 L<collectd.conf(5)>
  60
  61 =head1 AUTHOR
  62
  63 Florian Forster E<lt>octoE<nbsp>atE<nbsp>collectd.orgE<gt>
  64
  65 =cut