Provided by: ftm_0.0.7_i386
ftm-config - ftm(1) configuration file format
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:
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:
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.
Each monitor section is assigned a description, expected bandwidth
utilization, and a list of networks. Below is an example of a minimal
description "Client A"
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
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.
description "Foo Incorporated"
description "Bar Corporation"
Written by Abraham vd Merwe <email@example.com>