traffic-monitor
tool/traffic-monitor
Type: Directory
Threshold trigger: run a script (on-event) when an interface's transmit or receive rate crosses a threshold.
| Flag | Name | Description |
|---|---|---|
| X | disabled | disabled |
| I | invalid | invalid |
| Argument | Type | Description |
|---|---|---|
| name | string | Name of the traffic monitor entry |
| interface ( mandatory ) | iface_enum | Interface whose rate is watched |
| traffic | enum (transmitted | received) { transmitted:1, received:2 } | Direction to watch: transmitted or received |
| trigger | enum (above | below | always) { above:1, below:2, always:3 } | When on-event runs: when the rate crosses above the threshold, crosses below it, or always (on every poll). |
| threshold | num | Traffic rate in bits per second that the trigger compares against |
| on-event | alt { script: string } | Script run when the trigger condition is met |