|
|
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.36. |
|
|
.TH FAIL2BAN-CLIENT "1" "April 2007" "fail2ban-client v0.7.9" "User Commands" |
|
|
.SH NAME |
|
|
fail2ban-client \- configure and control the server |
|
|
.SH DESCRIPTION |
|
|
[?1034hUsage: ../fail2ban\-client [OPTIONS] <COMMAND> |
|
|
.PP |
|
|
Fail2Ban v0.7.9 reads log file that contains password failure report |
|
|
and bans the corresponding IP addresses using firewall rules. |
|
|
.SH OPTIONS |
|
|
.TP |
|
|
\fB\-c\fR <DIR> |
|
|
configuration directory |
|
|
.TP |
|
|
\fB\-s\fR <FILE> |
|
|
socket path |
|
|
.TP |
|
|
\fB\-d\fR |
|
|
dump configuration. For debugging |
|
|
.TP |
|
|
\fB\-i\fR |
|
|
interactive mode |
|
|
.TP |
|
|
\fB\-v\fR |
|
|
increase verbosity |
|
|
.TP |
|
|
\fB\-q\fR |
|
|
decrease verbosity |
|
|
.TP |
|
|
\fB\-x\fR |
|
|
force execution of the server (remove socket file) |
|
|
.TP |
|
|
\fB\-h\fR, \fB\-\-help\fR |
|
|
display this help message |
|
|
.TP |
|
|
\fB\-V\fR, \fB\-\-version\fR |
|
|
print the version |
|
|
.SH COMMAND |
|
|
.IP |
|
|
BASIC |
|
|
.TP |
|
|
\fBstart\fR |
|
|
starts the server and the jails |
|
|
.TP |
|
|
\fBreload\fR |
|
|
reloads the configuration |
|
|
.TP |
|
|
\fBstop\fR |
|
|
stops all jails and terminate the |
|
|
server |
|
|
.TP |
|
|
\fBstatus\fR |
|
|
gets the current status of the |
|
|
server |
|
|
.TP |
|
|
\fBping\fR |
|
|
tests if the server is alive |
|
|
.IP |
|
|
LOGGING |
|
|
.TP |
|
|
\fBset loglevel <LEVEL>\fR |
|
|
sets logging level to <LEVEL>. 0 |
|
|
is minimal, 4 is debug |
|
|
.TP |
|
|
\fBget loglevel\fR |
|
|
gets the logging level |
|
|
.TP |
|
|
\fBset logtarget <TARGET>\fR |
|
|
sets logging target to <TARGET>. |
|
|
Can be STDOUT, STDERR, SYSLOG or a |
|
|
file |
|
|
.TP |
|
|
\fBget logtarget\fR |
|
|
gets logging target |
|
|
.IP |
|
|
JAIL CONTROL |
|
|
.TP |
|
|
\fBadd <JAIL> <BACKEND>\fR |
|
|
creates <JAIL> using <BACKEND> |
|
|
.TP |
|
|
\fBstart <JAIL>\fR |
|
|
starts the jail <JAIL> |
|
|
.TP |
|
|
\fBstop <JAIL>\fR |
|
|
stops the jail <JAIL>. The jail is |
|
|
removed |
|
|
.TP |
|
|
\fBstatus <JAIL>\fR |
|
|
gets the current status of <JAIL> |
|
|
.IP |
|
|
JAIL CONFIGURATION |
|
|
.TP |
|
|
\fBset <JAIL> idle on|off\fR |
|
|
sets the idle state of <JAIL> |
|
|
.TP |
|
|
\fBset <JAIL> addignoreip <IP>\fR |
|
|
adds <IP> to the ignore list of |
|
|
<JAIL> |
|
|
.TP |
|
|
\fBset <JAIL> delignoreip <IP>\fR |
|
|
removes <IP> from the ignore list |
|
|
of <JAIL> |
|
|
.TP |
|
|
\fBset <JAIL> addlogpath <FILE>\fR |
|
|
adds <FILE> to the monitoring list |
|
|
of <JAIL> |
|
|
.TP |
|
|
\fBset <JAIL> dellogpath <FILE>\fR |
|
|
removes <FILE> to the monitoring |
|
|
list of <JAIL> |
|
|
.TP |
|
|
\fBset <JAIL> timeregex <REGEX>\fR |
|
|
sets the regular expression |
|
|
<REGEX> to match the date format |
|
|
for <JAIL>. This will disable the |
|
|
autodetection feature. |
|
|
.TP |
|
|
\fBset <JAIL> timepattern <PATTERN>\fR |
|
|
sets the pattern <PATTERN> to |
|
|
match the date format for <JAIL>. |
|
|
This will disable the |
|
|
autodetection feature. |
|
|
.TP |
|
|
\fBset <JAIL> addfailregex <REGEX>\fR |
|
|
adds the regular expression |
|
|
<REGEX> which must match failures |
|
|
for <JAIL> |
|
|
.TP |
|
|
\fBset <JAIL> delfailregex <INDEX>\fR |
|
|
removes the regular expression at |
|
|
<INDEX> for failregex |
|
|
.TP |
|
|
\fBset <JAIL> addignoreregex <REGEX>\fR |
|
|
adds the regular expression |
|
|
<REGEX> which should match pattern |
|
|
to exclude for <JAIL> |
|
|
.TP |
|
|
\fBset <JAIL> delignoreregex <INDEX>\fR |
|
|
removes the regular expression at |
|
|
<INDEX> for ignoreregex |
|
|
.TP |
|
|
\fBset <JAIL> findtime <TIME>\fR |
|
|
sets the number of seconds <TIME> |
|
|
for which the filter will look |
|
|
back for <JAIL> |
|
|
.TP |
|
|
\fBset <JAIL> bantime <TIME>\fR |
|
|
sets the number of seconds <TIME> |
|
|
a host will be banned for <JAIL> |
|
|
.TP |
|
|
\fBset <JAIL> maxretry <RETRY>\fR |
|
|
sets the number of failures |
|
|
<RETRY> before banning the host |
|
|
for <JAIL> |
|
|
.TP |
|
|
\fBset <JAIL> addaction <ACT>\fR |
|
|
adds a new action named <NAME> for |
|
|
<JAIL> |
|
|
.TP |
|
|
\fBset <JAIL> delaction <ACT>\fR |
|
|
removes the action <NAME> from |
|
|
<JAIL> |
|
|
.TP |
|
|
\fBset <JAIL> setcinfo <ACT> <KEY> <VALUE>\fR |
|
|
sets <VALUE> for <KEY> of the |
|
|
action <NAME> for <JAIL> |
|
|
.TP |
|
|
\fBset <JAIL> delcinfo <ACT> <KEY>\fR |
|
|
removes <KEY> for the action |
|
|
<NAME> for <JAIL> |
|
|
.TP |
|
|
\fBset <JAIL> actionstart <ACT> <CMD>\fR |
|
|
sets the start command <CMD> of |
|
|
the action <ACT> for <JAIL> |
|
|
.TP |
|
|
\fBset <JAIL> actionstop <ACT> <CMD>\fR |
|
|
sets the stop command <CMD> of the |
|
|
action <ACT> for <JAIL> |
|
|
.TP |
|
|
\fBset <JAIL> actioncheck <ACT> <CMD>\fR |
|
|
sets the check command <CMD> of |
|
|
the action <ACT> for <JAIL> |
|
|
.TP |
|
|
\fBset <JAIL> actionban <ACT> <CMD>\fR |
|
|
sets the ban command <CMD> of the |
|
|
action <ACT> for <JAIL> |
|
|
.TP |
|
|
\fBset <JAIL> actionunban <ACT> <CMD>\fR |
|
|
sets the unban command <CMD> of |
|
|
the action <ACT> for <JAIL> |
|
|
.IP |
|
|
JAIL INFORMATION |
|
|
.TP |
|
|
\fBget <JAIL> logpath\fR |
|
|
gets the list of the monitored |
|
|
files for <JAIL> |
|
|
.TP |
|
|
\fBget <JAIL> ignoreip\fR |
|
|
gets the list of ignored IP |
|
|
addresses for <JAIL> |
|
|
.TP |
|
|
\fBget <JAIL> timeregex\fR |
|
|
gets the regular expression used |
|
|
for the time detection for <JAIL> |
|
|
.TP |
|
|
\fBget <JAIL> timepattern\fR |
|
|
gets the pattern used for the time |
|
|
detection for <JAIL> |
|
|
.TP |
|
|
\fBget <JAIL> failregex\fR |
|
|
gets the list of regular |
|
|
expressions which matches the |
|
|
failures for <JAIL> |
|
|
.TP |
|
|
\fBget <JAIL> ignoreregex\fR |
|
|
gets the list of regular |
|
|
expressions which matches patterns |
|
|
to ignore for <JAIL> |
|
|
.TP |
|
|
\fBget <JAIL> findtime\fR |
|
|
gets the time for which the filter |
|
|
will look back for failures for |
|
|
<JAIL> |
|
|
.TP |
|
|
\fBget <JAIL> bantime\fR |
|
|
gets the time a host is banned for |
|
|
<JAIL> |
|
|
.TP |
|
|
\fBget <JAIL> maxretry\fR |
|
|
gets the number of failures |
|
|
allowed for <JAIL> |
|
|
.TP |
|
|
\fBget <JAIL> addaction\fR |
|
|
gets the last action which has |
|
|
been added for <JAIL> |
|
|
.TP |
|
|
\fBget <JAIL> actionstart <ACT>\fR |
|
|
gets the start command for the |
|
|
action <ACT> for <JAIL> |
|
|
.TP |
|
|
\fBget <JAIL> actionstop <ACT>\fR |
|
|
gets the stop command for the |
|
|
action <ACT> for <JAIL> |
|
|
.TP |
|
|
\fBget <JAIL> actioncheck <ACT>\fR |
|
|
gets the check command for the |
|
|
action <ACT> for <JAIL> |
|
|
.TP |
|
|
\fBget <JAIL> actionban <ACT>\fR |
|
|
gets the ban command for the |
|
|
action <ACT> for <JAIL> |
|
|
.TP |
|
|
\fBget <JAIL> actionunban <ACT>\fR |
|
|
gets the unban command for the |
|
|
action <ACT> for <JAIL> |
|
|
.SH FILES |
|
|
\fI/etc/fail2ban/*\fR |
|
|
.SH AUTHOR |
|
|
Written by Cyril Jaquier <lostcontrol@users.sourceforge.net>. |
|
|
Many contributions by Yaroslav O. Halchenko <debian@onerussian.com>. |
|
|
.SH "REPORTING BUGS" |
|
|
Report bugs to <lostcontrol@users.sourceforge.net> |
|
|
.SH COPYRIGHT |
|
|
Copyright \(co 2004-2006 Cyril Jaquier |
|
|
.br |
|
|
Copyright of modifications held by their respective authors. |
|
|
Licensed under the GNU General Public License v2 (GPL). |
|
|
.SH "SEE ALSO" |
|
|
.br |
|
|
fail2ban-server(1)
|
|
|
|
