Blame doc/xml/firewall-cmd.xml.in

Packit a8ec6b
Packit a8ec6b
Packit a8ec6b
[
Packit a8ec6b
Packit a8ec6b
Packit a8ec6b
Packit a8ec6b
Packit a8ec6b
]>
Packit a8ec6b
Packit a8ec6b
Packit a8ec6b
  This file is part of firewalld.
Packit a8ec6b
Packit a8ec6b
  Copyright (C) 2010-2014 Red Hat, Inc.
Packit a8ec6b
  Authors:
Packit a8ec6b
  Thomas Woerner <twoerner@redhat.com>
Packit a8ec6b
Packit a8ec6b
  This program is free software; you can redistribute it and/or modify
Packit a8ec6b
  it under the terms of the GNU General Public License as published by
Packit a8ec6b
  the Free Software Foundation; either version 2 of the License, or
Packit a8ec6b
  (at your option) any later version.
Packit a8ec6b
Packit a8ec6b
  This program is distributed in the hope that it will be useful,
Packit a8ec6b
  but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit a8ec6b
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Packit a8ec6b
  GNU General Public License for more details.
Packit a8ec6b
Packit a8ec6b
  You should have received a copy of the GNU General Public License
Packit a8ec6b
  along with this program.  If not, see <http://www.gnu.org/licenses/>.
Packit a8ec6b
-->
Packit a8ec6b
Packit a8ec6b
<refentry id="firewall-cmd">
Packit a8ec6b
Packit a8ec6b
  <refentryinfo>
Packit a8ec6b
    <title>firewall-cmd</title>
Packit a8ec6b
    <productname>firewalld</productname>
Packit a8ec6b
    &authors;
Packit a8ec6b
  </refentryinfo>
Packit a8ec6b
Packit a8ec6b
  <refmeta>
Packit a8ec6b
    <refentrytitle>firewall-cmd</refentrytitle>
Packit a8ec6b
    <manvolnum>1</manvolnum>
Packit a8ec6b
  </refmeta>
Packit a8ec6b
Packit a8ec6b
  <refnamediv>
Packit a8ec6b
    <refname>firewall-cmd</refname>
Packit a8ec6b
    <refpurpose>firewalld command line client</refpurpose>
Packit a8ec6b
  </refnamediv>
Packit a8ec6b
Packit a8ec6b
  <refsynopsisdiv>
Packit a8ec6b
    <cmdsynopsis>
Packit a8ec6b
      <command>firewall-cmd</command> <arg choice="opt" rep="repeat">OPTIONS</arg>
Packit a8ec6b
    </cmdsynopsis>
Packit a8ec6b
  </refsynopsisdiv>
Packit a8ec6b
Packit a8ec6b
  <refsect1 id="description">
Packit a8ec6b
    <title>Description</title>
Packit a8ec6b
		
Packit a8ec6b
    <para>
Packit Service 9bd718
      firewall-cmd is the command line client of the firewalld daemon. It provides interface to manage runtime and permanent configuration.
Packit a8ec6b
    </para>
Packit a8ec6b
Packit a8ec6b
    <para>
Packit a8ec6b
      The runtime configuration in firewalld is separated from the permanent configuration. This means that things can get changed in the runtime or permanent configuration.
Packit a8ec6b
    </para>
Packit a8ec6b
  </refsect1>
Packit a8ec6b
Packit a8ec6b
  <refsect1 id="options">
Packit a8ec6b
    <title>Options</title>
Packit a8ec6b
    <para>
Packit a8ec6b
      Sequence options are the options that can be specified multiple times, the exit code is 0 if there is at least one item that succeeded. The <literal>ALREADY_ENABLED</literal> (11), <literal>NOT_ENABLED</literal> (12) and also <literal>ZONE_ALREADY_SET</literal> (16) errors are treated as succeeded.
Packit a8ec6b
      If there are issues while parsing the items, then these are treated as warnings and will not change the result as long as there is a succeeded one.
Packit a8ec6b
      Without any succeeded item, the exit code will depend on the error codes. If there is exactly one error code, then this is used. If there are more than one then <literal>UNKNOWN_ERROR</literal> (254) will be used.
Packit a8ec6b
    </para>
Packit a8ec6b
Packit a8ec6b
    <para>
Packit a8ec6b
      The following options are supported:
Packit a8ec6b
    </para>
Packit a8ec6b
Packit a8ec6b
    <refsect2 id="general_options">
Packit a8ec6b
      <title>General Options</title>
Packit a8ec6b
      <variablelist>
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
          <term><option>-h</option></term>
Packit a8ec6b
          <term><option>--help</option></term>
Packit a8ec6b
          <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Prints a short help text and exits.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
          <term><option>-V</option></term>
Packit a8ec6b
          <term><option>--version</option></term>
Packit a8ec6b
          <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Print the version string of firewalld. This option is not combinable with other options.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
          <term><option>-q</option></term>
Packit a8ec6b
          <term><option>--quiet</option></term>
Packit a8ec6b
          <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Do not print status messages.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
      </variablelist>
Packit a8ec6b
    </refsect2>
Packit a8ec6b
Packit a8ec6b
    <refsect2 id="status_options">
Packit a8ec6b
      <title>Status Options</title>
Packit a8ec6b
      <variablelist>
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><option>--state</option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Check whether the firewalld daemon is active (i.e. running). Returns an exit code 0 if it is active, <replaceable>RUNNING_BUT_FAILED</replaceable> if failure occurred on startup, <replaceable>NOT_RUNNING</replaceable> otherwise. See <xref linkend="exit_codes"/>. This will also print the state to <replaceable>STDOUT</replaceable>.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><option>--reload</option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Reload firewall rules and keep state information.
Packit a8ec6b
	      Current permanent configuration will become new runtime configuration,
Packit a8ec6b
	      i.e. all runtime only changes done until reload are lost with reload
Packit a8ec6b
	      if they have not been also in permanent configuration.
Packit a8ec6b
	    </para>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Note: Runtime changes applied via the direct interface are not
Packit a8ec6b
	      affected and will therefore stay in place until firewalld daemon
Packit a8ec6b
	      is restarted completely.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><option>--complete-reload</option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Reload firewall completely, even netfilter kernel modules. This will most likely terminate active connections, because state information is lost. This option should only be used in case of severe firewall problems. For example if there are state information problems that no connection can be established with correct firewall rules.
Packit a8ec6b
	    </para>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Note: Runtime changes applied via the direct interface are not
Packit a8ec6b
	      affected and will therefore stay in place until firewalld daemon
Packit a8ec6b
	      is restarted completely.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><option>--runtime-to-permanent</option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Save active runtime configuration and overwrite permanent configuration with it.
Packit a8ec6b
	      The way this is supposed to work is that when configuring firewalld you do runtime changes only and
Packit a8ec6b
	      once you're happy with the configuration and you tested that it works the way you want, you save
Packit a8ec6b
	      the configuration to disk.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
    <varlistentry>
Packit a8ec6b
      <term><option>--check-config</option></term>
Packit a8ec6b
      <listitem>
Packit a8ec6b
        <para>
Packit a8ec6b
          Run checks on the permanent configuration. This includes XML validity
Packit a8ec6b
          and semantics.
Packit a8ec6b
        </para>
Packit a8ec6b
      </listitem>
Packit a8ec6b
    </varlistentry>
Packit a8ec6b
      </variablelist>
Packit a8ec6b
    </refsect2>
Packit a8ec6b
Packit a8ec6b
    <refsect2 id="log_denied_options">
Packit a8ec6b
      <title>Log Denied Options</title>
Packit a8ec6b
      <variablelist>
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><option>--get-log-denied</option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Print the log denied setting.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><option>--set-log-denied</option>=<replaceable>value</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Add logging rules right before reject and drop rules in the INPUT, FORWARD and OUTPUT chains for the default rules and also final reject and drop rules in zones for the configured link-layer packet type. The possible values are: <replaceable>all</replaceable>, <replaceable>unicast</replaceable>, <replaceable>broadcast</replaceable>, <replaceable>multicast</replaceable> and <replaceable>off</replaceable>. The default setting is <replaceable>off</replaceable>, which disables the logging.
Packit a8ec6b
	    </para>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      This is a runtime and permanent change and will also reload the firewall to be able to add the logging rules.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
      </variablelist>
Packit a8ec6b
    </refsect2>
Packit a8ec6b
Packit a8ec6b
    <refsect2 id="permanent_options">
Packit a8ec6b
      <title>Permanent Options</title>
Packit a8ec6b
      <variablelist>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
          <term><option>--permanent</option></term>
Packit a8ec6b
          <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      The permanent option <option>--permanent</option> can be used to set options permanently. These changes are not effective immediately, only after service restart/reload or system reboot. Without the <option>--permanent</option> option, a change will only be part of the runtime configuration.
Packit a8ec6b
	    </para>
Packit a8ec6b
	    <para>If you want to make a change in runtime and permanent configuration, use the same call with and without the <option>--permanent</option> option.
Packit a8ec6b
	    </para>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      The <option>--permanent</option> option can be optionally added to all options further down where it is supported.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
      </variablelist>
Packit a8ec6b
    </refsect2>
Packit a8ec6b
Packit a8ec6b
    <refsect2 id="zone_options">
Packit a8ec6b
      <title>Zone Options</title>
Packit a8ec6b
      <variablelist>
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><option>--get-default-zone</option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Print default zone for connections and interfaces.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><option>--set-default-zone</option>=<replaceable>zone</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Set default zone for connections and interfaces where no zone has been selected. Setting the default zone changes the zone for the connections or interfaces, that are using the default zone.
Packit a8ec6b
	    </para>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      This is a runtime and permanent change.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><option>--get-active-zones</option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Print currently active zones altogether with interfaces and sources used in these zones. Active zones are zones, that have a binding to an interface or source. The output format is:
Packit a8ec6b
	      <programlisting>
Packit a8ec6b
<replaceable>zone1</replaceable>
Packit a8ec6b
  interfaces: <replaceable>interface1</replaceable> <replaceable>interface2</replaceable> ..
