| Susheel Yadagiri | 6fb7447 | 2014-06-20 16:26:39 -0700 | [diff] [blame] | 1 | This target can be used to identify when interfaces have been idle for a |
| 2 | certain period of time. Timers are identified by labels and are created when |
| 3 | a rule is set with a new label. The rules also take a timeout value (in |
| 4 | seconds) as an option. If more than one rule uses the same timer label, the |
| 5 | timer will be restarted whenever any of the rules get a hit. One entry for |
| 6 | each timer is created in sysfs. This attribute contains the timer remaining |
| 7 | for the timer to expire. The attributes are located under the xt_hardidletimer |
| 8 | class: |
| 9 | .PP |
| 10 | /sys/class/xt_hardidletimer/timers/<label> |
| 11 | .PP |
| 12 | When the timer expires, the target module sends a sysfs notification to the |
| 13 | userspace, which can then decide what to do (eg. disconnect to save power). |
| 14 | .TP |
| 15 | \fB\-\-timeout\fP \fIamount\fP |
| 16 | This is the time in seconds that will trigger the notification. |
| 17 | .TP |
| 18 | \fB\-\-label\fP \fIstring\fP |
| 19 | This is a unique identifier for the timer. The maximum length for the |
| 20 | label string is 27 characters. |
| 21 | .TP |
| 22 | \fB\-\---send_nl_msg\fP \fI(0/1)\fP |
| 23 | Send netlink messages in addition to sysfs notifications and show remaining |
| 24 | time. Defaults to 0. |