Provided by: ftm_0.0.7_i386 bug

NAME

       ftm-config - ftm(1) configuration file format

OVERVIEW

       A  configuration  file  consist  out  of  a list of monitor sections, a
       netfilter chain and, optionally, a netfilter table. Below is an example
       of a monitor definition:

              monitor client-a
              ...

       The  chain  command  specify  which  netfilter  chain to use for adding
       filters.  There  are  three  predefined  chains  (INPUT,  FORWARD,  and
       OUTPUT).  If a user-defined chain is specified, it is up to the user to
       make sure that this user-defined chain exist and that packets are  sent
       to this user-defined chain. Below is an example of a chain definition:

              chain stats
              ...

       The  table  command  specify  which  netfilter  table to use for adding
       filters.  There are three predefined tables (filter, nat, and  mangle).
       The  default  is  to use the filter table. Don’t change this unless you
       know what you are doing.

MONITOR SECTIONS

       Each monitor section is  assigned  a  description,  expected  bandwidth
       utilization,  and  a list of networks. Below is an example of a minimal
       interface definition:

              description "Client A"
              bandwidth 512kbit
              network 192.168.1.0/24
              network 10.2.0.0/16
              ...

       You can specify different values for incoming (traffic destined for the
       network(s))  and  outgoing  bandwidth  (traffic  originating  from  the
       network(s)). In addition, you can specify a peak rate. If the monitored
       bitrate is less than the specified rate, it will be displayed in green.
       If it exceeds it, but is less than the peak rate, it will be  displayed
       in  yellow.  If  it exceeds the peak rate (or the rate if the peak rate
       was not specified), it will be displayed in red.

       Below is the BNF notation for the bandwidth statement arguments:

              bw-args ::= rate-args |
                  incoming rate-args outgoing rate-args

              rate-args ::= <rate> ( peak <rate> )?

       The <rate> syntax is the same as  that  used  in  ftc(1)  configuration
       files.

EXAMPLES

       Below  is  an  example  configuration file with two client sections. In
       this particular configuration, FTM will  assume  that  a  table  called
       stats exist and can be used to add its own rules.

              chain stats

              monitor client-a
               description "Foo Incorporated"
               bandwidth 2mbit
               network 192.168.1.0/30
               network 192.168.1.8/29

              monitor client-b
               description "Bar Corporation"
               bandwidth 512kbit
               network 10.10.0.0/16

SEE ALSO

       ftm(1)

AUTHOR

       Written by Abraham vd Merwe <abz@blio.com>