Packit a8ec6b
  sources: <replaceable>source1</replaceable> ..
Packit a8ec6b
<replaceable>zone2</replaceable>
Packit a8ec6b
  interfaces: <replaceable>interface3</replaceable> ..
Packit a8ec6b
<replaceable>zone3</replaceable>
Packit a8ec6b
  sources: <replaceable>source2</replaceable> ..
Packit a8ec6b
	      </programlisting>
Packit a8ec6b
	      If there are no interfaces or sources bound to the zone, the corresponding line will be omitted.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--get-zones</option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Print predefined zones as a space separated list.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--get-services</option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Print predefined services as a space separated list.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--get-icmptypes</option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Print predefined icmptypes as a space separated list.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--get-zone-of-interface</option>=<replaceable>interface</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Print the name of the zone the <replaceable>interface</replaceable> is bound to or <emphasis>no zone</emphasis>.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--get-zone-of-source</option>=<replaceable>source</replaceable><optional>/<replaceable>mask</replaceable></optional>|<replaceable>MAC</replaceable>|ipset:<replaceable>ipset</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Print the name of the zone the source is bound to or <emphasis>no zone</emphasis>.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--info-zone=<replaceable>zone</replaceable></option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Print information about the zone <replaceable>zone</replaceable>. The output format is:
Packit a8ec6b
	      <programlisting>
Packit a8ec6b
<replaceable>zone</replaceable>
Packit a8ec6b
  interfaces: <replaceable>interface1</replaceable> ..
Packit a8ec6b
  sources: <replaceable>source1</replaceable> ..
Packit a8ec6b
  services: <replaceable>service1</replaceable> ..
Packit a8ec6b
  ports: <replaceable>port1</replaceable> ..
Packit a8ec6b
  protocols: <replaceable>protocol1</replaceable> ..
Packit a8ec6b
  forward-ports:
Packit a8ec6b
        <replaceable>forward-port1</replaceable>
Packit a8ec6b
        ..
Packit a8ec6b
  source-ports: <replaceable>source-port1</replaceable> ..
Packit a8ec6b
  icmp-blocks: <replaceable>icmp-type1</replaceable> ..
Packit a8ec6b
  rich rules:
Packit a8ec6b
        <replaceable>rich-rule1</replaceable>
Packit a8ec6b
        ..
Packit a8ec6b
              </programlisting>
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--list-all-zones</option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      List everything added for or enabled in all zones. The output format is:
Packit a8ec6b
	      <programlisting>
Packit a8ec6b
<replaceable>zone1</replaceable>
Packit a8ec6b
  interfaces: <replaceable>interface1</replaceable> ..
Packit a8ec6b
  sources: <replaceable>source1</replaceable> ..
Packit a8ec6b
  services: <replaceable>service1</replaceable> ..
Packit a8ec6b
  ports: <replaceable>port1</replaceable> ..
Packit a8ec6b
  protocols: <replaceable>protocol1</replaceable> ..
Packit a8ec6b
  forward-ports:
Packit a8ec6b
        <replaceable>forward-port1</replaceable>
Packit a8ec6b
        ..
Packit a8ec6b
  icmp-blocks: <replaceable>icmp-type1</replaceable> ..
Packit a8ec6b
  rich rules:
Packit a8ec6b
        <replaceable>rich-rule1</replaceable>
Packit a8ec6b
        ..
Packit a8ec6b
..
Packit a8ec6b
              </programlisting>
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
          <term><option>--permanent</option> <option>--new-zone</option>=<replaceable>zone</replaceable></term>
Packit a8ec6b
          <listitem>
Packit a8ec6b
            <para>
Packit a8ec6b
              Add a new permanent and empty zone.
Packit a8ec6b
            </para>
Packit a8ec6b
            <para>
Packit a8ec6b
              Zone names must be alphanumeric and may additionally include characters: '_' and '-'.
Packit a8ec6b
            </para>
Packit a8ec6b
          </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
          <term><option>--permanent</option> <option>--new-zone-from-file</option>=<replaceable>filename</replaceable> <optional><option>--name</option>=<replaceable>zone</replaceable></optional></term>
Packit a8ec6b
          <listitem>
Packit a8ec6b
            <para>
Packit a8ec6b
              Add a new permanent zone from a prepared zone file with an optional name override.
Packit a8ec6b
            </para>
Packit a8ec6b
          </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
          <term><option>--permanent</option> <option>--delete-zone</option>=<replaceable>zone</replaceable></term>
Packit a8ec6b
          <listitem>
Packit a8ec6b
            <para>
Packit a8ec6b
              Delete an existing permanent zone.
Packit a8ec6b
            </para>
Packit a8ec6b
          </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
          <term><option>--permanent</option> <option>--load-zone-defaults</option>=<replaceable>zone</replaceable></term>
Packit a8ec6b
          <listitem>
Packit a8ec6b
            <para>
Packit a8ec6b
              Load zone default settings or report NO_DEFAULTS error.
Packit a8ec6b
            </para>
Packit a8ec6b
          </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><option>--permanent</option> <option>--path-zone=<replaceable>zone</replaceable></option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Print path of the zone configuration file.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--zone</option>=<replaceable>zone</replaceable> <option>--set-description</option>=<replaceable>description</replaceable></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Set new description to zone
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--zone</option>=<replaceable>zone</replaceable> <option>--get-description</option></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Print description for zone
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--zone</option>=<replaceable>zone</replaceable> <option>--set-short</option>=<replaceable>description</replaceable></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Set short description to zone
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--zone</option>=<replaceable>zone</replaceable> <option>--get-short</option></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Print short description for zone
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
          <term><option>--permanent</option> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--get-target</option></term>
Packit a8ec6b
          <listitem>
Packit a8ec6b
            <para>
Packit a8ec6b
              Get the target of a permanent zone.
Packit a8ec6b
            </para>
Packit a8ec6b
          </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
          <term><option>--permanent</option> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--set-target</option>=<replaceable>target</replaceable></term>
Packit a8ec6b
          <listitem>
Packit a8ec6b
            <para>
Packit a8ec6b
              Set the target of a permanent zone. <replaceable>target</replaceable> is one of: <literal>default</literal>, <literal>ACCEPT</literal>, <literal>DROP</literal>, <literal>REJECT</literal>
Packit a8ec6b
            </para>
Packit a8ec6b
            <para>
Packit a8ec6b
              <literal>default</literal> is similar to <literal>REJECT</literal>, but has special meaning in the following scenarios:
Packit a8ec6b
              <orderedlist>
Packit a8ec6b
                <listitem><para>ICMP explicitly allowed</para>
Packit a8ec6b
                <para>
Packit a8ec6b
                  At the end of the zone's ruleset ICMP packets are explicitly allowed.
Packit a8ec6b
                </para>
Packit a8ec6b
                </listitem>
Packit a8ec6b
Packit a8ec6b
                <listitem><para>forwarded packets follow the <replaceable>target</replaceable> of the egress zone</para>
Packit a8ec6b
                <para>
Packit a8ec6b
                  In the case of forwarded packets, if the ingress zone uses <literal>default</literal> then whether or not the packet will be allowed is determined by the egress zone.
Packit a8ec6b
                </para>
Packit a8ec6b
                <para>
Packit a8ec6b
                  For a forwarded packet that ingresses zoneA and egresses zoneB:
Packit a8ec6b
                </para>
Packit a8ec6b
                <itemizedlist>
Packit a8ec6b
                <listitem>
Packit a8ec6b
                <para>if zoneA's <replaceable>target</replaceable> is <literal>ACCEPT</literal>, <literal>DROP</literal>, or <literal>REJECT</literal> then the packet is accepted, dropped, or rejected respectively.</para>
Packit a8ec6b
                </listitem>
Packit a8ec6b
                <listitem>
Packit a8ec6b
                <para>if zoneA's <replaceable>target</replaceable> is <literal>default</literal>, then the packet is accepted, dropped, or rejected based on zoneB's <replaceable>target</replaceable>. If zoneB's <replaceable>target</replaceable> is also <literal>default</literal>, then the packet will be rejected by firewalld's catchall reject.</para>
Packit a8ec6b
                </listitem>
Packit a8ec6b
                </itemizedlist>
Packit a8ec6b
                </listitem>
Packit a8ec6b
Packit a8ec6b
                <listitem><para>Zone drifting from source-based zone to interface-based zone</para>
Packit a8ec6b
                <para>
Packit a8ec6b
                  This only applies if <option>AllowZoneDrifting</option> is enabled. See <citerefentry><refentrytitle>firewalld.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
Packit a8ec6b
                </para>
Packit a8ec6b
                <para>
Packit a8ec6b
                  If a packet ingresses a source-based zone with a <replaceable>target</replaceable> of <literal>default</literal>, it may still enter an interface-based zone (including the default zone).
Packit a8ec6b
                </para>
Packit a8ec6b
                </listitem>
Packit a8ec6b
              </orderedlist>
Packit a8ec6b
            </para>
Packit a8ec6b
          </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
      </variablelist>
Packit a8ec6b
    </refsect2>
Packit a8ec6b
Packit a8ec6b
    <refsect2 id="options_to_adapt_and_query_zones">
Packit a8ec6b
      <title>Options to Adapt and Query Zones</title>
Packit a8ec6b
      <para>
Packit a8ec6b
	Options in this section affect only one particular zone. If used with <option>--zone</option>=<replaceable>zone</replaceable> option, they affect the zone <replaceable>zone</replaceable>. If the option is omitted, they affect default zone (see <option>--get-default-zone</option>).
Packit a8ec6b
      </para>
Packit a8ec6b
      <variablelist>
