diff --git a/plugins/network/multibandwidth b/plugins/network/multibandwidth index 810a5725..699c2248 100755 --- a/plugins/network/multibandwidth +++ b/plugins/network/multibandwidth @@ -20,7 +20,8 @@ You can install bing by using (Ubuntu/Debian): apt-get install bing =head1 CONFIGURATION -The following is the default configuration +The following example configuration shows all settings. Only "hosts" is required for +minimal configuration. [multibandwidth] user root @@ -30,19 +31,22 @@ env.small_packet_size 44 env.big_packet_size 108 env.max_valid_bps 15728640 -- env.hosts explanation: hostname or IP of the hosts to calculate the bandwidth. +- env.hosts: space separated list of hostnames or IPs of the hosts to calculate the bandwidth. + This setting is required. -- env.samples explanation: Reset stats after sending samples ECHO_REQUEST packets. +- env.samples: Reset stats after sending this number of ECHO_REQUEST packets. + Defaults to 15 samples. -- env.small_packet_size explanation: Specifies the number of data bytes to be sent in the small +- env.small_packet_size: Specifies the number of data bytes to be sent in the small packets. The default and minimum value is 44. -- env.big_packet_size explanation: Specifies the number of data bytes to be sent in the big +- env.big_packet_size: Specifies the number of data bytes to be sent in the big packets. The default is 108. The size should be chosen so that big packet roundtrip times are long enough to be accurately measured. -- env.max_valid_bps explanation: bing have some random spikes. This variable is used to indicate +- env.max_valid_bps: bing have some random spikes. This variable is used to indicate the maximum value of mbps that can be recorded (in bps). + Defaults to the empty string (no validity check). =head1 MAGIC MARKERS @@ -64,6 +68,12 @@ GPLv2 =cut +hosts=${hosts:-} +samples=${samples:-15} +small_packet_size=${small_packet_size:-44} +big_packet_size=${big_packet_size:-108} +max_valid_bps=${max_valid_bps:-15728640} + case $1 in config)