Révision 09b88141
Improve documantion of many plugins
Specifically the configuration examples are now indented properly.
| plugins/network/multibandwidth | ||
|---|---|---|
| 23 | 23 |
The following example configuration shows all settings. Only "hosts" is required for |
| 24 | 24 |
minimal configuration. |
| 25 | 25 |
|
| 26 |
[multibandwidth] |
|
| 27 |
user root |
|
| 28 |
env.hosts example.org example2.org example3.org |
|
| 29 |
env.samples 15 |
|
| 30 |
env.small_packet_size 44 |
|
| 31 |
env.big_packet_size 108 |
|
| 32 |
env.max_valid_bps 15728640 |
|
| 33 |
|
|
| 34 |
- env.hosts: space separated list of hostnames or IPs of the hosts to calculate the bandwidth. |
|
| 26 |
[multibandwidth] |
|
| 27 |
user root |
|
| 28 |
env.hosts example.org example2.org example3.org |
|
| 29 |
env.samples 15 |
|
| 30 |
env.small_packet_size 44 |
|
| 31 |
env.big_packet_size 108 |
|
| 32 |
env.max_valid_bps 15728640 |
|
| 33 |
|
|
| 34 |
=over 4 |
|
| 35 |
|
|
| 36 |
=item env.hosts: space separated list of hostnames or IPs of the hosts to calculate the bandwidth. |
|
| 35 | 37 |
This setting is required. |
| 36 | 38 |
|
| 37 |
- env.samples: Reset stats after sending this number of ECHO_REQUEST packets.
|
|
| 39 |
=item env.samples: Reset stats after sending this number of ECHO_REQUEST packets.
|
|
| 38 | 40 |
Defaults to 15 samples. |
| 39 | 41 |
|
| 40 |
- env.small_packet_size: Specifies the number of data bytes to be sent in the small
|
|
| 42 |
=item env.small_packet_size: Specifies the number of data bytes to be sent in the small
|
|
| 41 | 43 |
packets. The default and minimum value is 44. |
| 42 | 44 |
|
| 43 |
- env.big_packet_size: Specifies the number of data bytes to be sent in the big
|
|
| 45 |
=item env.big_packet_size: Specifies the number of data bytes to be sent in the big
|
|
| 44 | 46 |
packets. The default is 108. The size should be chosen so that big packet roundtrip times |
| 45 | 47 |
are long enough to be accurately measured. |
| 46 | 48 |
|
| 47 |
- env.max_valid_bps: bing have some random spikes. This variable is used to indicate
|
|
| 49 |
=item env.max_valid_bps: bing have some random spikes. This variable is used to indicate
|
|
| 48 | 50 |
the maximum value of mbps that can be recorded (in bps). |
| 49 | 51 |
Defaults to the empty string (no validity check). |
| 50 | 52 |
|
| 53 |
=back |
|
| 54 |
|
|
| 55 |
|
|
| 51 | 56 |
=head1 MAGIC MARKERS |
| 52 | 57 |
|
| 53 |
#%# capabilities=autoconf |
|
| 58 |
#%# capabilities=autoconf
|
|
| 54 | 59 |
|
| 55 | 60 |
=head1 VERSION |
| 56 | 61 |
|
| ... | ... | |
| 59 | 64 |
=head1 AUTHOR |
| 60 | 65 |
|
| 61 | 66 |
Jose Manuel Febrer Cortés <https://www.linkedin.com/in/jfebrer/> |
| 67 |
|
|
| 62 | 68 |
Marco Bertola’s help <https://www.linkedin.com/in/bertolamarco/> |
| 63 | 69 |
|
| 64 | 70 |
=head1 LICENSE |
Formats disponibles : Unified diff