Packit a8ec6b
Packit a8ec6b
	
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--list-all</option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      List everything added for or enabled in <replaceable>zone</replaceable>. If zone is omitted, default zone will be used.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--list-services</option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      List services added for <replaceable>zone</replaceable> as a space separated list. If zone is omitted, default zone will be used.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--add-service</option>=<replaceable>service</replaceable> <optional><option>--timeout</option>=<replaceable>timeval</replaceable></optional></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Add a service for <replaceable>zone</replaceable>. If zone is omitted, default zone will be used. This option can be specified multiple times. If a timeout is supplied, the rule will be active for the specified amount of time and will be removed automatically afterwards.
Packit a8ec6b
	      <replaceable>timeval</replaceable> is either a number (of seconds) or number followed by one of characters <literal>s</literal> (seconds), <literal>m</literal> (minutes), <literal>h</literal> (hours), for example <literal>20m</literal> or <literal>1h</literal>.
Packit a8ec6b
	    </para>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      The service is one of the firewalld provided services. To get a list of the supported services, use <command>firewall-cmd --get-services</command>.
Packit a8ec6b
	    </para>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      The <option>--timeout</option> option is not combinable with the <option>--permanent</option> option.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--remove-service</option>=<replaceable>service</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Remove a service from <replaceable>zone</replaceable>. This option can be specified multiple times. If zone is omitted, default zone will be used.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--query-service</option>=<replaceable>service</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Return whether <replaceable>service</replaceable> has been added for <replaceable>zone</replaceable>. If zone is omitted, default zone will be used. Returns 0 if true, 1 otherwise.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--list-ports</option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      List ports added for <replaceable>zone</replaceable> as a space separated list. A port is of the form <replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional>/<replaceable>protocol</replaceable>, it can be either a port and protocol pair or a port range with a protocol. If zone is omitted, default zone will be used.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--add-port</option>=<replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional>/<replaceable>protocol</replaceable> <optional><option>--timeout</option>=<replaceable>timeval</replaceable></optional></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Add the port for <replaceable>zone</replaceable>. If zone is omitted, default zone will be used. This option can be specified multiple times. If a timeout is supplied, the rule will be active for the specified amount of time and will be removed automatically afterwards.
Packit a8ec6b
	      <replaceable>timeval</replaceable> is either a number (of seconds) or number followed by one of characters <literal>s</literal> (seconds), <literal>m</literal> (minutes), <literal>h</literal> (hours), for example <literal>20m</literal> or <literal>1h</literal>.
Packit a8ec6b
	    </para>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      The port can either be a single port number or a port range <replaceable>portid</replaceable>-<replaceable>portid</replaceable>. The protocol can either be <literal>tcp</literal>, <literal>udp</literal>, <literal>sctp</literal> or <literal>dccp</literal>.
Packit a8ec6b
	    </para>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      The <option>--timeout</option> option is not combinable with the <option>--permanent</option> option.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--remove-port</option>=<replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional>/<replaceable>protocol</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Remove the port from <replaceable>zone</replaceable>. If zone is omitted, default zone will be used. This option can be specified multiple times.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--query-port</option>=<replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional>/<replaceable>protocol</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Return whether the port has been added for <replaceable>zone</replaceable>. If zone is omitted, default zone will be used. Returns 0 if true, 1 otherwise.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--list-protocols</option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      List protocols added for <replaceable>zone</replaceable> as a space separated list. If zone is omitted, default zone will be used.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--add-protocol</option>=<replaceable>protocol</replaceable> <optional><option>--timeout</option>=<replaceable>timeval</replaceable></optional></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Add the protocol for <replaceable>zone</replaceable>. If zone is omitted, default zone will be used. This option can be specified multiple times. If a timeout is supplied, the rule will be active for the specified amount of time and will be removed automatically afterwards.
Packit a8ec6b
	      <replaceable>timeval</replaceable> is either a number (of seconds) or number followed by one of characters <literal>s</literal> (seconds), <literal>m</literal> (minutes), <literal>h</literal> (hours), for example <literal>20m</literal> or <literal>1h</literal>.
Packit a8ec6b
	    </para>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      The protocol can be any protocol supported by the system. Please have a look at <filename>/etc/protocols</filename> for supported protocols.
Packit a8ec6b
	    </para>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      The <option>--timeout</option> option is not combinable with the <option>--permanent</option> option.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--remove-protocol</option>=<replaceable>protocol</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Remove the protocol from <replaceable>zone</replaceable>. If zone is omitted, default zone will be used. This option can be specified multiple times.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--query-protocol</option>=<replaceable>protocol</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Return whether the protocol has been added for <replaceable>zone</replaceable>. If zone is omitted, default zone will be used. Returns 0 if true, 1 otherwise.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--list-source-ports</option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      List source ports added for <replaceable>zone</replaceable> as a space separated list. A port is of the form <replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional>/<replaceable>protocol</replaceable>. If zone is omitted, default zone will be used.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--add-source-port</option>=<replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional>/<replaceable>protocol</replaceable> <optional><option>--timeout</option>=<replaceable>timeval</replaceable></optional></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Add the source port for <replaceable>zone</replaceable>. If zone is omitted, default zone will be used. This option can be specified multiple times. If a timeout is supplied, the rule will be active for the specified amount of time and will be removed automatically afterwards.
Packit a8ec6b
	      <replaceable>timeval</replaceable> is either a number (of seconds) or number followed by one of characters <literal>s</literal> (seconds), <literal>m</literal> (minutes), <literal>h</literal> (hours), for example <literal>20m</literal> or <literal>1h</literal>.
Packit a8ec6b
	    </para>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      The port can either be a single port number or a port range <replaceable>portid</replaceable>-<replaceable>portid</replaceable>. The protocol can either be <literal>tcp</literal>, <literal>udp</literal>, <literal>sctp</literal> or <literal>dccp</literal>.
Packit a8ec6b
	    </para>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      The <option>--timeout</option> option is not combinable with the <option>--permanent</option> option.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--remove-source-port</option>=<replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional>/<replaceable>protocol</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Remove the source port from <replaceable>zone</replaceable>. If zone is omitted, default zone will be used. This option can be specified multiple times.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--query-source-port</option>=<replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional>/<replaceable>protocol</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Return whether the source port has been added for <replaceable>zone</replaceable>. If zone is omitted, default zone will be used. Returns 0 if true, 1 otherwise.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--list-icmp-blocks</option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      List Internet Control Message Protocol (ICMP) type blocks added for <replaceable>zone</replaceable> as a space separated list. If zone is omitted, default zone will be used.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--add-icmp-block</option>=<replaceable>icmptype</replaceable> <optional><option>--timeout</option>=<replaceable>timeval</replaceable></optional></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Add an ICMP block for <replaceable>icmptype</replaceable> for <replaceable>zone</replaceable>. If zone is omitted, default zone will be used. This option can be specified multiple times. If a timeout is supplied, the rule will be active for the specified amount of time and will be removed automatically afterwards.
Packit a8ec6b
	      <replaceable>timeval</replaceable> is either a number (of seconds) or number followed by one of characters <literal>s</literal> (seconds), <literal>m</literal> (minutes), <literal>h</literal> (hours), for example <literal>20m</literal> or <literal>1h</literal>.
Packit a8ec6b
	    </para>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      The <replaceable>icmptype</replaceable> is the one of the icmp types firewalld supports. To get a listing of supported icmp types: <command>firewall-cmd --get-icmptypes</command>
Packit a8ec6b
	    </para>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      The <option>--timeout</option> option is not combinable with the <option>--permanent</option> option.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--remove-icmp-block</option>=<replaceable>icmptype</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Remove the ICMP block for <replaceable>icmptype</replaceable> from <replaceable>zone</replaceable>. If zone is omitted, default zone will be used. This option can be specified multiple times.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--query-icmp-block</option>=<replaceable>icmptype</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Return whether an ICMP block for <replaceable>icmptype</replaceable> has been added for <replaceable>zone</replaceable>. If zone is omitted, default zone will be used. Returns 0 if true, 1 otherwise.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--list-forward-ports</option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      List <emphasis>IPv4</emphasis> forward ports added for <replaceable>zone</replaceable> as a space separated list. If zone is omitted, default zone will be used.
Packit a8ec6b
	    </para>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      For <emphasis>IPv6</emphasis> forward ports, please use the rich language.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--add-forward-port</option>=port=<replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional>:proto=<replaceable>protocol</replaceable><optional>:toport=<replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional></optional><optional>:toaddr=<replaceable>address</replaceable><optional>/<replaceable>mask</replaceable></optional></optional> <optional><option>--timeout</option>=<replaceable>timeval</replaceable></optional></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Add the <emphasis>IPv4</emphasis> forward port for <replaceable>zone</replaceable>. If zone is omitted, default zone will be used. This option can be specified multiple times. If a timeout is supplied, the rule will be active for the specified amount of time and will be removed automatically afterwards.
Packit a8ec6b
	      <replaceable>timeval</replaceable> is either a number (of seconds) or number followed by one of characters <literal>s</literal> (seconds), <literal>m</literal> (minutes), <literal>h</literal> (hours), for example <literal>20m</literal> or <literal>1h</literal>.
Packit a8ec6b
	    </para>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      The port can either be a single port number <replaceable>portid</replaceable> or a port range <replaceable>portid</replaceable>-<replaceable>portid</replaceable>. The protocol can either be <literal>tcp</literal>, <literal>udp</literal>, <literal>sctp</literal> or <literal>dccp</literal>. The destination address is a simple IP address.
Packit a8ec6b
	    </para>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      The <option>--timeout</option> option is not combinable with the <option>--permanent</option> option.
Packit a8ec6b
	    </para>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      For <emphasis>IPv6</emphasis> forward ports, please use the rich language.
Packit a8ec6b
	    </para>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      <emphasis>Note:</emphasis> IP forwarding will be implicitly enabled if <option>toaddr</option> is specified.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--remove-forward-port</option>=port=<replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional>:proto=<replaceable>protocol</replaceable><optional>:toport=<replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional></optional><optional>:toaddr=<replaceable>address</replaceable><optional>/<replaceable>mask</replaceable></optional></optional></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Remove the <emphasis>IPv4</emphasis> forward port from <replaceable>zone</replaceable>. If zone is omitted, default zone will be used. This option can be specified multiple times.
