blob: e3c91cea09304d2c312fb5fd80a30eb64fb59712 [file] [log] [blame]
Luciano Coelhod96993e2010-06-15 16:54:50 +02001This target can be used to identify when interfaces have been idle for a
2certain period of time. Timers are identified by labels and are created when
3a rule is set with a new label. The rules also take a timeout value (in
4seconds) as an option. If more than one rule uses the same timer label, the
5timer will be restarted whenever any of the rules get a hit. One entry for
6each timer is created in sysfs. This attribute contains the timer remaining
7for the timer to expire. The attributes are located under the xt_idletimer
8class:
9.PP
10/sys/class/xt_idletimer/timers/<label>
11.PP
12When the timer expires, the target module sends a sysfs notification to the
13userspace, which can then decide what to do (eg. disconnect to save power).
14.TP
15\fB\-\-timeout\fP \fIamount\fP
16This is the time in seconds that will trigger the notification.
17.TP
18\fB\-\-label\fP \fIstring\fP
Luciano Coelho67195a82010-07-15 17:12:56 +020019This is a unique identifier for the timer. The maximum length for the
20label string is 27 characters.