commit d34ba69740071bfbe920914b55b1c822fc5516e6
Author: Jiri Popelka <jpopelka@redhat.com>
Date: Tue Feb 25 18:40:56 2014 +0100
firewall-offline-cmd(1): document new options
diff --git a/doc/xml/firewall-offline-cmd.xml b/doc/xml/firewall-offline-cmd.xml
index dbd09da..7b6f3ea 100644
--- a/doc/xml/firewall-offline-cmd.xml
+++ b/doc/xml/firewall-offline-cmd.xml
@@ -114,7 +114,7 @@
</refsect2>
<refsect2 id="genernal_options">
- <title>General Options</title>
+ <title>Lokkit Compatibility Options</title>
<variablelist>
<varlistentry>
<term><option>--addmodule</option>=<replaceable>module</replaceable></term>
@@ -251,6 +251,984 @@
</variablelist>
</refsect2>
+
+ <refsect2 id="zone_options">
+ <title>Zone Options</title>
+ <variablelist>
+ <varlistentry>
+ <term><option>--get-default-zone</option></term>
+ <listitem>
+ <para>
+ Print default zone for connections and interfaces.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--set-default-zone</option>=<replaceable>zone</replaceable></term>
+ <listitem>
+ <para>
+ 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.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--get-zones</option></term>
+ <listitem>
+ <para>
+ Print predefined zones as a space separated list.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--get-services</option></term>
+ <listitem>
+ <para>
+ Print predefined services as a space separated list.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--get-icmptypes</option></term>
+ <listitem>
+ <para>
+ Print predefined icmptypes as a space separated list.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--get-zone-of-interface</option>=<replaceable>interface</replaceable></term>
+ <listitem>
+ <para>
+ Print the name of the zone the <replaceable>interface</replaceable> is bound to or <emphasis>no zone</emphasis>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--get-zone-of-source</option>=<replaceable>source</replaceable><optional>/<replaceable>mask</replaceable></optional></term>
+ <listitem>
+ <para>
+ Print the name of the zone the <replaceable>source</replaceable><optional>/<replaceable>mask</replaceable></optional> is bound to or <emphasis>no zone</emphasis>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--list-all-zones</option></term>
+ <listitem>
+ <para>
+ List everything added for or enabled in all zones. The output format is:
+ <programlisting>
+<replaceable>zone1</replaceable>
+ interfaces: <replaceable>interface1</replaceable> ..
+ sources: <replaceable>source1</replaceable> ..
+ services: <replaceable>service1</replaceable> ..
+ ports: <replaceable>port1</replaceable> ..
+ forward-ports:
+ <replaceable>forward-port1</replaceable>
+ ..
+ icmp-blocks: <replaceable>icmp-type1</replaceable> ..
+ rich rules:
+ <replaceable>rich-rule1</replaceable>
+ ..
+..
+ </programlisting>
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--new-zone</option>=<replaceable>zone</replaceable></term>
+ <listitem>
+ <para>
+ Add a new permanent zone.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--delete-zone</option>=<replaceable>zone</replaceable></term>
+ <listitem>
+ <para>
+ Delete an existing permanent zone.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--zone</option>=<replaceable>zone</replaceable> <option>--get-target</option></term>
+ <listitem>
+ <para>
+ Get the target of a permanent zone.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--zone</option>=<replaceable>zone</replaceable> <option>--set-target</option>=<replaceable>zone</replaceable></term>
+ <listitem>
+ <para>
+ Set the target of a permanent zone.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect2>
+
+ <refsect2 id="options_to_adapt_and_query_zones">
+ <title>Options to Adapt and Query Zones</title>
+ <para>
+ 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>).
+ </para>
+ <variablelist>
+
+ <!-- list-all -->
+
+ <varlistentry>
+ <term><optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--list-all</option></term>
+ <listitem>
+ <para>
+ List everything added for or enabled in <replaceable>zone</replaceable>. If zone is omitted, default zone will be used.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <!-- list/add/remove/query service -->
+
+ <varlistentry>
+ <term><optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--list-services</option></term>
+ <listitem>
+ <para>
+ List services added for <replaceable>zone</replaceable> as a space separated list. If zone is omitted, default zone will be used.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--add-service</option>=<replaceable>service</replaceable></term>
+ <listitem>
+ <para>
+ Add a service for <replaceable>zone</replaceable>. If zone is omitted, default zone will be used. This option can be specified multiple times.
+ </para>
+ <para>
+ The service is one of the firewalld provided services. To get a list of the supported services, use <command>firewall-cmd --get-services</command>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--remove-service-from-zone</option>=<replaceable>service</replaceable></term>
+ <listitem>
+ <para>
+ Remove a service from <replaceable>zone</replaceable>. This option can be specified multiple times. If zone is omitted, default zone will be used.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--query-service</option>=<replaceable>service</replaceable></term>
+ <listitem>
+ <para>
+ 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.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <!-- list/add/remove/query port -->
+
+ <varlistentry>
+ <term><optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--list-ports</option></term>
+ <listitem>
+ <para>
+ 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.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--add-port</option>=<replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional>/<replaceable>protocol</replaceable></term>
+ <listitem>
+ <para>
+ Add the port for <replaceable>zone</replaceable>. If zone is omitted, default zone will be used. This option can be specified multiple times.
+ </para>
+ <para>
+ 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> or <literal>udp</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--remove-port</option>=<replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional>/<replaceable>protocol</replaceable></term>
+ <listitem>
+ <para>
+ Remove the port from <replaceable>zone</replaceable>. If zone is omitted, default zone will be used. This option can be specified multiple times.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--query-port</option>=<replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional>/<replaceable>protocol</replaceable></term>
+ <listitem>
+ <para>
+ 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.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <!-- list/add/remove/query icmp-block -->
+
+ <varlistentry>
+ <term><optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--list-icmp-blocks</option></term>
+ <listitem>
+ <para>
+ 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.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--add-icmp-block</option>=<replaceable>icmptype</replaceable></term>
+ <listitem>
+ <para>
+ 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.
+ </para>
+ <para>
+ 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>
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--remove-icmp-block</option>=<replaceable>icmptype</replaceable></term>
+ <listitem>
+ <para>
+ 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.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--query-icmp-block</option>=<replaceable>icmptype</replaceable></term>
+ <listitem>
+ <para>
+ 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.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <!-- list/add/remove/query forward-port -->
+
+ <varlistentry>
+ <term><optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--list-forward-ports</option></term>
+ <listitem>
+ <para>
+ 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.
+ </para>
+ <para>
+ For <emphasis>IPv6</emphasis> forward ports, please use the rich language.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><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></term>
+ <listitem>
+ <para>
+ 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.
+ </para>
+ <para>
+ 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> or <literal>udp</literal>. The destination address is a simple IP address.
+ </para>
+ <para>
+ For <emphasis>IPv6</emphasis> forward ports, please use the rich language.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><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>
+ <listitem>
+ <para>
+ 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.
+ </para>
+ <para>
+ For <emphasis>IPv6</emphasis> forward ports, please use the rich language.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><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>
+ <listitem>
+ <para>
+ 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.
+ </para>
+ <para>
+ For <emphasis>IPv6</emphasis> forward ports, please use the rich language.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <!-- add/remove/query masquerade -->
+
+ <varlistentry>
+ <term><optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--add-masquerade</option></term>
+ <listitem>
+ <para>
+ Enable <emphasis>IPv4</emphasis> masquerade for <replaceable>zone</replaceable>. If zone is omitted, default zone will be used. 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.
+ </para>
+ <para>
+ For <emphasis>IPv6</emphasis> masquerading, please use the rich language.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--remove-masquerade</option></term>
+ <listitem>
+ <para>
+ Disable <emphasis>IPv4</emphasis> masquerade for <replaceable>zone</replaceable>. If zone is omitted, default zone will be used.
+ </para>
+ <para>
+ For <emphasis>IPv6</emphasis> masquerading, please use the rich language.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--query-masquerade</option></term>
+ <listitem>
+ <para>
+ 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.
+ </para>
+ <para>
+ For <emphasis>IPv6</emphasis> masquerading, please use the rich language.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <!-- list/add/remove/query rich rule -->
+
+ <varlistentry>
+ <term><optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--list-rich-rules</option></term>
+ <listitem>
+ <para>
+ List rich language rules added for <replaceable>zone</replaceable> as a newline separated list. If zone is omitted, default zone will be used.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--add-rich-rule</option>='<replaceable>rule</replaceable>'</term>
+ <listitem>
+ <para>
+ 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.
+ </para>
+ <para>
+ For the rich language rule syntax, please have a look at <citerefentry><refentrytitle>firewalld.richlanguage</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--remove-rich-rule</option>='<replaceable>rule</replaceable>'</term>
+ <listitem>
+ <para>
+ 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.
+ </para>
+ <para>
+ For the rich language rule syntax, please have a look at <citerefentry><refentrytitle>firewalld.richlanguage</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--query-rich-rule</option>='<replaceable>rule</replaceable>'</term>
+ <listitem>
+ <para>
+ 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.
+ </para>
+ <para>
+ For the rich language rule syntax, please have a look at <citerefentry><refentrytitle>firewalld.richlanguage</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect2>
+
+ <refsect2 id="options_to_handle_bindings_of_interfaces">
+ <title>Options to Handle Bindings of Interfaces</title>
+ <para>
+ Binding an interface to a zone means that this zone settings are used to restrict traffic via the interface.
+ </para>
+ <para>
+ 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>).
+ </para>
+ <para>
+ For a list of predefined zones use <command>firewall-cmd --get-zones</command>.
+ </para>
+ <para>
+ An interface name is a string up to 16 characters long, that may not contain <option>' '</option>, <option>'/'</option>, <option>'!'</option> and <option>'*'</option>.
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term><optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--list-interfaces</option></term>
+ <listitem>
+ <para>
+ List interfaces that are bound to zone <replaceable>zone</replaceable> as a space separated list. If zone is omitted, default zone will be used.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--add-interface</option>=<replaceable>interface</replaceable></term>
+ <listitem>
+ <para>
+ Bind interface <replaceable>interface</replaceable> to zone <replaceable>zone</replaceable>. If zone is omitted, default zone will be used.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--change-interface</option>=<replaceable>interface</replaceable></term>
+ <listitem>
+ <para>
+ Change zone the interface <replaceable>interface</replaceable> is bound to to zone <replaceable>zone</replaceable>. If zone is omitted, default zone will be used. If old and new zone are the same, the call will be ignored without an error. If the interface has not been bound to a zone before, it will behave like <option>--add-interface</option>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--query-interface</option>=<replaceable>interface</replaceable></term>
+ <listitem>
+ <para>
+ Query whether interface <replaceable>interface</replaceable> is bound to zone <replaceable>zone</replaceable>. Returns 0 if true, 1 otherwise.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--remove-interface</option>=<replaceable>interface</replaceable></term>
+ <listitem>
+ <para>
+ Remove binding of interface <replaceable>interface</replaceable> from zone <replaceable>zone</replaceable>. If zone is omitted, default zone will be used.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect2>
+
+ <refsect2 id="options_to_handle_bindings_of_sources">
+ <title>Options to Handle Bindings of Sources</title>
+ <para>
+ Binding a source to a zone means that this zone settings will be used to restrict traffic from this source.
+ </para>
+ <para>
+ A source address or address range is either an IP address or a network IP address with a mask for IPv4 or IPv6. 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.
+ </para>
+ <para>
+ 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>).
+ </para>
+ <para>
+ For a list of predefined zones use <command>firewall-cmd --get-zones</command>.
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term><optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--list-sources</option></term>
+ <listitem>
+ <para>
+ List sources that are bound to zone <replaceable>zone</replaceable> as a space separated list. If zone is omitted, default zone will be used.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--add-source</option>=<replaceable>source</replaceable><optional>/<replaceable>mask</replaceable></optional></term>
+ <listitem>
+ <para>
+ Bind source <replaceable>source</replaceable><optional>/<replaceable>mask</replaceable></optional> to zone <replaceable>zone</replaceable>. If zone is omitted, default zone will be used.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--change-source</option>=<replaceable>source</replaceable><optional>/<replaceable>mask</replaceable></optional></term>
+ <listitem>
+ <para>
+ Change zone the source <replaceable>source</replaceable><optional>/<replaceable>mask</replaceable></optional> is bound to to zone <replaceable>zone</replaceable>. If zone is omitted, default zone will be used. If old and new zone are the same, the call will be ignored without an error. If the source has not been bound to a zone before, it will behave like <option>--add-source</option>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--query-source</option>=<replaceable>source</replaceable><optional>/<replaceable>mask</replaceable></optional></term>
+ <listitem>
+ <para>
+ Query whether the source <replaceable>source</replaceable><optional>/<replaceable>mask</replaceable></optional> is bound to the zone <replaceable>zone</replaceable>. Returns 0 if true, 1 otherwise.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--remove-source</option>=<replaceable>source</replaceable><optional>/<replaceable>mask</replaceable></optional></term>
+ <listitem>
+ <para>
+ Remove binding of source <replaceable>source</replaceable><optional>/<replaceable>mask</replaceable></optional> from zone <replaceable>zone</replaceable>. If zone is omitted, default zone will be used.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect2>
+
+ <refsect2 id="service_options">
+ <title>Service Options</title>
+ <variablelist>
+ <varlistentry>
+ <term><option>--new-service</option>=<replaceable>service</replaceable></term>
+ <listitem>
+ <para>
+ Add a new permanent service.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--delete-service</option>=<replaceable>service</replaceable></term>
+ <listitem>
+ <para>
+ Delete an existing permanent service.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect2>
+
+ <refsect2 id="icmptype_options">
+ <title>Internet Control Message Protocol (ICMP) type Options</title>
+ <variablelist>
+ <varlistentry>
+ <term><option>--new-icmptype</option>=<replaceable>icmptype</replaceable></term>
+ <listitem>
+ <para>
+ Add a new permanent icmptype.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--delete-icmptype</option>=<replaceable>icmptype</replaceable></term>
+ <listitem>
+ <para>
+ Delete an existing permanent icmptype.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect2>
+
+ <refsect2 id="direct_options">
+ <title>Direct Options</title>
+ <para>
+ 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/...).
+ </para>
+ <para>
+ 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>'.
+ </para>
+ <para>
+ 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>).
+ </para>
+ <variablelist>
+
+ <!-- direct chain -->
+
+ <varlistentry>
+ <term><option>--direct</option> <option>--get-all-chains</option></term>
+ <listitem>
+ <para>
+ Get all chains added to all tables.
+ </para>
+ <para>
+ This option concerns only chains previously added with <option>--direct --add-chain</option>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--direct</option> <option>--get-chains</option> { <literal>ipv4</literal> | <literal>ipv6</literal> | <literal>eb</literal> } <replaceable>table</replaceable></term>
+ <listitem>
+ <para>
+ Get all chains added to table <replaceable>table</replaceable> as a space separated list.
+ </para>
+ <para>
+ This option concerns only chains previously added with <option>--direct --add-chain</option>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--direct</option> <option>--add-chain</option> { <literal>ipv4</literal> | <literal>ipv6</literal> | <literal>eb</literal> } <replaceable>table</replaceable> <replaceable>chain</replaceable></term>
+ <listitem>
+ <para>
+ Add a new chain with name <replaceable>chain</replaceable> to table <replaceable>table</replaceable>.
+ </para>
+ <para>
+ 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).
+ 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.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--direct</option> <option>--remove-chain</option> { <literal>ipv4</literal> | <literal>ipv6</literal> | <literal>eb</literal> } <replaceable>table</replaceable> <replaceable>chain</replaceable></term>
+ <listitem>
+ <para>
+ Remove the chain with name <replaceable>chain</replaceable> from table <replaceable>table</replaceable>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--direct</option> <option>--query-chain</option> { <literal>ipv4</literal> | <literal>ipv6</literal> | <literal>eb</literal> } <replaceable>table</replaceable> <replaceable>chain</replaceable></term>
+ <listitem>
+ <para>
+ Return whether a chain with name <replaceable>chain</replaceable> exists in table <replaceable>table</replaceable>. Returns 0 if true, 1 otherwise.
+ </para>
+ <para>
+ This option concerns only chains previously added with <option>--direct --add-chain</option>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <!-- direct rule -->
+
+ <varlistentry>
+ <term><option>--direct</option> <option>--get-all-rules</option></term>
+ <listitem>
+ <para>
+ Get all rules added to all chains in all tables as a newline separated list of the priority and arguments.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--direct</option> <option>--get-rules</option> { <literal>ipv4</literal> | <literal>ipv6</literal> | <literal>eb</literal> } <replaceable>table</replaceable> <replaceable>chain</replaceable></term>
+ <listitem>
+ <para>
+ Get all rules added to chain <replaceable>chain</replaceable> in table <replaceable>table</replaceable> as a newline separated list of the priority and arguments.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><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>
+ <listitem>
+ <para>
+ Add a rule with the arguments <replaceable>args</replaceable> to chain <replaceable>chain</replaceable> in table <replaceable>table</replaceable> with priority <replaceable>priority</replaceable>.
+ </para>
+ <para>
+ 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.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><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>
+ <listitem>
+ <para>
+ Remove a rule with <replaceable>priority</replaceable> and the arguments <replaceable>args</replaceable> from chain <replaceable>chain</replaceable> in table <replaceable>table</replaceable>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--direct</option> <option>--remove-rules</option> { <literal>ipv4</literal> | <literal>ipv6</literal> | <literal>eb</literal> } <replaceable>table</replaceable> <replaceable>chain</replaceable></term>
+ <listitem>
+ <para>
+ Remove all rules in the chain with name <replaceable>chain</replaceable> exists in table <replaceable>table</replaceable>.
+ </para>
+ <para>
+ This option concerns only rules previously added with <option>--direct --add-rule</option> in this chain.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><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>
+ <listitem>
+ <para>
+ 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>. Returns 0 if true, 1 otherwise.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <!-- direct permanent passthrough -->
+
+ <varlistentry>
+ <term><option>--direct</option> <option>--get-all-passthroughs</option></term>
+ <listitem>
+ <para>
+ Get all permanent passthrough as a newline separated list of the ipv value and arguments.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--direct</option> <option>--get-passthroughs</option> { <literal>ipv4</literal> | <literal>ipv6</literal> | <literal>eb</literal> } </term>
+ <listitem>
+ <para>
+ Get all permanent passthrough rules for the ipv value as a newline separated list of the priority and arguments.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--direct</option> <option>--add-passthrough</option> { <literal>ipv4</literal> | <literal>ipv6</literal> | <literal>eb</literal> } <replaceable>args</replaceable></term>
+ <listitem>
+ <para>
+ Add a permanent passthrough rule with the arguments <replaceable>args</replaceable> for the ipv value.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--direct</option> <option>--remove-passthrough</option> { <literal>ipv4</literal> | <literal>ipv6</literal> | <literal>eb</literal> } <replaceable>args</replaceable></term>
+ <listitem>
+ <para>
+ Remove a permanent passthrough rule with the arguments <replaceable>args</replaceable> for the ipv value.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--direct</option> <option>--query-passthrough</option> { <literal>ipv4</literal> | <literal>ipv6</literal> | <literal>eb</literal> } <replaceable>args</replaceable></term>
+ <listitem>
+ <para>
+ Return whether a permanent passthrough rule with the arguments <replaceable>args</replaceable> exists for the ipv value. Returns 0 if true, 1 otherwise.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect2>
+
+ <refsect2 id="lockdown_options">
+ <title>Lockdown Options</title>
+ <para>
+ 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.
+ </para>
+ <para>
+ The lockdown access check limits D-Bus methods that are changing firewall rules. Query, list and get methods are not limited.
+ </para>
+ <para>
+ The lockdown feature is a very light version of user and application policies for firewalld and is turned off by default.
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term><option>--lockdown-on</option></term>
+ <listitem>
+ <para>
+ 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.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--lockdown-off</option></term>
+ <listitem>
+ <para>
+ Disable lockdown.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--query-lockdown</option></term>
+ <listitem>
+ <para>
+ Query whether lockdown is enabled. Returns 0 if lockdown is enabled, 1 otherwise.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect2>
+
+ <refsect2 id="lockdown_whitelist_options">
+ <title>Lockdown Whitelist Options</title>
+ <para>
+ The lockdown whitelist can contain <replaceable>commands</replaceable>, <replaceable>contexts</replaceable>, <replaceable>users</replaceable> and <replaceable>user ids</replaceable>.
+ </para>
+ <para>
+ 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.
+ </para>
+ <para>
+ Commands for user root and others is not always the same. Example: As root <command>/bin/firewall-cmd</command> is used, as a normal user <command>/usr/bin/firewall-cmd</command> is be used on Fedora.
+ </para>
+ <para>
+ 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>.
+ </para>
+ <para>
+ <emphasis role="bold">Warning:</emphasis> If the context is unconfined, then this will open access for more than the desired application.
+ </para>
+ <para>
+ The lockdown whitelist entries are checked in the following order:
+ <simplelist columns="1">
+ <member>1. <replaceable>context</replaceable></member>
+ <member>2. <replaceable>uid</replaceable></member>
+ <member>3. <replaceable>user</replaceable></member>
+ <member>4. <replaceable>command</replaceable></member>
+ </simplelist>
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term><option>--list-lockdown-whitelist-commands</option></term>
+ <listitem>
+ <para>
+ List all command lines that are on the whitelist.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--add-lockdown-whitelist-command</option>=<replaceable>command</replaceable></term>
+ <listitem>
+ <para>
+ Add the <replaceable>command</replaceable> to the whitelist.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--remove-lockdown-whitelist-command</option>=<replaceable>command</replaceable></term>
+ <listitem>
+ <para>
+ Remove the <replaceable>command</replaceable> from the whitelist.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--query-lockdown-whitelist-command</option>=<replaceable>command</replaceable></term>
+ <listitem>
+ <para>
+ Query whether the <replaceable>command</replaceable> is on the whitelist. Returns 0 if true, 1 otherwise.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--list-lockdown-whitelist-contexts</option></term>
+ <listitem>
+ <para>
+ List all contexts that are on the whitelist.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--add-lockdown-whitelist-context</option>=<replaceable>context</replaceable></term>
+ <listitem>
+ <para>
+ Add the context <replaceable>context</replaceable> to the whitelist.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--remove-lockdown-whitelist-context</option>=<replaceable>context</replaceable></term>
+ <listitem>
+ <para>
+ Remove the <replaceable>context</replaceable> from the whitelist.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--query-lockdown-whitelist-context</option>=<replaceable>context</replaceable></term>
+ <listitem>
+ <para>
+ Query whether the <replaceable>context</replaceable> is on the whitelist. Returns 0 if true, 1 otherwise.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--list-lockdown-whitelist-uids</option></term>
+ <listitem>
+ <para>
+ List all user ids that are on the whitelist.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--add-lockdown-whitelist-uid</option>=<replaceable>uid</replaceable></term>
+ <listitem>
+ <para>
+ Add the user id <replaceable>uid</replaceable> to the whitelist.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--remove-lockdown-whitelist-uid</option>=<replaceable>uid</replaceable></term>
+ <listitem>
+ <para>
+ Remove the user id <replaceable>uid</replaceable> from the whitelist.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--query-lockdown-whitelist-uid</option>=<replaceable>uid</replaceable></term>
+ <listitem>
+ <para>
+ Query whether the user id <replaceable>uid</replaceable> is on the whitelist. Returns 0 if true, 1 otherwise.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--list-lockdown-whitelist-users</option></term>
+ <listitem>
+ <para>
+ List all user names that are on the whitelist.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--add-lockdown-whitelist-user</option>=<replaceable>user</replaceable></term>
+ <listitem>
+ <para>
+ Add the user name <replaceable>user</replaceable> to the whitelist.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--remove-lockdown-whitelist-user</option>=<replaceable>user</replaceable></term>
+ <listitem>
+ <para>
+ Remove the user name <replaceable>user</replaceable> from the whitelist.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--query-lockdown-whitelist-user</option>=<replaceable>user</replaceable></term>
+ <listitem>
+ <para>
+ Query whether the user name <replaceable>user</replaceable> is on the whitelist. Returns 0 if true, 1 otherwise.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect2>
+
</refsect1>
&seealso;