Packit a8ec6b
	    </para>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      For <emphasis>IPv6</emphasis> forward ports, please use the rich language.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--query-forward-port</option>=port=<replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional>:proto=<replaceable>protocol</replaceable><optional>:toport=<replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional></optional><optional>:toaddr=<replaceable>address</replaceable><optional>/<replaceable>mask</replaceable></optional></optional></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Return whether the <emphasis>IPv4</emphasis> forward port has been added for <replaceable>zone</replaceable>. If zone is omitted, default zone will be used. Returns 0 if true, 1 otherwise.
Packit a8ec6b
	    </para>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      For <emphasis>IPv6</emphasis> forward ports, please use the rich language.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--add-masquerade</option> <optional><option>--timeout</option>=<replaceable>timeval</replaceable></optional></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Enable <emphasis>IPv4</emphasis> masquerade for <replaceable>zone</replaceable>. If zone is omitted, default zone will be used. If a timeout is supplied, masquerading will be active for the specified amount of time.
Packit a8ec6b
	      <replaceable>timeval</replaceable> is either a number (of seconds) or number followed by one of characters <literal>s</literal> (seconds), <literal>m</literal> (minutes), <literal>h</literal> (hours), for example <literal>20m</literal> or <literal>1h</literal>.
Packit a8ec6b
	      Masquerading is useful if the machine is a router and machines connected over an interface in another zone should be able to use the first connection.
Packit a8ec6b
	    </para>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      The <option>--timeout</option> option is not combinable with the <option>--permanent</option> option.
Packit a8ec6b
	    </para>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      For <emphasis>IPv6</emphasis> masquerading, please use the rich language.
Packit a8ec6b
	    </para>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      <emphasis>Note:</emphasis> IP forwarding will be implicitly enabled.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--remove-masquerade</option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Disable <emphasis>IPv4</emphasis> masquerade for <replaceable>zone</replaceable>. If zone is omitted, default zone will be used. If the masquerading was enabled with a timeout, it will be disabled also.
Packit a8ec6b
	    </para>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      For <emphasis>IPv6</emphasis> masquerading, please use the rich language.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--query-masquerade</option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Return whether <emphasis>IPv4</emphasis> masquerading has been enabled for <replaceable>zone</replaceable>. If zone is omitted, default zone will be used. Returns 0 if true, 1 otherwise.
Packit a8ec6b
	    </para>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      For <emphasis>IPv6</emphasis> masquerading, please use the rich language.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--list-rich-rules</option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      List rich language rules added for <replaceable>zone</replaceable> as a newline separated list. If zone is omitted, default zone will be used.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--add-rich-rule</option>='<replaceable>rule</replaceable>' <optional><option>--timeout</option>=<replaceable>timeval</replaceable></optional></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Add rich language rule '<replaceable>rule</replaceable>' for <replaceable>zone</replaceable>. This option can be specified multiple times. If zone is omitted, default zone will be used. If a timeout is supplied, the <replaceable>rule</replaceable> will be active for the specified amount of time and will be removed automatically afterwards.
Packit a8ec6b
	      <replaceable>timeval</replaceable> is either a number (of seconds) or number followed by one of characters <literal>s</literal> (seconds), <literal>m</literal> (minutes), <literal>h</literal> (hours), for example <literal>20m</literal> or <literal>1h</literal>.
Packit a8ec6b
	    </para>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      For the rich language rule syntax, please have a look at <citerefentry><refentrytitle>firewalld.richlanguage</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
Packit a8ec6b
	    </para>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      The <option>--timeout</option> option is not combinable with the <option>--permanent</option> option.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--remove-rich-rule</option>='<replaceable>rule</replaceable>'</term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Remove rich language rule '<replaceable>rule</replaceable>' from <replaceable>zone</replaceable>. This option can be specified multiple times. If zone is omitted, default zone will be used.
Packit a8ec6b
	    </para>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      For the rich language rule syntax, please have a look at <citerefentry><refentrytitle>firewalld.richlanguage</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--query-rich-rule</option>='<replaceable>rule</replaceable>'</term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Return whether a rich language rule '<replaceable>rule</replaceable>' has been added for <replaceable>zone</replaceable>. If zone is omitted, default zone will be used. Returns 0 if true, 1 otherwise.
Packit a8ec6b
	    </para>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      For the rich language rule syntax, please have a look at <citerefentry><refentrytitle>firewalld.richlanguage</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
      </variablelist>
Packit a8ec6b
    </refsect2>
Packit a8ec6b
Packit a8ec6b
    <refsect2 id="options_to_handle_bindings_of_interfaces">
Packit a8ec6b
      <title>Options to Handle Bindings of Interfaces</title>
Packit a8ec6b
      <para>
Packit a8ec6b
	Binding an interface to a zone means that this zone settings are used to restrict traffic via the interface.
Packit a8ec6b
      </para>
Packit a8ec6b
      <para>
Packit a8ec6b
	Options in this section affect only one particular zone. If used with <option>--zone</option>=<replaceable>zone</replaceable> option, they affect the zone <replaceable>zone</replaceable>. If the option is omitted, they affect default zone (see <option>--get-default-zone</option>).
Packit a8ec6b
      </para>
Packit a8ec6b
      <para>
Packit a8ec6b
	For a list of predefined zones use <command>firewall-cmd --get-zones</command>.
Packit a8ec6b
      </para>
Packit a8ec6b
      <para>
Packit a8ec6b
	An interface name is a string up to 16 characters long, that may not contain <option>' '</option>, <option>'/'</option>, <option>'!'</option> and <option>'*'</option>.
Packit a8ec6b
      </para>
Packit a8ec6b
      <variablelist>
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--list-interfaces</option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      List interfaces that are bound to zone <replaceable>zone</replaceable> as a space separated list. If zone is omitted, default zone will be used.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--add-interface</option>=<replaceable>interface</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Bind interface <replaceable>interface</replaceable> to zone <replaceable>zone</replaceable>. If zone is omitted, default zone will be used.
Packit a8ec6b
	    </para>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      If the interface is under control of NetworkManager, it is at first connected to change the zone for the connection that is using the interface. If this fails, the zone binding is created in firewalld and the limitations below apply.
Packit a8ec6b
For interfaces that are not under control of NetworkManager, firewalld tries to change the ZONE setting in the ifcfg file, if the file exists.
Packit a8ec6b
	    </para>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      As a end user you don't need this in most cases, because NetworkManager (or legacy network service) adds interfaces into zones automatically (according to <option>ZONE=</option> option from ifcfg-<replaceable>interface</replaceable> file) if <replaceable>NM_CONTROLLED=no</replaceable> is not set.
Packit a8ec6b
	      You should do it only if there's no @IFCFGDIR@/ifcfg-<replaceable>interface</replaceable> file.
Packit a8ec6b
	      If there is such file and you add interface to zone with this <option>--add-interface</option> option, make sure the zone is the same in both cases, otherwise the behaviour would be undefined.
Packit a8ec6b
	      Please also have a look at the <citerefentry><refentrytitle>firewalld</refentrytitle><manvolnum>1</manvolnum></citerefentry> man page in the <replaceable>Concepts</replaceable> section.
Packit a8ec6b
	      For permanent association of interface with a zone, see also 'How to set or change a zone for a connection?' in <citerefentry><refentrytitle>firewalld.zones</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--change-interface</option>=<replaceable>interface</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      If the interface is under control of NetworkManager, it is at first connected to change the zone for the connection that is using the interface. If this fails, the zone binding is created in firewalld and the limitations below apply.
Packit a8ec6b
For interfaces that are not under control of NetworkManager, firewalld tries to change the ZONE setting in the ifcfg file, if the file exists.
Packit a8ec6b
	    </para>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Change zone the interface <replaceable>interface</replaceable> is bound to to zone <replaceable>zone</replaceable>.
Packit a8ec6b
	      It's basically <option>--remove-interface</option> followed by <option>--add-interface</option>.
Packit a8ec6b
	      If the interface has not been bound to a zone before, it behaves like <option>--add-interface</option>.
Packit a8ec6b
	      If zone is omitted, default zone will be used.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--query-interface</option>=<replaceable>interface</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Query whether interface <replaceable>interface</replaceable> is bound to zone <replaceable>zone</replaceable>. Returns 0 if true, 1 otherwise.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--remove-interface</option>=<replaceable>interface</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      If the interface is under control of NetworkManager, it is at first connected to change the zone for the connection that is using the interface. If this fails, the zone binding is created in firewalld and the limitations below apply.
Packit a8ec6b
	    </para>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      For the addion or change of interfaces that are not under control of NetworkManager: firewalld tries to change the ZONE setting in the ifcfg file, if an ifcfg file exists that is using the interface.
Packit a8ec6b
	    </para>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Only for the removal of interfaces that are not under control of NetworkManager: firewalld is not trying to change the ZONE setting in the ifcfg file. This is needed to make sure that an ifdown of the interface will not result in a reset of the zone setting to the default zone. Only the zone binding is then removed in firewalld then.
Packit a8ec6b
	    </para>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Remove binding of interface <replaceable>interface</replaceable> from zone it was previously added to.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
      </variablelist>
Packit a8ec6b
    </refsect2>
Packit a8ec6b
Packit a8ec6b
    <refsect2 id="options_to_handle_bindings_of_sources">
Packit a8ec6b
      <title>Options to Handle Bindings of Sources</title>
Packit a8ec6b
      <para>
Packit a8ec6b
	Binding a source to a zone means that this zone settings will be used to restrict traffic from this source.
Packit a8ec6b
      </para>
Packit a8ec6b
      <para>
Packit a8ec6b
	A source address or address range is either an IP address or a network IP address with a mask for IPv4 or IPv6 or a MAC address or an ipset with the ipset: prefix. For IPv4, the mask can be a network mask or a plain number. For IPv6 the mask is a plain number. The use of host names is not supported.
Packit a8ec6b
      </para>
Packit a8ec6b
      <para>
Packit a8ec6b
	Options in this section affect only one particular zone. If used with <option>--zone</option>=<replaceable>zone</replaceable> option, they affect the zone <replaceable>zone</replaceable>. If the option is omitted, they affect default zone (see <option>--get-default-zone</option>).
