<emclass="default">(defaults to: <tt>true</tt>)</em>
—
<divclass='inline'>
<p>Whether to manage the fail2ban configuration files. If set to false, fail2ban will be installed, but the configuration will not be managed.</p>
</div>
</li>
<li>
<spanclass='name'>fn_enable_service</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'running'</tt>)</em>
—
<divclass='inline'>
<p>Whether to enable/start or disable/stop the fail2ban service. Valid options are <code>running</code> or <code>stopped</code>.</p>
</div>
</li>
<li>
<spanclass='name'>fn_loglevel</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'INFO'</tt>)</em>
—
<divclass='inline'>
<p>Set the log level output. Valid options are</p>
</div>
</li>
<li>
<spanclass='name'>fn_logtarget</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'SYSLOG'</tt>)</em>
—
<divclass='inline'>
<p>Set the log target. This could be a file, SYSLOG, STDERR or STDOUT. Only one log target can be specified.</p>
</div>
</li>
<li>
<spanclass='name'>fn_syslogsocket</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'auto'</tt>)</em>
—
<divclass='inline'>
<p>Set the syslog socket file. Only used when logtarget is SYSLOG. auto uses platform.system() to determine predefined paths Valid options: [ auto | FILE ].</p>
</div>
</li>
<li>
<spanclass='name'>fn_socket</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'/var/run/fail2ban/fail2ban.sock'</tt>)</em>
—
<divclass='inline'>
<p>Set the socket file to communicate with the daemon.</p>
</div>
</li>
<li>
<spanclass='name'>fn_pidfile</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'/var/run/fail2ban/fail2ban.pid'</tt>)</em>
—
<divclass='inline'>
<p>Set the PID file to store the process ID of the fail2ban server.</p>
</div>
</li>
<li>
<spanclass='name'>fn_dbfile</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'/var/lib/fail2ban/fail2ban.sqlite3'</tt>)</em>
—
<divclass='inline'>
<p>file for the fail2ban persistent data to be stored. A value of “:memory:” means database is only stored in memory and data is lost when fail2ban is stopped. A value of “None” disables the database.</p>
</div>
</li>
<li>
<spanclass='name'>fn_dbpurgeage</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'86400'</tt>)</em>
—
<divclass='inline'>
<p>age in seconds at which bans should be purged from the database.</p>
</div>
</li>
<li>
<spanclass='name'>fn_ignoreip</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'127.0.0.1/8'</tt>)</em>
—
<divclass='inline'>
<p>can be an IP address, a CIDR mask or a DNS host. Fail2ban will not ban a host which matches an address in this list. Several addresses can be defined using space (and/or comma) separator.</p>
<emclass="default">(defaults to: <tt>undef</tt>)</em>
—
<divclass='inline'>
<p>External command that will take an tagged arguments to ignore, e.g. <ip>,and return true if the IP is to be ignored. False otherwise.</p>
</div>
</li>
<li>
<spanclass='name'>fn_bantime</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'600'</tt>)</em>
—
<divclass='inline'>
<p>number of seconds that a host is banned.</p>
</div>
</li>
<li>
<spanclass='name'>fn_findtime</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'600'</tt>)</em>
—
<divclass='inline'>
<p>A host is banned if it has generated “maxretry” during the last “findtime” seconds.</p>
</div>
</li>
<li>
<spanclass='name'>fn_maxretry</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'5'</tt>)</em>
—
<divclass='inline'>
<p>number of failures before a host get banned.</p>
</div>
</li>
<li>
<spanclass='name'>fn_backend</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'auto'</tt>)</em>
—
<divclass='inline'>
<p>specifies the backend used to get files modification. options are “pyinotify”, “gamin”, “polling”, “systemd” and “auto”. pyinotify: requires pyinotify (a file alteration monitor) to be installed. If pyinotify is not installed, Fail2ban will use auto. gamin: requires Gamin (a file alteration monitor) to be installed. If Gamin is not installed, Fail2ban will use auto. polling: uses a polling algorithm which does not require external libraries. systemd: uses systemd python library to access the systemd journal. Specifying “logpath” is not valid for this backend. See “journalmatch” in the jails associated filter config auto: will try to use the following backends, in order: pyinotify, gamin, polling.</p>
</div>
</li>
<li>
<spanclass='name'>fn_usedns</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'warn'</tt>)</em>
—
<divclass='inline'>
<p>specifies if jails should trust hostnames in logs, warn when DNS lookups are performed, or ignore all hostnames in logs yes: if a hostname is encountered, a DNS lookup will be performed. warn: if a hostname is encountered, a DNS lookup will be performed, but it will be logged as a warning. no: if a hostname is encountered, will not be used for banning, but it will be logged as info. raw: use raw value (no hostname), allow use it for no-host filters/actions (example user)</p>
</div>
</li>
<li>
<spanclass='name'>fn_logencoding</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'auto'</tt>)</em>
—
<divclass='inline'>
<p>specifies the encoding of the log files handled by the jail This is used to decode the lines from the log file. Typical examples: “ascii”, “utf-8” auto: will use the system locale setting</p>
</div>
</li>
<li>
<spanclass='name'>fn_enabled</span>
<spanclass='type'>(<tt>Boolean</tt>)</span>
<emclass="default">(defaults to: <tt>false</tt>)</em>
—
<divclass='inline'>
<p>enables the jails. By default all jails are disabled, and it should stay this way. Enable only relevant to your setup jails in your .local or jail.d/*.conf true: jail will be enabled and log files will get monitored for changes false: jail is not enabled</p>
</div>
</li>
<li>
<spanclass='name'>fn_filter</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'%(__name__)s'</tt>)</em>
—
<divclass='inline'>
<p>defines the filter to use by the jail. By default jails have names matching their filter name</p>
</div>
</li>
<li>
<spanclass='name'>fn_destemail</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'root@localhost'</tt>)</em>
—
<divclass='inline'>
<p>Destination email address used solely for the interpolations in jail.confconf.localconf.local.d/* configuration files.</p>
</div>
</li>
<li>
<spanclass='name'>fn_mta</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'sendmail'</tt>)</em>
—
<divclass='inline'>
<p>E-mail action. Since 0.8.1 Fail2Ban uses sendmail MTA for the mailing. Change mta configuration parameter to mail if you want to revert to conventional ‘mail’.</p>
</div>
</li>
<li>
<spanclass='name'>fn_protocol</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'tcp'</tt>)</em>
—
<divclass='inline'>
<p>Default protocol.</p>
</div>
</li>
<li>
<spanclass='name'>fn_chain</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'INPUT'</tt>)</em>
—
<divclass='inline'>
<p>Specify chain where jumps would need to be added in iptables-* actions.</p>
</div>
</li>
<li>
<spanclass='name'>fn_port</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'0:65535'</tt>)</em>
—
<divclass='inline'>
<h1id="label-Ports+to+be+banned+Usually+should+be+overridden">Ports to be banned Usually should be overridden</h1>
<p>in a particular jail</p>
</div>
</li>
<li>
<spanclass='name'>fn_fail2ban_agent</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'Fail2Ban/%(fail2ban_version)s'</tt>)</em>
—
<divclass='inline'>
<p>Format of user-agent <ahref="https://tools.ietf.org/html/rfc7231#section-5.5.3">tools.ietf.org/html/rfc7231#section-5.5.3</a></p>
</div>
</li>
<li>
<spanclass='name'>fn_banaction</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'iptables-multiport'</tt>)</em>
—
<divclass='inline'>
<p>Default banning action</p>
</div>
</li>
<li>
<spanclass='name'>fn_banaction_allports</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'iptables-allports'</tt>)</em>
—
<divclass='inline'>
<p>Default banning action</p>
</div>
</li>
<li>
<spanclass='name'>fn_action_</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'%(banaction)s[name=%(__name__)s, bantime="%(bantime)s", port="%(port)s", protocol="%(protocol)s", chain="%(chain)s"]'</tt>)</em>
—
<divclass='inline'>
<p>ban only</p>
</div>
</li>
<li>
<spanclass='name'>fn_action_mw</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'%(banaction)s[name=%(__name__)s, bantime="%(bantime)s", port="%(port)s", protocol="%(protocol)s", chain="%(chain)s"]
<p>ban IP on CloudFlare & send an e-mail with whois report and relevant log lines.</p>
</div>
</li>
<li>
<spanclass='name'>fn_action_blocklist_de</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'blocklist_de[email="%(sender)s", service=%(filter)s, apikey="%(blocklist_de_apikey)s", agent="%(fail2ban_agent)s"]'</tt>)</em>
—
<divclass='inline'>
<p>Report block via blocklist.de fail2ban reporting service API</p>
</div>
</li>
<li>
<spanclass='name'>fn_action_badips</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'badips.py[category="%(__name__)s", banaction="%(banaction)s", agent="%(fail2ban_agent)s"]'</tt>)</em>
—
<divclass='inline'>
<p>String to be be used in config files</p>
</div>
</li>
<li>
<spanclass='name'>fn_action_badips_report</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'badips[category="%(__name__)s", agent="%(fail2ban_agent)s"]'</tt>)</em>
—
<divclass='inline'>
<h1id="label-Report+ban+via+badips.com">Report ban via badips.com</h1>
<p>(uses action.d/badips.conf for reporting only).</p>
</div>
</li>
<li>
<spanclass='name'>fn_default_action</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'action_'</tt>)</em>
—
<divclass='inline'>
<p>Choose default action.</p>
</div>
</li>
<li>
<spanclass='name'>fn_jail_paths</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'fedora'</tt>)</em>