Packit a8ec6b
      </para>
Packit a8ec6b
      <para>
Packit a8ec6b
	For a list of predefined zones use <command>firewall-cmd <optional><option>--permanent</option></optional> --get-zones</command>.
Packit a8ec6b
      </para>
Packit a8ec6b
      <variablelist>
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--list-sources</option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      List sources that are bound to zone <replaceable>zone</replaceable> as a space separated list. If zone is omitted, default zone will be used.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--add-source</option>=<replaceable>source</replaceable><optional>/<replaceable>mask</replaceable></optional>|<replaceable>MAC</replaceable>|ipset:<replaceable>ipset</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Bind the source to zone <replaceable>zone</replaceable>. If zone is omitted, default zone will be used.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--change-source</option>=<replaceable>source</replaceable><optional>/<replaceable>mask</replaceable></optional>|<replaceable>MAC</replaceable>|ipset:<replaceable>ipset</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Change zone the source is bound to to zone <replaceable>zone</replaceable>.
Packit a8ec6b
	      It's basically <option>--remove-source</option> followed by <option>--add-source</option>.
Packit a8ec6b
	      If the source has not been bound to a zone before, it behaves like <option>--add-source</option>.
Packit a8ec6b
	      If zone is omitted, default zone will be used.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--query-source</option>=<replaceable>source</replaceable><optional>/<replaceable>mask</replaceable></optional>|<replaceable>MAC</replaceable>|ipset:<replaceable>ipset</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Query whether the source is bound to the zone <replaceable>zone</replaceable>. Returns 0 if true, 1 otherwise.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--remove-source</option>=<replaceable>source</replaceable><optional>/<replaceable>mask</replaceable></optional>|<replaceable>MAC</replaceable>|ipset:<replaceable>ipset</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Remove binding of the source from zone it was previously added to.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
      </variablelist>
Packit a8ec6b
    </refsect2>
Packit a8ec6b
Packit a8ec6b
    <refsect2 id="ipset_options">
Packit a8ec6b
      <title>IPSet Options</title>
Packit a8ec6b
      <variablelist>
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><option>--get-ipset-types</option></term>
Packit a8ec6b
          <listitem>
Packit a8ec6b
            <para>
Packit a8ec6b
	      Print the supported ipset types.
Packit a8ec6b
            </para>
Packit a8ec6b
          </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
          <term><option>--permanent</option> <option>--new-ipset</option>=<replaceable>ipset</replaceable> <option>--type</option>=<replaceable>type</replaceable> <optional><option>--family</option>=<literal>inet</literal>|<literal>inet6</literal></optional> <optional><option>--option</option>=<replaceable>key</replaceable><optional>=<replaceable>value</replaceable></optional></optional></term>
Packit a8ec6b
          <listitem>
Packit a8ec6b
            <para>
Packit a8ec6b
              Add a new permanent and empty ipset with specifying the type and optional the family and options like <literal>timeout</literal>, <literal>hashsize</literal> and <literal>maxelem</literal>. For more information please have a look at <citerefentry><refentrytitle>ipset</refentrytitle><manvolnum>8</manvolnum></citerefentry> man page.
Packit a8ec6b
            </para>
Packit a8ec6b
            <para>
Packit a8ec6b
              ipset names must be alphanumeric and may additionally include characters: '_' and '-'.
Packit a8ec6b
            </para>
Packit a8ec6b
          </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
          <term><option>--permanent</option> <option>--new-ipset-from-file</option>=<replaceable>filename</replaceable> <optional><option>--name</option>=<replaceable>ipset</replaceable></optional></term>
Packit a8ec6b
          <listitem>
Packit a8ec6b
            <para>
Packit a8ec6b
	      Add a new permanent ipset from a prepared ipset file with an optional name override.
Packit a8ec6b
            </para>
Packit a8ec6b
          </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
          <term><option>--permanent</option> <option>--delete-ipset</option>=<replaceable>ipset</replaceable></term>
Packit a8ec6b
          <listitem>
Packit a8ec6b
            <para>
Packit a8ec6b
              Delete an existing permanent ipset.
Packit a8ec6b
            </para>
Packit a8ec6b
          </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
          <term><option>--permanent</option> <option>--load-ipset-defaults</option>=<replaceable>ipset</replaceable></term>
Packit a8ec6b
          <listitem>
Packit a8ec6b
            <para>
Packit a8ec6b
              Load ipset default settings or report NO_DEFAULTS error.
Packit a8ec6b
            </para>
Packit a8ec6b
          </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--info-ipset=<replaceable>ipset</replaceable></option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Print information about the ipset <replaceable>ipset</replaceable>. The output format is:
Packit a8ec6b
	      <programlisting>
Packit a8ec6b
<replaceable>ipset</replaceable>
Packit a8ec6b
  type: <replaceable>type</replaceable>
Packit a8ec6b
  options: <replaceable>option1[=value1]</replaceable> ..
Packit a8ec6b
  entries: <replaceable>entry1</replaceable> ..
Packit a8ec6b
              </programlisting>
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--get-ipsets</option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Print predefined ipsets as a space separated list.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--ipset</option>=<replaceable>ipset</replaceable> <option>--set-description</option>=<replaceable>description</replaceable></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Set new description to ipset
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--ipset</option>=<replaceable>ipset</replaceable> <option>--get-description</option></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Print description for ipset
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--ipset</option>=<replaceable>ipset</replaceable> <option>--set-short</option>=<replaceable>description</replaceable></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Set short description to ipset
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--ipset</option>=<replaceable>ipset</replaceable> <option>--get-short</option></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Print short description for ipset
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
         <term><optional><option>--permanent</option></optional> <option>--ipset</option>=<replaceable>ipset</replaceable> <option>--add-entry</option>=<replaceable>entry</replaceable></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Add a new entry to the ipset.
Packit a8ec6b
           </para>
Packit a8ec6b
           <para>
Packit a8ec6b
             Adding an entry to an ipset with option <literal>timeout</literal>
Packit a8ec6b
             is permitted, but these entries are not tracked by firewalld.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
         <term><optional><option>--permanent</option></optional> <option>--ipset</option>=<replaceable>ipset</replaceable> <option>--remove-entry</option>=<replaceable>entry</replaceable></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Remove an entry from the ipset.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
         <term><optional><option>--permanent</option></optional> <option>--ipset</option>=<replaceable>ipset</replaceable> <option>--query-entry</option>=<replaceable>entry</replaceable></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
	     Return whether the entry has been added to an ipset. Returns 0 if true, 1 otherwise.
Packit a8ec6b
           </para>
Packit a8ec6b
           <para>
Packit a8ec6b
             Querying an ipset with a timeout will yield an error. Entries are
Packit a8ec6b
             not tracked for ipsets with a timeout.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
         <term><optional><option>--permanent</option></optional> <option>--ipset</option>=<replaceable>ipset</replaceable> <option>--get-entries</option></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             List all entries of the ipset.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
         <term><optional><option>--permanent</option></optional> <option>--ipset</option>=<replaceable>ipset</replaceable> <option>--add-entries-from-file</option>=<replaceable>filename</replaceable></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Add a new entries to the ipset from the file. For all entries that are listed in the file but already in the ipset, a warning will be printed.
Packit a8ec6b
           </para>
Packit a8ec6b
           <para>
Packit a8ec6b
	     The file should contain an entry per line. Lines starting with an hash or semicolon are ignored. Also empty lines.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
         <term><optional><option>--permanent</option></optional> <option>--ipset</option>=<replaceable>ipset</replaceable> <option>--remove-entries-from-file</option>=<replaceable>filename</replaceable></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Remove existing entries from the ipset from the file. For all entries that are listed in the file but not in the ipset, a warning will be printed.
Packit a8ec6b
           </para>
Packit a8ec6b
           <para>
Packit a8ec6b
	     The file should contain an entry per line. Lines starting with an hash or semicolon are ignored. Also empty lines.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><option>--permanent</option> <option>--path-ipset=<replaceable>ipset</replaceable></option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Print path of the ipset configuration file.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
     </variablelist>
Packit a8ec6b
    </refsect2>
Packit a8ec6b
Packit a8ec6b
    <refsect2 id="service_options">
Packit a8ec6b
      <title>Service Options</title>
Packit a8ec6b
      <para>
Packit a8ec6b
	Options in this section affect only one particular service.
Packit a8ec6b
      </para>
Packit a8ec6b
      <variablelist>
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--info-service=<replaceable>service</replaceable></option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Print information about the service <replaceable>service</replaceable>. The output format is:
Packit a8ec6b
	      <programlisting>
Packit a8ec6b
<replaceable>service</replaceable>
Packit a8ec6b
  ports: <replaceable>port1</replaceable> ..
Packit a8ec6b
  protocols: <replaceable>protocol1</replaceable> ..
Packit a8ec6b
  source-ports: <replaceable>source-port1</replaceable> ..
Packit a8ec6b
  helpers: <replaceable>helper1</replaceable> ..
Packit a8ec6b
  destination: <replaceable>ipv1</replaceable>:<replaceable>address1</replaceable> ..
Packit a8ec6b
              </programlisting>
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
      </variablelist>
Packit a8ec6b
      <para>
Packit a8ec6b
	The following options are only usable in the permanent configuration.
Packit a8ec6b
      </para>
Packit a8ec6b
      <variablelist>
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--new-service</option>=<replaceable>service</replaceable></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Add a new permanent and empty service.
Packit a8ec6b
           </para>
Packit a8ec6b
           <para>
Packit a8ec6b
             Service names must be alphanumeric and may additionally include characters: '_' and '-'.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--new-service-from-file</option>=<replaceable>filename</replaceable> <optional><option>--name</option>=<replaceable>service</replaceable></optional></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
              Add a new permanent service from a prepared service file with an optional name override.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--delete-service</option>=<replaceable>service</replaceable></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Delete an existing permanent service.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
          <term><option>--permanent</option> <option>--load-service-defaults</option>=<replaceable>service</replaceable></term>
Packit a8ec6b
          <listitem>
Packit a8ec6b
            <para>
Packit a8ec6b
              Load service default settings or report NO_DEFAULTS error.
Packit a8ec6b
            </para>
Packit a8ec6b
          </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><option>--permanent</option> <option>--path-service=<replaceable>service</replaceable></option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Print path of the service configuration file.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--set-description</option>=<replaceable>description</replaceable></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Set new description to service
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--get-description</option></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Print description for service
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--set-short</option>=<replaceable>description</replaceable></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Set short description to service
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--get-short</option></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Print short description for service
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--add-port</option>=<replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional>/<replaceable>protocol</replaceable></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Add a new port to the permanent service.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--remove-port</option>=<replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional>/<replaceable>protocol</replaceable></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Remove a port from the permanent service.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--query-port</option>=<replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional>/<replaceable>protocol</replaceable></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Return wether the port has been added to the permanent service.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--get-ports</option></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             List ports added to the permanent service.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--add-protocol</option>=<replaceable>protocol</replaceable></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Add a new protocol to the permanent service.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--remove-protocol</option>=<replaceable>protocol</replaceable></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Remove a protocol from the permanent service.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--query-protocol</option>=<replaceable>protocol</replaceable></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Return wether the protocol has been added to the permanent service.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--get-protocols</option></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             List protocols added to the permanent service.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--add-source-port</option>=<replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional>/<replaceable>protocol</replaceable></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Add a new source port to the permanent service.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--remove-source-port</option>=<replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional>/<replaceable>protocol</replaceable></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Remove a source port from the permanent service.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--query-source-port</option>=<replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional>/<replaceable>protocol</replaceable></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Return wether the source port has been added to the permanent service.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--get-source-ports</option></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             List source ports added to the permanent service.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--add-helper</option>=<replaceable>helper</replaceable></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Add a new helper to the permanent service.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--remove-helper</option>=<replaceable>helper</replaceable></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Remove a helper from the permanent service.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--query-helper</option>=<replaceable>helper</replaceable></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Return wether the helper has been added to the permanent service.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--get-service-helpers</option></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             List helpers added to the permanent service.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--set-destination</option>=<replaceable>ipv</replaceable>:<replaceable>address</replaceable><optional>/<replaceable>mask</replaceable></optional></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Set destination for ipv to address[/mask] in the permanent service.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--remove-destination</option>=<replaceable>ipv</replaceable></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Remove the destination for ipv from the permanent service.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--query-destination</option>=<replaceable>ipv</replaceable>:<replaceable>address</replaceable><optional>/<replaceable>mask</replaceable></optional></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Return wether the destination ipv to address[/mask] has been set in the permanent service.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--get-destinations</option></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             List destinations added to the permanent service.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--add-include</option>=<replaceable>service</replaceable></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Add a new include to the permanent service.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--remove-include</option>=<replaceable>service</replaceable></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Remove a include from the permanent service.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--query-include</option>=<replaceable>service</replaceable></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Return wether the include has been added to the permanent service.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--get-includes</option></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             List includes added to the permanent service.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
      </variablelist>
Packit a8ec6b
    </refsect2>
Packit a8ec6b
Packit a8ec6b
    <refsect2 id="helper_options">
Packit a8ec6b
      <title>Helper Options</title>
Packit a8ec6b
      <para>
Packit a8ec6b
	Options in this section affect only one particular helper.
Packit a8ec6b
      </para>
Packit a8ec6b
      <variablelist>
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--info-helper=<replaceable>helper</replaceable></option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Print information about the helper <replaceable>helper</replaceable>. The output format is:
Packit a8ec6b
	      <programlisting>
Packit a8ec6b
<replaceable>helper</replaceable>
Packit a8ec6b
  family: <replaceable>family</replaceable>
Packit a8ec6b
  module: <replaceable>module</replaceable>
Packit a8ec6b
  ports: <replaceable>port1</replaceable> ..
Packit a8ec6b
              </programlisting>
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
      </variablelist>
Packit a8ec6b
      <para>
Packit a8ec6b
	The following options are only usable in the permanent configuration.
Packit a8ec6b
      </para>
Packit a8ec6b
      <variablelist>
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--new-helper</option>=<replaceable>helper</replaceable> <option>--module</option>=<replaceable>nf_conntrack_module</replaceable> <optional><option>--family</option>=<literal>ipv4</literal>|<literal>ipv6</literal></optional></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Add a new permanent helper with module and optionally family defined.
Packit a8ec6b
           </para>
Packit a8ec6b
           <para>
Packit a8ec6b
             Helper names must be alphanumeric and may additionally include characters: '-'.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--new-helper-from-file</option>=<replaceable>filename</replaceable> <optional><option>--name</option>=<replaceable>helper</replaceable></optional></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
              Add a new permanent helper from a prepared helper file with an optional name override.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--delete-helper</option>=<replaceable>helper</replaceable></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Delete an existing permanent helper.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
          <term><option>--permanent</option> <option>--load-helper-defaults</option>=<replaceable>helper</replaceable></term>
Packit a8ec6b
          <listitem>
Packit a8ec6b
            <para>
Packit a8ec6b
              Load helper default settings or report NO_DEFAULTS error.
Packit a8ec6b
            </para>
Packit a8ec6b
          </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><option>--permanent</option> <option>--path-helper=<replaceable>helper</replaceable></option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Print path of the helper configuration file.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--get-helpers</option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Print predefined helpers as a space separated list.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--helper</option>=<replaceable>helper</replaceable> <option>--set-description</option>=<replaceable>description</replaceable></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Set new description to helper
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--helper</option>=<replaceable>helper</replaceable> <option>--get-description</option></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Print description for helper
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--helper</option>=<replaceable>helper</replaceable> <option>--set-short</option>=<replaceable>description</replaceable></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Set short description to helper
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--helper</option>=<replaceable>helper</replaceable> <option>--get-short</option></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Print short description for helper
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
       
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--helper</option>=<replaceable>helper</replaceable> <option>--add-port</option>=<replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional>/<replaceable>protocol</replaceable></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Add a new port to the permanent helper.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--helper</option>=<replaceable>helper</replaceable> <option>--remove-port</option>=<replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional>/<replaceable>protocol</replaceable></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Remove a port from the permanent helper.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--helper</option>=<replaceable>helper</replaceable> <option>--query-port</option>=<replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional>/<replaceable>protocol</replaceable></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Return wether the port has been added to the permanent helper.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--helper</option>=<replaceable>helper</replaceable> <option>--get-ports</option></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             List ports added to the permanent helper.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--helper</option>=<replaceable>helper</replaceable> <option>--set-module</option>=<replaceable>description</replaceable></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Set module description for helper
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--helper</option>=<replaceable>helper</replaceable> <option>--get-module</option></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Print module description for helper
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--helper</option>=<replaceable>helper</replaceable> <option>--set-family</option>=<replaceable>description</replaceable></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Set family description for helper
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--helper</option>=<replaceable>helper</replaceable> <option>--get-family</option></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Print family description of helper
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
     </variablelist>
Packit a8ec6b
    </refsect2>
Packit a8ec6b
Packit a8ec6b
    <refsect2 id="icmptype_options">
Packit a8ec6b
      <title>Internet Control Message Protocol (ICMP) type Options</title>
Packit a8ec6b
      <para>
Packit a8ec6b
	Options in this section affect only one particular icmptype.
Packit a8ec6b
      </para>
Packit a8ec6b
      <variablelist>
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--info-icmptype=<replaceable>icmptype</replaceable></option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Print information about the icmptype <replaceable>icmptype</replaceable>. The output format is:
Packit a8ec6b
	      <programlisting>
Packit a8ec6b
<replaceable>icmptype</replaceable>
Packit a8ec6b
  destination: <replaceable>ipv1</replaceable> ..
Packit a8ec6b
              </programlisting>
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
      </variablelist>
Packit a8ec6b
      <para>
Packit a8ec6b
	The following options are only usable in the permanent configuration.
Packit a8ec6b
      </para>
Packit a8ec6b
      <variablelist>
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--new-icmptype</option>=<replaceable>icmptype</replaceable></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Add a new permanent and empty icmptype.
Packit a8ec6b
           </para>
Packit a8ec6b
           <para>
Packit a8ec6b
             ICMP type names must be alphanumeric and may additionally include characters: '_' and '-'.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--new-icmptype-from-file</option>=<replaceable>filename</replaceable> <optional><option>--name</option>=<replaceable>icmptype</replaceable></optional></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
	     Add a new permanent icmptype from a prepared icmptype file with an optional name override.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
Packit a8ec6b
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--delete-icmptype</option>=<replaceable>icmptype</replaceable></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Delete an existing permanent icmptype.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--load-icmptype-defaults</option>=<replaceable>icmptype</replaceable></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Load icmptype default settings or report NO_DEFAULTS error.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--icmptype</option>=<replaceable>icmptype</replaceable> <option>--set-description</option>=<replaceable>description</replaceable></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Set new description to icmptype
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--icmptype</option>=<replaceable>icmptype</replaceable> <option>--get-description</option></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Print description for icmptype
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--icmptype</option>=<replaceable>icmptype</replaceable> <option>--set-short</option>=<replaceable>description</replaceable></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Set short description to icmptype
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--icmptype</option>=<replaceable>icmptype</replaceable> <option>--get-short</option></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Print short description for icmptype
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--icmptype</option>=<replaceable>icmptype</replaceable> <option>--add-destination</option>=<replaceable>ipv</replaceable></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Enable destination for ipv in permanent icmptype. ipv is one of <literal>ipv4</literal> or <literal>ipv6</literal>.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--icmptype</option>=<replaceable>icmptype</replaceable> <option>--remove-destination</option>=<replaceable>ipv</replaceable></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Disable destination for ipv in permanent icmptype. ipv is one of <literal>ipv4</literal> or <literal>ipv6</literal>.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--icmptype</option>=<replaceable>icmptype</replaceable> <option>--query-destination</option>=<replaceable>ipv</replaceable></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
             Return whether destination for ipv is enabled in permanent icmptype. ipv is one of <literal>ipv4</literal> or <literal>ipv6</literal>.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
       <varlistentry>
Packit a8ec6b
         <term><option>--permanent</option> <option>--icmptype</option>=<replaceable>icmptype</replaceable> <option>--get-destinations</option></term>
Packit a8ec6b
         <listitem>
Packit a8ec6b
           <para>
Packit a8ec6b
              List destinations in permanent icmptype.
Packit a8ec6b
           </para>
Packit a8ec6b
         </listitem>
Packit a8ec6b
       </varlistentry>
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><option>--permanent</option> <option>--path-icmptype=<replaceable>icmptype</replaceable></option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Print path of the icmptype configuration file.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
      </variablelist>
Packit a8ec6b
    </refsect2>
Packit a8ec6b
Packit a8ec6b
    <refsect2 id="direct_options">
Packit a8ec6b
      <title>Direct Options</title>
Packit a8ec6b
      <para>
Packit a8ec6b
	The direct options give a more direct access to the firewall. These options require user to know basic iptables concepts, i.e. <literal>table</literal> (filter/mangle/nat/...), <literal>chain</literal> (INPUT/OUTPUT/FORWARD/...), <literal>commands</literal> (-A/-D/-I/...), <literal>parameters</literal> (-p/-s/-d/-j/...) and <literal>targets</literal> (ACCEPT/DROP/REJECT/...).
Packit a8ec6b
      </para>
Packit a8ec6b
      <para>
Packit a8ec6b
	Direct options should be used only as a last resort when it's not possible to use for example <option>--add-service</option>=<replaceable>service</replaceable> or <option>--add-rich-rule</option>='<replaceable>rule</replaceable>'.
Packit a8ec6b
      </para>
Packit a8ec6b
      <para>
Packit a8ec6b
        <emphasis role="bold">Warning</emphasis>: Direct rules behavior is different depending on the value of <literal>FirewallBackend</literal>. See <literal>CAVEATS</literal> in <citerefentry><refentrytitle>firewalld.direct</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
Packit a8ec6b
      </para>
Packit a8ec6b
      <para>
Packit a8ec6b
	The first argument of each option has to be <literal>ipv4</literal> or <literal>ipv6</literal> or <literal>eb</literal>. With <literal>ipv4</literal> it will be for IPv4 (<citerefentry><refentrytitle>iptables</refentrytitle><manvolnum>8</manvolnum></citerefentry>), with <literal>ipv6</literal> for IPv6 (<citerefentry><refentrytitle>ip6tables</refentrytitle><manvolnum>8</manvolnum></citerefentry>) and with <literal>eb</literal> for ethernet bridges (<citerefentry><refentrytitle>ebtables</refentrytitle><manvolnum>8</manvolnum></citerefentry>).
Packit a8ec6b
      </para>
Packit a8ec6b
      <variablelist>
Packit a8ec6b
Packit a8ec6b
	
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--direct</option> <option>--get-all-chains</option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Get all chains added to all tables.
Packit a8ec6b
	      This option concerns only chains previously added with <option>--direct --add-chain</option>.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--direct</option> <option>--get-chains</option> { <literal>ipv4</literal> | <literal>ipv6</literal> | <literal>eb</literal> } <replaceable>table</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Get all chains added to table <replaceable>table</replaceable> as a space separated list.
Packit a8ec6b
	      This option concerns only chains previously added with <option>--direct --add-chain</option>.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--direct</option> <option>--add-chain</option> { <literal>ipv4</literal> | <literal>ipv6</literal> | <literal>eb</literal> } <replaceable>table</replaceable> <replaceable>chain</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Add a new chain with name <replaceable>chain</replaceable> to table <replaceable>table</replaceable>. Make sure there's no other chain with this name already.
Packit a8ec6b
	    </para>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      There already exist basic chains to use with direct options, for example <literal>INPUT_direct</literal> chain (see <literal>iptables-save | grep direct</literal> output for all of them).
Packit a8ec6b
	      These chains are jumped into before chains for zones, i.e. every rule put into <literal>INPUT_direct</literal> will be checked before rules in zones.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--direct</option> <option>--remove-chain</option> { <literal>ipv4</literal> | <literal>ipv6</literal> | <literal>eb</literal> } <replaceable>table</replaceable> <replaceable>chain</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Remove chain with name <replaceable>chain</replaceable> from table <replaceable>table</replaceable>.
Packit a8ec6b
	      Only chains previously added with <option>--direct --add-chain</option> can be removed this way.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--direct</option> <option>--query-chain</option> { <literal>ipv4</literal> | <literal>ipv6</literal> | <literal>eb</literal> } <replaceable>table</replaceable> <replaceable>chain</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Return whether a chain with name <replaceable>chain</replaceable> exists in table <replaceable>table</replaceable>. Returns 0 if true, 1 otherwise.
Packit a8ec6b
	      This option concerns only chains previously added with <option>--direct --add-chain</option>.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--direct</option> <option>--get-all-rules</option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Get all rules added to all chains in all tables as a newline separated list of the priority and arguments.
Packit a8ec6b
	      This option concerns only rules previously added with <option>--direct --add-rule</option>.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--direct</option> <option>--get-rules</option> { <literal>ipv4</literal> | <literal>ipv6</literal> | <literal>eb</literal> } <replaceable>table</replaceable> <replaceable>chain</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Get all rules added to chain <replaceable>chain</replaceable> in table <replaceable>table</replaceable> as a newline separated list of the priority and arguments.
Packit a8ec6b
	      This option concerns only rules previously added with <option>--direct --add-rule</option>.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--direct</option> <option>--add-rule</option> { <literal>ipv4</literal> | <literal>ipv6</literal> | <literal>eb</literal> } <replaceable>table</replaceable> <replaceable>chain</replaceable> <replaceable>priority</replaceable> <replaceable>args</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Add a rule with the arguments <replaceable>args</replaceable> to chain <replaceable>chain</replaceable> in table <replaceable>table</replaceable> with priority <replaceable>priority</replaceable>.
Packit a8ec6b
	    </para>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      The <replaceable>priority</replaceable> is used to order rules. Priority 0 means add rule on top of the chain, with a higher priority the rule will be added further down. Rules with the same priority are on the same level and the order of these rules is not fixed and may change. If you want to make sure that a rule will be added after another one, use a low priority for the first and a higher for the following.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--direct</option> <option>--remove-rule</option> { <literal>ipv4</literal> | <literal>ipv6</literal> | <literal>eb</literal> } <replaceable>table</replaceable> <replaceable>chain</replaceable> <replaceable>priority</replaceable> <replaceable>args</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Remove a rule with <replaceable>priority</replaceable> and the arguments <replaceable>args</replaceable> from chain <replaceable>chain</replaceable> in table <replaceable>table</replaceable>.
Packit a8ec6b
	      Only rules previously added with <option>--direct --add-rule</option> can be removed this way.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--direct</option> <option>--remove-rules</option> { <literal>ipv4</literal> | <literal>ipv6</literal> | <literal>eb</literal> } <replaceable>table</replaceable> <replaceable>chain</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Remove all rules in the chain with name <replaceable>chain</replaceable> exists in table <replaceable>table</replaceable>.
Packit a8ec6b
	      This option concerns only rules previously added with <option>--direct --add-rule</option> in this chain.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--direct</option> <option>--query-rule</option> { <literal>ipv4</literal> | <literal>ipv6</literal> | <literal>eb</literal> } <replaceable>table</replaceable> <replaceable>chain</replaceable> <replaceable>priority</replaceable> <replaceable>args</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Return whether a rule with <replaceable>priority</replaceable> and the arguments <replaceable>args</replaceable> exists in chain <replaceable>chain</replaceable> in table <replaceable>table</replaceable>.
Packit a8ec6b
	      Returns 0 if true, 1 otherwise. This option concerns only rules previously added with <option>--direct --add-rule</option>.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><option>--direct</option> <option>--passthrough</option> { <literal>ipv4</literal> | <literal>ipv6</literal> | <literal>eb</literal> } <replaceable>args</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Pass a command through to the firewall. <replaceable>args</replaceable> can be all <command>iptables</command>, <command>ip6tables</command> and <command>ebtables</command> command line arguments. This command is untracked, which means that firewalld is not able to provide information about this command later on, also not a listing of the untracked passthoughs.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--direct</option> <option>--get-all-passthroughs</option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Get all passthrough rules as a newline separated list of the ipv value and arguments.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--direct</option> <option>--get-passthroughs</option> { <literal>ipv4</literal> | <literal>ipv6</literal> | <literal>eb</literal> }</term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Get all passthrough rules for the ipv value as a newline separated list of the priority and arguments.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--direct</option> <option>--add-passthrough</option> { <literal>ipv4</literal> | <literal>ipv6</literal> | <literal>eb</literal> } <replaceable>args</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Add a passthrough rule with the arguments <replaceable>args</replaceable> for the ipv value.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--direct</option> <option>--remove-passthrough</option> { <literal>ipv4</literal> | <literal>ipv6</literal> | <literal>eb</literal> } <replaceable>args</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Remove a passthrough rule with the arguments <replaceable>args</replaceable> for the ipv value.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--direct</option> <option>--query-passthrough</option> { <literal>ipv4</literal> | <literal>ipv6</literal> | <literal>eb</literal> } <replaceable>args</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Return whether a passthrough rule with the arguments <replaceable>args</replaceable> exists for the ipv value. Returns 0 if true, 1 otherwise.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
      </variablelist>
Packit a8ec6b
    </refsect2>
Packit a8ec6b
Packit a8ec6b
    <refsect2 id="lockdown_options">
Packit a8ec6b
      <title>Lockdown Options</title>
Packit a8ec6b
      <para>
Packit a8ec6b
	Local applications or services are able to change the firewall configuration if they are running as root (example: libvirt) or are authenticated using PolicyKit. With this feature administrators can lock the firewall configuration so that only applications on lockdown whitelist are able to request firewall changes.
Packit a8ec6b
      </para>
Packit a8ec6b
      <para>
Packit a8ec6b
	The lockdown access check limits D-Bus methods that are changing firewall rules. Query, list and get methods are not limited.
Packit a8ec6b
      </para>
Packit a8ec6b
      <para>
Packit a8ec6b
	The lockdown feature is a very light version of user and application policies for firewalld and is turned off by default.
Packit a8ec6b
      </para>
Packit a8ec6b
      <variablelist>
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><option>--lockdown-on</option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Enable lockdown. Be careful - if firewall-cmd is not on lockdown whitelist when you enable lockdown you won't be able to disable it again with firewall-cmd, you would need to edit firewalld.conf.
Packit a8ec6b
	    </para>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      This is a runtime and permanent change.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><option>--lockdown-off</option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Disable lockdown.
Packit a8ec6b
	    </para>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      This is a runtime and permanent change.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><option>--query-lockdown</option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Query whether lockdown is enabled. Returns 0 if lockdown is enabled, 1 otherwise.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
      </variablelist>
Packit a8ec6b
    </refsect2>
Packit a8ec6b
Packit a8ec6b
    <refsect2 id="lockdown_whitelist_options">
Packit a8ec6b
      <title>Lockdown Whitelist Options</title>
Packit a8ec6b
      <para>
Packit a8ec6b
	The lockdown whitelist can contain <replaceable>commands</replaceable>, <replaceable>contexts</replaceable>, <replaceable>users</replaceable> and <replaceable>user ids</replaceable>.
Packit a8ec6b
      </para>
Packit a8ec6b
      <para>
Packit a8ec6b
	If a command entry on the whitelist ends with an asterisk '*', then all command lines starting with the command will match. If the '*' is not there the absolute command inclusive arguments must match.
Packit a8ec6b
      </para>
Packit a8ec6b
      <para>
Packit Service 562640
	Command paths for users are not always the same and depends on the users PATH. Some distributions symlink <command>/bin</command> to <command>/usr/bin</command> in which case it depends on the order they appear in the PATH environment variable.
Packit a8ec6b
      </para>
Packit a8ec6b
      <para>
Packit a8ec6b
	The context is the security (SELinux) context of a running application or service. To get the context of a running application use <command>ps -e --context</command>.
Packit a8ec6b
      </para>
Packit a8ec6b
      <para>
Packit a8ec6b
	<emphasis role="bold">Warning:</emphasis> If the context is unconfined, then this will open access for more than the desired application. 
Packit a8ec6b
      </para>
Packit a8ec6b
      <para>
Packit a8ec6b
	The lockdown whitelist entries are checked in the following order:
Packit a8ec6b
	<simplelist columns="1">
Packit a8ec6b
	  <member>1. <replaceable>context</replaceable></member>
Packit a8ec6b
	  <member>2. <replaceable>uid</replaceable></member>
Packit a8ec6b
	  <member>3. <replaceable>user</replaceable></member>
Packit a8ec6b
	  <member>4. <replaceable>command</replaceable></member>
Packit a8ec6b
	</simplelist>
Packit a8ec6b
      </para>
Packit a8ec6b
      <variablelist>
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--list-lockdown-whitelist-commands</option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      List all command lines that are on the whitelist.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--add-lockdown-whitelist-command</option>=<replaceable>command</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Add the <replaceable>command</replaceable> to the whitelist.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--remove-lockdown-whitelist-command</option>=<replaceable>command</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Remove the <replaceable>command</replaceable> from the whitelist.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--query-lockdown-whitelist-command</option>=<replaceable>command</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Query whether the <replaceable>command</replaceable> is on the whitelist. Returns 0 if true, 1 otherwise.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--list-lockdown-whitelist-contexts</option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      List all contexts that are on the whitelist.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--add-lockdown-whitelist-context</option>=<replaceable>context</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Add the context <replaceable>context</replaceable> to the whitelist.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--remove-lockdown-whitelist-context</option>=<replaceable>context</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Remove the <replaceable>context</replaceable> from the whitelist.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--query-lockdown-whitelist-context</option>=<replaceable>context</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Query whether the <replaceable>context</replaceable> is on the whitelist. Returns 0 if true, 1 otherwise.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--list-lockdown-whitelist-uids</option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      List all user ids that are on the whitelist.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--add-lockdown-whitelist-uid</option>=<replaceable>uid</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Add the user id <replaceable>uid</replaceable> to the whitelist.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--remove-lockdown-whitelist-uid</option>=<replaceable>uid</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Remove the user id <replaceable>uid</replaceable> from the whitelist.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--query-lockdown-whitelist-uid</option>=<replaceable>uid</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Query whether the user id <replaceable>uid</replaceable> is on the whitelist. Returns 0 if true, 1 otherwise.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--list-lockdown-whitelist-users</option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      List all user names that are on the whitelist.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--add-lockdown-whitelist-user</option>=<replaceable>user</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Add the user name <replaceable>user</replaceable> to the whitelist.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--remove-lockdown-whitelist-user</option>=<replaceable>user</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Remove the user name <replaceable>user</replaceable> from the whitelist.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><optional><option>--permanent</option></optional> <option>--query-lockdown-whitelist-user</option>=<replaceable>user</replaceable></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Query whether the user name <replaceable>user</replaceable> is on the whitelist. Returns 0 if true, 1 otherwise.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
      </variablelist>
Packit a8ec6b
    </refsect2>
Packit a8ec6b
  </refsect1>
Packit a8ec6b
Packit a8ec6b
    <refsect2 id="panic_options">
Packit a8ec6b
      <title>Panic Options</title>
Packit a8ec6b
      <variablelist>
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><option>--panic-on</option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Enable panic mode. All incoming and outgoing packets are dropped, active connections will expire. Enable this only if there are serious problems with your network environment. For example if the machine is getting hacked in.
Packit a8ec6b
	    </para>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      This is a runtime only change.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><option>--panic-off</option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Disable panic mode. After disabling panic mode established connections might work again, if panic mode was enabled for a short period of time.
Packit a8ec6b
	    </para>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      This is a runtime only change.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
Packit a8ec6b
	<varlistentry>
Packit a8ec6b
	  <term><option>--query-panic</option></term>
Packit a8ec6b
	  <listitem>
Packit a8ec6b
	    <para>
Packit a8ec6b
	      Returns 0 if panic mode is enabled, 1 otherwise.
Packit a8ec6b
	    </para>
Packit a8ec6b
	  </listitem>
Packit a8ec6b
	</varlistentry>
Packit a8ec6b
      </variablelist>
Packit a8ec6b
    </refsect2>
Packit a8ec6b
Packit a8ec6b
  <refsect1>
Packit a8ec6b
    <title>Examples</title>
Packit a8ec6b
      <para>
Packit a8ec6b
	For more examples see <ulink url="http://fedoraproject.org/wiki/FirewallD"></ulink>
Packit a8ec6b
      </para>
Packit a8ec6b
Packit a8ec6b
    <refsect2>
Packit a8ec6b
      <title>Example 1</title>
Packit a8ec6b
      <para>
Packit a8ec6b
	Enable http service in default zone. This is runtime only change, i.e. effective until restart.
Packit a8ec6b
      </para>
Packit a8ec6b
      <para>
Packit a8ec6b
	<programlisting>
Packit a8ec6b
firewall-cmd --add-service=http
Packit a8ec6b
	</programlisting>
Packit a8ec6b
      </para>
Packit a8ec6b
    </refsect2>
Packit a8ec6b
Packit a8ec6b
    <refsect2>
Packit a8ec6b
      <title>Example 2</title>
Packit a8ec6b
      <para>
Packit a8ec6b
	Enable port 443/tcp immediately and permanently in default zone.
Packit a8ec6b
	To make the change effective immediately and also after restart we need two commands.
Packit a8ec6b
	The first command makes the change in runtime configuration, i.e. makes it effective immediately, until restart.
Packit a8ec6b
	The second command makes the change in permanent configuration, i.e. makes it effective after restart.
Packit a8ec6b
      </para>
Packit a8ec6b
      <para>
Packit a8ec6b
	<programlisting>
Packit a8ec6b
firewall-cmd --add-port=443/tcp
Packit a8ec6b
firewall-cmd --permanent --add-port=443/tcp
Packit a8ec6b
	</programlisting>
Packit a8ec6b
      </para>
Packit a8ec6b
    </refsect2>
Packit a8ec6b
  </refsect1>
Packit a8ec6b
Packit a8ec6b
  <refsect1 id="exit_codes">
Packit a8ec6b
    <title>Exit Codes</title>
Packit a8ec6b
    <para>
Packit a8ec6b
      On success 0 is returned.
Packit a8ec6b
      On failure the output is red colored and exit code is either 2 in case of wrong command-line option usage or one of the following error codes in other cases:
Packit a8ec6b
Packit a8ec6b
      <informaltable frame="all">
Packit a8ec6b
	<tgroup cols="2" colsep="1" rowsep="1">
Packit a8ec6b
	  <colspec align="left"/>
Packit a8ec6b
	  <colspec align="right"/>
Packit a8ec6b
	  
Packit a8ec6b
	    <row>
Packit a8ec6b
	      <entry>String</entry>
Packit a8ec6b
	      <entry>Code</entry>
Packit a8ec6b
	    </row>
Packit a8ec6b
	  
Packit a8ec6b
	  
Packit a8ec6b
	    &errorcodes;
Packit a8ec6b
	  
Packit a8ec6b
	</tgroup>
Packit a8ec6b
      </informaltable>
Packit a8ec6b
    </para>
Packit a8ec6b
    <para>
Packit a8ec6b
      Note that return codes of <command>--query-*</command> options are special: Successful queries return 0, unsuccessful ones return 1 unless an error occurred in which case the table above applies.
Packit a8ec6b
    </para>
Packit a8ec6b
  </refsect1>
Packit a8ec6b
Packit a8ec6b
  &seealso;
Packit a8ec6b
Packit a8ec6b
  ¬e;;
Packit a8ec6b
Packit a8ec6b
</refentry>