<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
[
<!ENTITY authors SYSTEM "authors.xml">
<!ENTITY seealso SYSTEM "seealso.xml">
<!ENTITY notes SYSTEM "notes.xml">
]>
<!--
This file is part of firewalld.
Copyright (C) 2010-2014 Red Hat, Inc.
Authors:
Thomas Woerner <twoerner@redhat.com>
Jiri Popelka <jpopelka@redhat.com>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
-->
<refentry id="firewalld.dbus">
<refentryinfo>
<title>firewalld.dbus</title>
<productname>firewalld</productname>
&authors;
</refentryinfo>
<refmeta>
<refentrytitle>firewalld.dbus</refentrytitle>
<manvolnum>5</manvolnum>
</refmeta>
<refnamediv>
<refname>firewalld.dbus</refname>
<refpurpose>firewalld D-Bus interface description</refpurpose>
</refnamediv>
<refsect1 id="object-paths">
<title>Object Paths</title>
<para>
This is the basic firewalld object path structure. The used interfaces are explained below in <xref linkend="interfaces"/>.
</para>
<para>
<programlisting>
/org/fedoraproject/FirewallD1
Interfaces
<link linkend="FirewallD1">org.fedoraproject.FirewallD1</link>
<link linkend="FirewallD1.direct">org.fedoraproject.FirewallD1.direct</link>
<link linkend="FirewallD1.ipset">org.fedoraproject.FirewallD1.ipset</link>
<link linkend="FirewallD1.policies">org.fedoraproject.FirewallD1.policies</link>
<link linkend="FirewallD1.zone">org.fedoraproject.FirewallD1.zone</link>
org.freedesktop.DBus.Introspectable
org.freedesktop.DBus.Properties
/org/fedoraproject/FirewallD1/config
Interfaces
<link linkend="FirewallD1.config">org.fedoraproject.FirewallD1.config</link>
<link linkend="FirewallD1.config.direct">org.fedoraproject.FirewallD1.config.direct</link>
<link linkend="FirewallD1.config.policies">org.fedoraproject.FirewallD1.config.policies</link>
org.freedesktop.DBus.Introspectable
org.freedesktop.DBus.Properties
/org/fedoraproject/FirewallD1/config/zone/i
Interfaces
<link linkend="FirewallD1.config.zone">org.fedoraproject.FirewallD1.config.zone</link>
org.freedesktop.DBus.Introspectable
org.freedesktop.DBus.Properties
/org/fedoraproject/FirewallD1/config/service/i
Interfaces:
<link linkend="FirewallD1.config.service">org.fedoraproject.FirewallD1.config.service</link>
org.freedesktop.DBus.Introspectable
org.freedesktop.DBus.Properties
/org/fedoraproject/FirewallD1/config/ipset/i
Interfaces
<link linkend="FirewallD1.config.ipset">org.fedoraproject.FirewallD1.config.ipset</link>
org.freedesktop.DBus.Introspectable
org.freedesktop.DBus.Properties
/org/fedoraproject/FirewallD1/config/icmptype/i
Interfaces
<link linkend="FirewallD1.config.icmptype">org.fedoraproject.FirewallD1.config.icmptype</link>
org.freedesktop.DBus.Introspectable
org.freedesktop.DBus.Properties
</programlisting>
</para>
</refsect1>
<refsect1 id="interfaces">
<title>Interfaces</title>
<para>
</para>
<refsect2 id="FirewallD1">
<title>org.fedoraproject.FirewallD1</title>
<para>
This interface contains general runtime operations, like: reloading, panic mode, default zone handling, getting services and icmp types and their settings.
</para>
<refsect3 id="FirewallD1.Methods">
<title>Methods</title>
<variablelist>
<varlistentry>
<term><methodname>authorizeAll</methodname>() → Nothing</term>
<listitem>
<para>
Initiate authorization for the complete firewalld D-Bus interface.
This method it mostly useful for configuration applications.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><methodname>completeReload</methodname>() → Nothing</term>
<listitem>
<para>
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.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><methodname>disablePanicMode</methodname>() → Nothing</term>
<listitem>
<para>
Disable panic mode.
After disabling panic mode established connections might work again, if panic mode was enabled for a short period of time.
</para>
<para>
Possible errors: NOT_ENABLED, COMMAND_FAILED
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><methodname>enablePanicMode</methodname>() → Nothing</term>
<listitem>
<para>
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.
</para>
<para>
Possible errors: ALREADY_ENABLED, COMMAND_FAILED
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><methodname>getAutomaticHelpers</methodname>() → s</term>
<listitem>
<para>
Deprecated. This always returns "no".
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><methodname>getDefaultZone</methodname>() → s</term>
<listitem><para>Return default zone.</para></listitem>
</varlistentry>
<varlistentry id="FirewallD1.Methods.getHelperSettings">
<term><methodname>getHelperSettings</methodname>(s: <parameter>helper</parameter>) → (sssssa(ss))</term>
<listitem>
<para>
Return runtime settings of given <replaceable>helper</replaceable>.
For getting permanent settings see <link linkend="FirewallD1.config.helper.Methods.getSettings">org.fedoraproject.FirewallD1.config.helper.Methods.getSettings</link>.
Settings are in format: <parameter>version</parameter>, <parameter>name</parameter>, <parameter>description</parameter>, <parameter>family</parameter>, <parameter>module</parameter> and array of <parameter>ports</parameter>.
</para>
<para>
<variablelist>
<varlistentry><term><parameter>version (s)</parameter>: see <literal>version</literal> attribute of <literal>helper</literal> tag in <citerefentry><refentrytitle>firewalld.helper</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>name (s)</parameter>: see <literal>short</literal> tag in <citerefentry><refentrytitle>firewalld.helper</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>description (s)</parameter>: see <literal>description</literal> tag in <citerefentry><refentrytitle>firewalld.helper</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>family (s)</parameter>: see <literal>family</literal> tag in <citerefentry><refentrytitle>firewalld.helper</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>module (s)</parameter>: see <literal>module</literal> tag in <citerefentry><refentrytitle>firewalld.helper</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>ports (a(ss))</parameter>: array of port and protocol pairs. See <literal>port</literal> tag in <citerefentry><refentrytitle>firewalld.helper</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
</variablelist>
</para>
<para>
Possible errors: INVALID_HELPER
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.Methods.getHelpers">
<term><methodname>getHelpers</methodname>() → as</term>
<listitem>
<para>
Return array of helper names (s) in runtime configuration.
For permanent configuration see <link linkend="FirewallD1.config.Methods.listHelpers">org.fedoraproject.FirewallD1.config.Methods.listHelpers</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.Methods.getIcmpTypeSettings">
<term><methodname>getIcmpTypeSettings</methodname>(s: <parameter>icmptype</parameter>) → (sssas)</term>
<listitem>
<para>
Return runtime settings of given <replaceable>icmptype</replaceable>.
For getting permanent settings see <link linkend="FirewallD1.config.icmptype.Methods.getSettings">org.fedoraproject.FirewallD1.config.icmptype.Methods.getSettings</link>.
Settings are in format: <parameter>version</parameter>, <parameter>name</parameter>, <parameter>description</parameter>, array of <parameter>destinations</parameter>.
</para>
<para>
<variablelist>
<varlistentry><term><parameter>version (s)</parameter>: see <literal>version</literal> attribute of <literal>icmptype</literal> tag in <citerefentry><refentrytitle>firewalld.icmptype</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>name (s)</parameter>: see <literal>short</literal> tag in <citerefentry><refentrytitle>firewalld.icmptype</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>description (s)</parameter>: see <literal>description</literal> tag in <citerefentry><refentrytitle>firewalld.icmptype</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>destinations (as)</parameter>: array, either empty or containing strings 'ipv4' or 'ipv6', see <literal>destination</literal> tag in <citerefentry><refentrytitle>firewalld.icmptype</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
</variablelist>
</para>
<para>
Possible errors: INVALID_ICMPTYPE
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.Methods.getLogDenied">
<term><methodname>getLogDenied</methodname>() → s</term>
<listitem>
<para>
Retruns the LogDenied value.
If LogDenied is enabled, then logging rules are added 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.
Possible values are: <literal>all</literal>, <literal>unicast</literal>, <literal>broadcast</literal>, <literal>multicast</literal> and <literal>off</literal>.
The default value is <literal>off</literal>
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.Methods.getServiceSettings">
<annotation name="org.freedesktop.DBus.Deprecated" />
<term><methodname>getServiceSettings</methodname>(s: <parameter>service</parameter>) → (sssa(ss)asa{ss}asa(ss))</term>
<listitem>
<para>
This function is deprecated, use <link linkend="FirewallD1.Methods.getServiceSettings2">org.fedoraproject.FirewallD1.Methods.getServiceSettings2</link> instead.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.Methods.getServiceSettings2">
<term><methodname>getServiceSettings2</methodname>(s: <parameter>service</parameter>) → s{sv}</term>
<listitem>
<para>
Return runtime settings of given <replaceable>service</replaceable>.
For getting permanent settings see <link linkend="FirewallD1.config.service.Methods.getSettings2">org.fedoraproject.FirewallD1.config.service.Methods.getSettings2</link>.
Settings are a dictionary indexed by keywords. For the type of each value see below. If the value is empty it may be ommitted.
</para>
<para>
<variablelist>
<varlistentry><term><parameter>version (s)</parameter>: see <literal>version</literal> attribute of <literal>service</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>name (s)</parameter>: see <literal>short</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>description (s)</parameter>: see <literal>description</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>ports (a(ss))</parameter>: array of port and protocol pairs. See <literal>port</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>module names (as)</parameter>: array of kernel netfilter helpers, see <literal>module</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>destinations (a{ss})</parameter>: dictionary of {IP family : IP address} where 'IP family' key can be either 'ipv4' or 'ipv6'. See <literal>destination</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>protocols (as)</parameter>: array of protocols, see <literal>protocol</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>source_ports (a(ss))</parameter>: array of port and protocol pairs. See <literal>source-port</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>includes (as)</parameter>: array of service includes, see <literal>include</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>helpers (as)</parameter>: array of service helpers, see <literal>helper</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
</variablelist>
</para>
<para>
Possible errors: INVALID_SERVICE
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.Methods.getZoneSettings">
<term><methodname>getZoneSettings</methodname>(s: <parameter>zone</parameter>) → (sssbsasa(ss)asba(ssss)asasasasa(ss)b)</term>
<listitem>
<para>
Return runtime settings of given <replaceable>zone</replaceable>.
For getting permanent settings see <link linkend="FirewallD1.config.zone.Methods.getSettings">org.fedoraproject.FirewallD1.config.zone.Methods.getSettings</link>.
Settings are in format: <parameter>version</parameter>, <parameter>name</parameter>, <parameter>description</parameter>, <parameter>UNUSED</parameter>, <parameter>target</parameter>, array of <parameter>services</parameter>, array of <parameter>ports</parameter> (port, protocol), array of <parameter>icmp-blocks</parameter>, <parameter>masquerade</parameter>, array of <parameter>forward-ports</parameter> (port, protocol, to-port, to-addr), array of <parameter>interfaces</parameter>, array of <parameter>sources</parameter>, array of <parameter>rich rules</parameter>, array of <parameter>protocols</parameter> and array of <parameter>source-ports</parameter> (port, protocol).
</para>
<para>
<variablelist>
<varlistentry><term><parameter>version (s)</parameter>: see <literal>version</literal> attribute of <literal>zone</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>name (s)</parameter>: see <literal>short</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>description (s)</parameter>: see <literal>description</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>UNUSED (b)</parameter>: this boolean value is no longer used for anything.</term></varlistentry>
<varlistentry><term><parameter>target (s)</parameter>: see <literal>target</literal> attribute of <literal>zone</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>services (as)</parameter>: array of service names, see <literal>service</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>ports (a(ss))</parameter>: array of port and protocol pairs. See <literal>port</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>icmp-blocks (as)</parameter>: array of icmp-blocks. See <literal>icmp-block</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>masquerade (b)</parameter>: see <literal>masquerade</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>forward-ports (a(ssss))</parameter>: array of (port, protocol, to-port, to-addr). See <literal>forward-port</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>interfaces (as)</parameter>: array of interfaces. See <literal>interface</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>source addresses (as)</parameter>: array of source addresses. See <literal>source</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>rich rules (as)</parameter>: array of rich-language rules. See <literal>rule</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>protocols (as)</parameter>: array of protocols, see <literal>protocol</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>source-ports (a(ss))</parameter>: array of port and protocol pairs. See <literal>source-port</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
</variablelist>
</para>
<para>
Possible errors: INVALID_ZONE
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.Methods.listIcmpTypes">
<term><methodname>listIcmpTypes</methodname>() → as</term>
<listitem>
<para>
Return array of names (s) of icmp types in runtime configuration.
For permanent configuration see <link linkend="FirewallD1.config.Methods.listIcmpTypes">org.fedoraproject.FirewallD1.config.Methods.listIcmpTypes</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.Methods.listServices">
<term><methodname>listServices</methodname>() → as</term>
<listitem>
<para>
Return array of service names (s) in runtime configuration.
For permanent configuration see <link linkend="FirewallD1.config.Methods.listServices">org.fedoraproject.FirewallD1.config.Methods.listServices</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.Methods.queryPanicMode">
<term><methodname>queryPanicMode</methodname>() → b</term>
<listitem>
<para>
Return true if panic mode is enabled, false otherwise. In panic mode all incoming and outgoing packets are dropped.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.Methods.reload">
<term><methodname>reload</methodname>() → Nothing</term>
<listitem>
<para>
Reload firewall rules and keep state information.
Current permanent configuration will become new runtime configuration,
i.e. all runtime only changes done until reload are lost with
reload if they have not been also in permanent configuration.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.Methods.runtimeToPermanent">
<term><methodname>runtimeToPermanent</methodname>() → Nothing</term>
<listitem>
<para>
Make runtime settings permanent. Replaces permanent settings with runtime settings for zones, services, icmptypes, direct and policies (lockdown whitelist).
</para>
<para>
Possible errors: RT_TO_PERM_FAILED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.Methods.checkPermanentConfig">
<term><methodname>checkPermanentConfig</methodname>() → Nothing</term>
<listitem>
<para>
Run checks on the permanent configuration. This is most useful if changes were made manually to configuration files.
</para>
<para>
Possible errors: any
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.Methods.setDefaultZone">
<term><methodname>setDefaultZone</methodname>(s: <parameter>zone</parameter>) → Nothing</term>
<listitem>
<para>
Set default zone for connections and interfaces where no zone has been selected to <replaceable>zone</replaceable>.
Setting the default zone changes the zone for the connections or interfaces, that are using the default zone.
This is a runtime and permanent change.
</para>
<para>
Possible errors: ZONE_ALREADY_SET, COMMAND_FAILED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.Methods.setLogDenied">
<term><methodname>setLogDenied</methodname>(s: <parameter>value</parameter>) → Nothing</term>
<listitem>
<para>
Set LogDenied value to <replaceable>value</replaceable>.
If LogDenied is enabled, then logging rules are added 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.
Possible values are: <literal>all</literal>, <literal>unicast</literal>, <literal>broadcast</literal>, <literal>multicast</literal> and <literal>off</literal>.
The default value is <literal>off</literal>
This is a runtime and permanent change.
</para>
<para>
Possible errors: ALREADY_SET, INVALID_VALUE
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect3>
<refsect3 id="FirewallD1.Signals">
<title>Signals</title>
<variablelist>
<varlistentry id="FirewallD1.Signals.DefaultZoneChanged">
<term><methodname>DefaultZoneChanged</methodname>(s: <parameter>zone</parameter>)</term>
<listitem>
<para>
Emitted when default zone has been changed to <replaceable>zone</replaceable>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.Signals.LogDeniedChanged">
<term><methodname>LogDeniedChanged</methodname>(s: <parameter>value</parameter>)</term>
<listitem>
<para>
Emitted when LogDenied value has been changed.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.Signals.PanicModeDisabled">
<term><methodname>PanicModeDisabled</methodname>()</term>
<listitem>
<para>
Emitted when panic mode has been deactivated.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.Signals.PanicModeEnabled">
<term><methodname>PanicModeEnabled</methodname>()</term>
<listitem>
<para>
Emitted when panic mode has been activated.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.Signals.Reloaded">
<term><methodname>Reloaded</methodname>()</term>
<listitem>
<para>
Emitted when firewalld has been reloaded. Also emitted for a complete reload.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect3>
<refsect3 id="FirewallD1.Properties">
<title>Properties</title>
<variablelist>
<varlistentry id="FirewallD1.Properties.BRIDGE">
<term><parameter>BRIDGE</parameter> - b - (ro)</term>
<listitem><para>Indicates whether the firewall has ethernet bridge support.</para></listitem>
</varlistentry>
<varlistentry id="FirewallD1.Properties.IPSet">
<term><parameter>IPSet</parameter> - b - (ro)</term>
<listitem><para>Indicates whether the firewall has IPSet support.</para></listitem>
</varlistentry>
<varlistentry id="FirewallD1.Properties.IPSetTypes">
<term><parameter>IPSetTypes</parameter> - as - (ro)</term>
<listitem><para>The supported IPSet types by ipset and firewalld.</para></listitem>
</varlistentry>
<varlistentry id="FirewallD1.Properties.IPv4">
<term><parameter>IPv4</parameter> - b - (ro)</term>
<listitem><para>Indicates whether the firewall has IPv4 support.</para></listitem>
</varlistentry>
<varlistentry id="FirewallD1.Properties.IPv4ICMPTypes">
<term><parameter>IPv4ICMPTypes</parameter> - as - (ro)</term>
<listitem><para>The list of supported IPv4 ICMP types.</para></listitem>
</varlistentry>
<varlistentry id="FirewallD1.Properties.IPv6">
<term><parameter>IPv6</parameter> - b - (ro)</term>
<listitem><para>Indicates whether the firewall has IPv6 support.</para></listitem>
</varlistentry>
<varlistentry id="FirewallD1.Properties.IPv6_rpfilter">
<term><parameter>IPv6_rpfilter</parameter> - b - (ro)</term>
<listitem><para>Indicates whether the reverse path filter test on a packet for IPv6 is enabled. If a reply to the packet would be sent via the same interface that the packet arrived on, the packet will match and be accepted, otherwise dropped.</para></listitem>
</varlistentry>
<varlistentry id="FirewallD1.Properties.IPv6ICMPTypes">
<term><parameter>IPv6ICMPTypes</parameter> - as - (ro)</term>
<listitem><para>The list of supported IPv6 ICMP types.</para></listitem>
</varlistentry>
<varlistentry id="FirewallD1.Properties.nf_conntrack_helper_setting">
<annotation name="org.freedesktop.DBus.Deprecated" />
<term><parameter>nf_conntrach_helper_setting</parameter> - b - (ro)</term>
<listitem><para>Deprecated. Always False.</para></listitem>
</varlistentry>
<varlistentry id="FirewallD1.Properties.nf_conntrack_helpers">
<annotation name="org.freedesktop.DBus.Deprecated" />
<term><parameter>nf_conntrack_helpers</parameter> - a{sas} - (ro)</term>
<listitem><para>Deprecated. Always returns an empty dictionary.</para></listitem>
</varlistentry>
<varlistentry id="FirewallD1.Properties.nf_nat_helpers">
<annotation name="org.freedesktop.DBus.Deprecated" />
<term><parameter>nf_nat_helpers</parameter> - a{sas} - (ro)</term>
<listitem><para>Deprecated. Always returns an empty dictionary.</para></listitem>
</varlistentry>
<varlistentry id="FirewallD1.Properties.interface_version">
<term><parameter>interface_version</parameter> - s - (ro)</term>
<listitem><para>firewalld D-Bus interface version string.</para></listitem>
</varlistentry>
<varlistentry id="FirewallD1.Properties.state">
<term><parameter>state</parameter> - s - (ro)</term>
<listitem><para>firewalld state. This can be either <literal>INIT</literal>, <literal>FAILED</literal>, or <literal>RUNNING</literal>. In <literal>INIT</literal> state, firewalld is starting up and initializing. In <literal>FAILED</literal> state, firewalld completely started but experienced a failure.</para></listitem>
</varlistentry>
<varlistentry id="FirewallD1.Properties.version">
<term><parameter>version</parameter> - s - (ro)</term>
<listitem><para>firewalld version string.</para></listitem>
</varlistentry>
</variablelist>
</refsect3>
</refsect2>
<refsect2 id="FirewallD1.ipset">
<title>org.fedoraproject.FirewallD1.ipset</title>
<para>
Operations in this interface allows to get, add, remove and query runtime ipset settings.
For permanent configuration see <link linkend="FirewallD1.config.ipset">org.fedoraproject.FirewallD1.config.ipset</link> interface.
</para>
<refsect3 id="FirewallD1.ipset.Methods">
<title>Methods</title>
<variablelist>
<varlistentry id="FirewallD1.ipset.Methods.addEntry">
<term><methodname>addEntry</methodname>(s: ipset, s: entry) → as</term>
<listitem>
<para>
Add a new <replaceable>entry</replaceable> to <replaceable>ipset</replaceable>.
The entry must match the type of the ipset. If the ipset is using the timeout option, it is not possible to see the entries, as they are timing out automatically in the kernel.
For permanent operation see <link linkend="FirewallD1.config.ipset.Methods.addEntry">org.fedoraproject.FirewallD1.config.ipset.Methods.addEntry</link>.
</para>
<para>
Possible errors: INVALID_IPSET, IPSET_WITH_TIMEOUT
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.ipset.Methods.getEntries">
<term><methodname>getEntries</methodname>(s: ipset) → Nothing</term>
<listitem>
<para>
Get all entries added to the <replaceable>ipset</replaceable>.
If the ipset is using the timeout option, it is not possible to see the entries, as they are timing out automatically in the kernel.
Return value is a array of <parameter>entry</parameter>.
For permanent operation see <link linkend="FirewallD1.config.ipset.Methods.getEntries">org.fedoraproject.FirewallD1.config.ipset.Methods.getEntries</link>.
</para>
<para>
Possible errors: INVALID_IPSET, IPSET_WITH_TIMEOUT
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.ipset.Methods.getIPSetSettings">
<term><methodname>getSettings</methodname>(s: ipset) → (ssssa{ss}as)</term>
<listitem>
<para>
Return runtime settings of given <replaceable>ipset</replaceable>.
For getting permanent settings see <link linkend="FirewallD1.config.ipset.Methods.getSettings">org.fedoraproject.FirewallD1.config.ipset.Methods.getSettings</link>.
Settings are in format: <parameter>version</parameter>, <parameter>name</parameter>, <parameter>description</parameter>, <parameter>type</parameter>, dictionary of <parameter>options</parameter> and array of <parameter>entries</parameter>.
</para>
<para>
<variablelist>
<varlistentry><term><parameter>version (s)</parameter>: see <literal>version</literal> attribute of <literal>ipset</literal> tag in <citerefentry><refentrytitle>firewalld.ipset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>name (s)</parameter>: see <literal>short</literal> tag in <citerefentry><refentrytitle>firewalld.ipset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>description (s)</parameter>: see <literal>description</literal> tag in <citerefentry><refentrytitle>firewalld.ipset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>type (s)</parameter>: see <literal>type</literal> attribute of <literal>ipset</literal> tag in <citerefentry><refentrytitle>firewalld.ipset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>options (a{ss})</parameter>: dictionary of {option : value} . See <literal>options</literal> tag in <citerefentry><refentrytitle>firewalld.ipset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>entries (as)</parameter>: array of entries, see <literal>entry</literal> tag in <citerefentry><refentrytitle>firewalld.ipset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
</variablelist>
</para>
<para>
Possible errors: INVALID_IPSET
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.ipset.Methods.getIPSets">
<term><methodname>getIPSets</methodname>() → as</term>
<listitem>
<para>
Return array of ipset names (s) in runtime configuration.
For permanent configuration see <link linkend="FirewallD1.config.Methods.listIPSets">org.fedoraproject.FirewallD1.config.Methods.listIPSets</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.ipset.Methods.queryEntry">
<term><methodname>queryService</methodname>(s: ipset, s: entry) → b</term>
<listitem>
<para>
Return whether <replaceable>entry</replaceable> has been added to <replaceable>ipset</replaceable>.
For permanent operation see <link linkend="FirewallD1.config.ipset.Methods.queryEntry">org.fedoraproject.FirewallD1.config.ipset.Methods.queryEntry</link>.
</para>
<para>
Possible errors: INVALID_IPSET
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.ipset.Methods.queryIPSet">
<term><methodname>queryService</methodname>(s: ipset) → b</term>
<listitem>
<para>
Return whether <replaceable>ipset</replaceable> is defined in runtime configuration.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.ipset.Methods.removeEntry">
<term><methodname>removeEntry</methodname>(s: ipset, s: entry) → as</term>
<listitem>
<para>
Removes an <replaceable>entry</replaceable> from <replaceable>ipset</replaceable>.
For permanent operation see <link linkend="FirewallD1.config.ipset.Methods.removeEntry">org.fedoraproject.FirewallD1.config.ipset.Methods.removeEntry</link>.
</para>
<para>
Possible errors: INVALID_IPSET, IPSET_WITH_TIMEOUT
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.ipset.Methods.setEntries">
<term><methodname>setEntries</methodname>(as: entries) → Nothing</term>
<listitem>
<para>
Permanently set list of entries to <replaceable>entries</replaceable>.
For permanent operation see <link linkend="FirewallD1.config.ipset.Methods.setEntries">org.fedoraproject.FirewallD1.config.ipset.Methods.setEntries</link>.
See <literal>entry</literal> tag in <citerefentry><refentrytitle>firewalld.ipset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect3>
<refsect3 id="FirewallD1.ipset.Signals">
<title>Signals</title>
<variablelist>
<varlistentry id="FirewallD1.ipset.Signals.EntryAdded">
<term>EntryAdded(s: ipset, s: entry)</term>
<listitem>
<para>
Emitted when <replaceable>entry</replaceable> has been added to <replaceable>ipset</replaceable>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.ipset.Signals.EntryRemoved">
<term>EntryRemoved(s: ipset, s: entry)</term>
<listitem>
<para>
Emitted when <replaceable>entry</replaceable> has been removed from <replaceable>ipset</replaceable>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect3>
</refsect2>
<refsect2 id="FirewallD1.direct">
<title>org.fedoraproject.FirewallD1.direct</title>
<para>
This interface enables more direct access to the firewall.
It enables runtime manipulation with chains and rules.
For permanent configuration see <link linkend="FirewallD1.config.direct">org.fedoraproject.FirewallD1.config.direct</link> interface.
</para>
<refsect3 id="FirewallD1.direct.Methods">
<title>Methods</title>
<variablelist>
<varlistentry id="FirewallD1.direct.Methods.addChain">
<term><methodname>addChain</methodname>(s: ipv, s: table, s: chain) → Nothing</term>
<listitem>
<para>
Add a new <replaceable>chain</replaceable> to <replaceable>table</replaceable> for <replaceable>ipv</replaceable> being either <literal>ipv4</literal> (iptables) or <literal>ipv6</literal> (ip6tables) or <literal>eb</literal> (ebtables).
Make sure there's no other chain with this name already.
There already exist basic chains to use with direct methods, for example <literal>INPUT_direct</literal> chain.
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.
For permanent operation see <link linkend="FirewallD1.config.direct.Methods.addChain">org.fedoraproject.FirewallD1.config.direct.Methods.addChain</link>.
</para>
<para>
Possible errors: INVALID_IPV, INVALID_TABLE, ALREADY_ENABLED, COMMAND_FAILED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.direct.Methods.addPassthrough">
<term><methodname>addPassthrough</methodname>(s: ipv, as: args) → Nothing</term>
<listitem>
<para>
Add a tracked passthrough rule with the arguments <replaceable>args</replaceable> for <replaceable>ipv</replaceable> being either <literal>ipv4</literal> (iptables) or <literal>ipv6</literal> (ip6tables) or <literal>eb</literal> (ebtables).
Valid commands in args are only <literal>-A/--append</literal>, <literal>-I/--insert</literal> and <literal>-N/--new-chain</literal>.
This method is (unlike passthrough method) tracked, i.e. firewalld remembers it. It's useful with <link linkend="FirewallD1.Methods.runtimeToPermanent">org.fedoraproject.FirewallD1.Methods.runtimeToPermanent</link>
For permanent operation see <link linkend="FirewallD1.config.direct.Methods.addPassthrough">org.fedoraproject.FirewallD1.config.direct.Methods.addPassthrough</link>.
</para>
<para>
Possible errors: INVALID_IPV, ALREADY_ENABLED, COMMAND_FAILED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.direct.Methods.addRule">
<term><methodname>addRule</methodname>(s: ipv, s: table, s: chain, i: priority, as: args) → Nothing</term>
<listitem>
<para>
Add a rule with the arguments <replaceable>args</replaceable> to <replaceable>chain</replaceable> in <replaceable>table</replaceable> with <replaceable>priority</replaceable> for <replaceable>ipv</replaceable> being either <literal>ipv4</literal> (iptables) or <literal>ipv6</literal> (ip6tables) or <literal>eb</literal> (ebtables).
The priority 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.
For permanent operation see <link linkend="FirewallD1.config.direct.Methods.addRule">org.fedoraproject.FirewallD1.config.direct.Methods.addRule</link>.
</para>
<para>
Possible errors: INVALID_IPV, INVALID_TABLE, ALREADY_ENABLED, COMMAND_FAILED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.direct.Methods.getAllChains">
<term><methodname>getAllChains</methodname>() → a(sss)</term>
<listitem>
<para>
Get all chains added to all tables in format: ipv, table, chain.
This concerns only chains previously added with <methodname>addChain</methodname>.
Return value is a array of (<parameter>ipv</parameter>, <parameter>table</parameter>, <parameter>chain</parameter>).
For permanent operation see <link linkend="FirewallD1.config.direct.Methods.getAllChains">org.fedoraproject.FirewallD1.config.direct.Methods.getAllChains</link>.
</para>
<para>
<variablelist>
<varlistentry><term><parameter>ipv (s)</parameter>: either <literal>ipv4</literal> (iptables) or <literal>ipv6</literal> (ip6tables) or <literal>eb</literal> (ebtables).</term></varlistentry>
<varlistentry><term><parameter>table (s)</parameter>: one of <literal>filter</literal>, <literal>mangle</literal>, <literal>nat</literal>, <literal>raw</literal>, <literal>security</literal></term></varlistentry>
<varlistentry><term><parameter>chain (s)</parameter>: name of a chain.</term></varlistentry>
</variablelist>
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.direct.Methods.getAllPassthroughs">
<term><methodname>getAllPassthroughs</methodname>() → a(sas)</term>
<listitem>
<para>
Get all tracked passthrough rules added in all ipv types in format: ipv, rule.
This concerns only rules previously added with <methodname>addPassthrough</methodname>.
Return value is a array of (<parameter>ipv</parameter>, array of <parameter>arguments</parameter>).
For permanent operation see <link linkend="FirewallD1.config.direct.Methods.getAllPassthroughs">org.fedoraproject.FirewallD1.config.direct.Methods.getAllPassthroughs</link>.
</para>
<para>
<variablelist>
<varlistentry><term><parameter>ipv (s)</parameter>: either <literal>ipv4</literal> (iptables) or <literal>ipv6</literal> (ip6tables) or <literal>eb</literal> (ebtables).</term></varlistentry>
<varlistentry><term><parameter>arguments (as)</parameter>: array of commands, parameters and other iptables/ip6tables/ebtables command line options.</term></varlistentry>
</variablelist>
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.direct.Methods.getAllRules">
<term><methodname>getAllRules</methodname>() → a(sssias)</term>
<listitem>
<para>
Get all rules added to all chains in all tables in format: ipv, table, chain, priority, rule.
This concerns only rules previously added with <methodname>addRule</methodname>.
Return value is a array of (<parameter>ipv</parameter>, <parameter>table</parameter>, <parameter>chain</parameter>, <parameter>priority</parameter>, array of <parameter>arguments</parameter>).
For permanent operation see <link linkend="FirewallD1.config.direct.Methods.getAllRules">org.fedoraproject.FirewallD1.config.direct.Methods.getAllRules</link>.
</para>
<para>
<variablelist>
<varlistentry><term><parameter>ipv (s)</parameter>: either <literal>ipv4</literal> (iptables) or <literal>ipv6</literal> (ip6tables) or <literal>eb</literal> (ebtables).</term></varlistentry>
<varlistentry><term><parameter>table (s)</parameter>: one of <literal>filter</literal>, <literal>mangle</literal>, <literal>nat</literal>, <literal>raw</literal>, <literal>security</literal></term></varlistentry>
<varlistentry><term><parameter>chain (s)</parameter>: name of a chain.</term></varlistentry>
<varlistentry><term><parameter>priority (i)</parameter>: used to order rules.</term></varlistentry>
<varlistentry><term><parameter>arguments (as)</parameter>: array of commands, parameters and other iptables/ip6tables/ebtables command line options.</term></varlistentry>
</variablelist>
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.direct.Methods.getChains">
<term><methodname>getChains</methodname>(s: ipv, s: table) → as</term>
<listitem>
<para>
Return an array of chains (s) added to <replaceable>table</replaceable> for <replaceable>ipv</replaceable> being either <literal>ipv4</literal> (iptables) or <literal>ipv6</literal> (ip6tables) or <literal>eb</literal> (ebtables).
This concerns only chains previously added with <methodname>addChain</methodname>.
For permanent operation see <link linkend="FirewallD1.config.direct.Methods.getChains">org.fedoraproject.FirewallD1.config.direct.Methods.getChains</link>.
</para>
<para>
Possible errors: INVALID_IPV, INVALID_TABLE
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.direct.Methods.getPassthroughs">
<term><methodname>getPassthroughs</methodname>(s: ipv) → aas</term>
<listitem>
<para>
Get tracked passthrough rules added in either <literal>ipv4</literal> (iptables) or <literal>ipv6</literal> (ip6tables) or <literal>eb</literal> (ebtables).
This concerns only rules previously added with <methodname>addPassthrough</methodname>.
Return value is a array of (array of <parameter>arguments</parameter>).
For permanent operation see <link linkend="FirewallD1.config.direct.Methods.getPassthroughs">org.fedoraproject.FirewallD1.config.direct.Methods.getPassthroughs</link>.
</para>
<para>
<variablelist>
<varlistentry><term><parameter>arguments (as)</parameter>: array of commands, parameters and other iptables/ip6tables/ebtables command line options.</term></varlistentry>
</variablelist>
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.direct.Methods.getRules">
<term><methodname>getRules</methodname>(s: ipv, s: table, s: chain) → a(ias)</term>
<listitem>
<para>
Get all rules added to <replaceable>chain</replaceable> in <replaceable>table</replaceable> for <replaceable>ipv</replaceable> being either <literal>ipv4</literal> (iptables) or <literal>ipv6</literal> (ip6tables) or <literal>eb</literal> (ebtables).
This concerns only rules previously added with <methodname>addRule</methodname>.
Return value is a array of (<parameter>priority</parameter>, array of <parameter>arguments</parameter>).
For permanent operation see <link linkend="FirewallD1.config.direct.Methods.getRules">org.fedoraproject.FirewallD1.config.direct.Methods.getRules</link>.
</para>
<para>
<variablelist>
<varlistentry><term><parameter>priority (i)</parameter>: used to order rules.</term></varlistentry>
<varlistentry><term><parameter>arguments (as)</parameter>: array of commands, parameters and other iptables/ip6tables/ebtables command line options.</term></varlistentry>
</variablelist>
</para>
<para>
Possible errors: INVALID_IPV, INVALID_TABLE
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.direct.Methods.passthrough">
<term><methodname>passthrough</methodname>(s: ipv, as: args) → s</term>
<listitem>
<para>
Pass a command through to the firewall.
<replaceable>ipv</replaceable> can be either <literal>ipv4</literal> (iptables) or <literal>ipv6</literal> (ip6tables) or <literal>eb</literal> (ebtables). <replaceable>args</replaceable> can be all <command>iptables</command>, <command>ip6tables</command> and <command>ebtables</command> command line arguments.
<replaceable>args</replaceable> can be all iptables, ip6tables and ebtables command line arguments.
This command is untracked, which means that firewalld is not able to provide information about this command later on.
</para>
<para>
Possible errors: COMMAND_FAILED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.direct.Methods.queryChain">
<term><methodname>queryChain</methodname>(s: ipv, s: table, s: chain) → b</term>
<listitem>
<para>
Return whether a <replaceable>chain</replaceable> exists in <replaceable>table</replaceable> for <replaceable>ipv</replaceable> being either <literal>ipv4</literal> (iptables) or <literal>ipv6</literal> (ip6tables) or <literal>eb</literal> (ebtables).
This concerns only chains previously added with <methodname>addChain</methodname>.
For permanent operation see <link linkend="FirewallD1.config.direct.Methods.queryChain">org.fedoraproject.FirewallD1.config.direct.Methods.queryChain</link>.
</para>
<para>
Possible errors: INVALID_IPV, INVALID_TABLE
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.direct.Methods.queryPassthrough">
<term><methodname>queryPassthrough</methodname>(s: ipv, as: args) → b</term>
<listitem>
<para>
Return whether a tracked passthrough rule with the arguments <replaceable>args</replaceable> exists for <replaceable>ipv</replaceable> being either <literal>ipv4</literal> (iptables) or <literal>ipv6</literal> (ip6tables) or <literal>eb</literal> (ebtables).
This concerns only rules previously added with <methodname>addPassthrough</methodname>.
For permanent operation see <link linkend="FirewallD1.config.direct.Methods.queryPassthrough">org.fedoraproject.FirewallD1.config.direct.Methods.queryPassthrough</link>.
</para>
<para>
Possible errors: INVALID_IPV
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.direct.Methods.queryRule">
<term><methodname>queryRule</methodname>(s: ipv, s: table, s: chain, i: priority, as: args) → b</term>
<listitem>
<para>
Return whether a rule with <replaceable>priority</replaceable> and the arguments <replaceable>args</replaceable> exists in <replaceable>chain</replaceable> in <replaceable>table</replaceable> for <replaceable>ipv</replaceable> being either <literal>ipv4</literal> (iptables) or <literal>ipv6</literal> (ip6tables) or <literal>eb</literal> (ebtables).
This concerns only rules previously added with <methodname>addRule</methodname>.
For permanent operation see <link linkend="FirewallD1.config.direct.Methods.queryRule">org.fedoraproject.FirewallD1.config.direct.Methods.queryRule</link>.
</para>
<para>
Possible errors: INVALID_IPV, INVALID_TABLE
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.direct.Methods.removeAllPassthroughs">
<term><methodname>removeAllPassthroughs</methodname>() → Nothing</term>
<listitem>
<para>
Remove all passthrough rules previously added with <methodname>addPassthrough</methodname>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.direct.Methods.removeChain">
<term><methodname>removeChain</methodname>(s: ipv, s: table, s: chain) → Nothing</term>
<listitem>
<para>
Remove a <replaceable>chain</replaceable> from <replaceable>table</replaceable> for <replaceable>ipv</replaceable> being either <literal>ipv4</literal> (iptables) or <literal>ipv6</literal> (ip6tables) or <literal>eb</literal> (ebtables).
Only chains previously added with <methodname>addChain</methodname> can be removed this way.
For permanent operation see <link linkend="FirewallD1.config.direct.Methods.removeChain">org.fedoraproject.FirewallD1.config.direct.Methods.removeChain</link>.
</para>
<para>
Possible errors: INVALID_IPV, INVALID_TABLE, NOT_ENABLED, COMMAND_FAILED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.direct.Methods.removePassthrough">
<term><methodname>removePassthrough</methodname>(s: ipv, as: args) → Nothing</term>
<listitem>
<para>
Remove a tracked passthrough rule with arguments <replaceable>args</replaceable> for <replaceable>ipv</replaceable> being either <literal>ipv4</literal> (iptables) or <literal>ipv6</literal> (ip6tables) or <literal>eb</literal> (ebtables).
Only rules previously added with <methodname>addPassthrough</methodname> can be removed this way.
For permanent operation see <link linkend="FirewallD1.config.direct.Methods.removePassthrough">org.fedoraproject.FirewallD1.config.direct.Methods.removePassthrough</link>.
</para>
<para>
Possible errors: INVALID_IPV, NOT_ENABLED, COMMAND_FAILED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.direct.Methods.removeRule">
<term><methodname>removeRule</methodname>(s: ipv, s: table, s: chain, i: priority, as: args) → Nothing</term>
<listitem>
<para>
Remove a rule with <replaceable>priority</replaceable> and arguments <replaceable>args</replaceable> from <replaceable>chain</replaceable> in <replaceable>table</replaceable> for <replaceable>ipv</replaceable> being either <literal>ipv4</literal> (iptables) or <literal>ipv6</literal> (ip6tables) or <literal>eb</literal> (ebtables).
Only rules previously added with <methodname>addRule</methodname> can be removed this way.
For permanent operation see <link linkend="FirewallD1.config.direct.Methods.removeRule">org.fedoraproject.FirewallD1.config.direct.Methods.removeRule</link>.
</para>
<para>
Possible errors: INVALID_IPV, INVALID_TABLE, NOT_ENABLED, COMMAND_FAILED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.direct.Methods.removeRules">
<term><methodname>removeRules</methodname>(s: ipv, s: table, s: chain) → Nothing</term>
<listitem>
<para>
Remove all rules from <replaceable>chain</replaceable> in <replaceable>table</replaceable> for <replaceable>ipv</replaceable> being either <literal>ipv4</literal> (iptables) or <literal>ipv6</literal> (ip6tables) or <literal>eb</literal> (ebtables).
This concerns only rules previously added with <methodname>addRule</methodname>.
For permanent operation see <link linkend="FirewallD1.config.direct.Methods.removeRules">org.fedoraproject.FirewallD1.config.direct.Methods.removeRules</link>.
</para>
<para>
Possible errors: INVALID_IPV, INVALID_TABLE
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect3>
<refsect3 id="FirewallD1.direct.Signals">
<title>Signals</title>
<variablelist>
<varlistentry id="FirewallD1.direct.Signals.ChainAdded">
<term>ChainAdded(s: ipv, s: table, s: chain)</term>
<listitem>
<para>
Emitted when <replaceable>chain</replaceable> has been added into <replaceable>table</replaceable> for <replaceable>ipv</replaceable> being either <literal>ipv4</literal> (iptables) or <literal>ipv6</literal> (ip6tables) or <literal>eb</literal> (ebtables).
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.direct.Signals.ChainRemoved">
<term>ChainRemoved(s: ipv, s: table, s: chain)</term>
<listitem>
<para>
Emitted when <replaceable>chain</replaceable> has been removed from <replaceable>table</replaceable> for <replaceable>ipv</replaceable> being either <literal>ipv4</literal> (iptables) or <literal>ipv6</literal> (ip6tables) or <literal>eb</literal> (ebtables).
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.direct.Signals.PassthroughAdded">
<term>PassthroughAdded(s: ipv, as: args)</term>
<listitem>
<para>
Emitted when a tracked passthruogh rule with <replaceable>args</replaceable> has been added for <replaceable>ipv</replaceable> being either <literal>ipv4</literal> (iptables) or <literal>ipv6</literal> (ip6tables) or <literal>eb</literal> (ebtables).
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.direct.Signals.PassthroughRemoved">
<term>PassthroughRemoved(s: ipv, as: args)</term>
<listitem>
<para>
Emitted when a tracked passthrough rule with <replaceable>args</replaceable> has been removed for <replaceable>ipv</replaceable> being either <literal>ipv4</literal> (iptables) or <literal>ipv6</literal> (ip6tables) or <literal>eb</literal> (ebtables).
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.direct.Signals.RuleAdded">
<term>RuleAdded(s: ipv, s: table, s: chain, i: priority, as: args)</term>
<listitem>
<para>
Emitted when a rule with <replaceable>args</replaceable> has been added to <replaceable>chain</replaceable> in <replaceable>table</replaceable> with <replaceable>priority</replaceable> for <replaceable>ipv</replaceable> being either <literal>ipv4</literal> (iptables) or <literal>ipv6</literal> (ip6tables) or <literal>eb</literal> (ebtables).
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.direct.Signals.RuleRemoved">
<term>RuleRemoved(s: ipv, s: table, s: chain, i: priority, as: args)</term>
<listitem>
<para>
Emitted when a rule with <replaceable>args</replaceable> has been removed from <replaceable>chain</replaceable> in <replaceable>table</replaceable> with <replaceable>priority</replaceable> for <replaceable>ipv</replaceable> being either <literal>ipv4</literal> (iptables) or <literal>ipv6</literal> (ip6tables) or <literal>eb</literal> (ebtables).
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect3>
</refsect2>
<refsect2 id="FirewallD1.policies">
<title>org.fedoraproject.FirewallD1.policies</title>
<para>
Enables firewalld to be able to lock down configuration changes from local applications.
Local applications or services are able to change the firewall configuration if they are running as root (example: libvirt).
With these operations administrator can lock the firewall configuration so that either none or only applications that are in the whitelist are able to request firewall changes.
For permanent configuration see <link linkend="FirewallD1.config.policies">org.fedoraproject.FirewallD1.config.policies</link> interface.
</para>
<refsect3 id="FirewallD1.policies.Methods">
<title>Methods</title>
<variablelist>
<varlistentry id="FirewallD1.policies.Methods.addLockdownWhitelistCommand">
<term><methodname>addLockdownWhitelistCommand</methodname>(s: command) → Nothing</term>
<listitem>
<para>
Add <replaceable>command</replaceable> to whitelist.
See <literal>command</literal> option in <citerefentry><refentrytitle>firewalld.lockdown-whitelist</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For permanent operation see <link linkend="FirewallD1.config.policies.Methods.addLockdownWhitelistCommand">org.fedoraproject.FirewallD1.config.policies.Methods.addLockdownWhitelistCommand</link>.
</para>
<para>
Possible errors: ALREADY_ENABLED, INVALID_COMMAND
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.policies.Methods.addLockdownWhitelistContext">
<term><methodname>addLockdownWhitelistContext</methodname>(s: context) → Nothing</term>
<listitem>
<para>
Add <replaceable>context</replaceable> to whitelist.
See <literal>selinux</literal> option in <citerefentry><refentrytitle>firewalld.lockdown-whitelist</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For permanent operation see <link linkend="FirewallD1.config.policies.Methods.addLockdownWhitelistContext">org.fedoraproject.FirewallD1.config.policies.Methods.addLockdownWhitelistContext</link>.
</para>
<para>
Possible errors: ALREADY_ENABLED, INVALID_COMMAND
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.policies.Methods.addLockdownWhitelistUid">
<term><methodname>addLockdownWhitelistUid</methodname>(i: uid) → Nothing</term>
<listitem>
<para>
Add user id <replaceable>uid</replaceable> to whitelist.
See <literal>user</literal> option in <citerefentry><refentrytitle>firewalld.lockdown-whitelist</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For permanent operation see <link linkend="FirewallD1.config.policies.Methods.addLockdownWhitelistUid">org.fedoraproject.FirewallD1.config.policies.Methods.addLockdownWhitelistUid</link>.
</para>
<para>
Possible errors: ALREADY_ENABLED, INVALID_COMMAND
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.policies.Methods.addLockdownWhitelistUser">
<term><methodname>addLockdownWhitelistUser</methodname>(s: user) → Nothing</term>
<listitem>
<para>
Add <replaceable>user</replaceable> name to whitelist.
See <literal>user</literal> option in <citerefentry><refentrytitle>firewalld.lockdown-whitelist</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For permanent operation see <link linkend="FirewallD1.config.policies.Methods.addLockdownWhitelistUser">org.fedoraproject.FirewallD1.config.policies.Methods.addLockdownWhitelistUser</link>.
</para>
<para>
Possible errors: ALREADY_ENABLED, INVALID_COMMAND
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.policies.Methods.disableLockdown">
<term><methodname>disableLockdown</methodname>() → Nothing</term>
<listitem>
<para>
Disable lockdown.
This is a runtime and permanent change.
</para>
<para>
Possible errors: NOT_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.policies.Methods.enableLockdown">
<term><methodname>enableLockdown</methodname>() → Nothing</term>
<listitem>
<para>
Enable lockdown.
Be careful - if the calling application/user is not on lockdown whitelist when you enable lockdown you won't be able to disable it again with the application, you would need to edit firewalld.conf.
This is a runtime and permanent change.
</para>
<para>
Possible errors: ALREADY_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.policies.Methods.getLockdownWhitelistCommands">
<term><methodname>getLockdownWhitelistCommands</methodname>() → as</term>
<listitem>
<para>
List all command lines (s) that are on whitelist.
For permanent operation see <link linkend="FirewallD1.config.policies.Methods.getLockdownWhitelistCommands">org.fedoraproject.FirewallD1.config.policies.Methods.getLockdownWhitelistCommands</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.policies.Methods.getLockdownWhitelistContexts">
<term><methodname>getLockdownWhitelistContexts</methodname>() → as</term>
<listitem>
<para>
List all contexts (s) that are on whitelist.
For permanent operation see <link linkend="FirewallD1.config.policies.Methods.getLockdownWhitelistContexts">org.fedoraproject.FirewallD1.config.policies.Methods.getLockdownWhitelistContexts</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.policies.Methods.getLockdownWhitelistUids">
<term><methodname>getLockdownWhitelistUids</methodname>() → ai</term>
<listitem>
<para>
List all user ids (i) that are on whitelist.
For permanent operation see <link linkend="FirewallD1.config.policies.Methods.getLockdownWhitelistUids">org.fedoraproject.FirewallD1.config.policies.Methods.getLockdownWhitelistUids</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.policies.Methods.getLockdownWhitelistUsers">
<term><methodname>getLockdownWhitelistUsers</methodname>() → as</term>
<listitem>
<para>
List all users (s) that are on whitelist.
For permanent operation see <link linkend="FirewallD1.config.policies.Methods.getLockdownWhitelistUsers">org.fedoraproject.FirewallD1.config.policies.Methods.getLockdownWhitelistUsers</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.policies.Methods.queryLockdown">
<term><methodname>queryLockdown</methodname>() → b</term>
<listitem>
<para>
Query whether lockdown is enabled.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.policies.Methods.queryLockdownWhitelistCommand">
<term><methodname>queryLockdownWhitelistCommand</methodname>(s: command) → b</term>
<listitem>
<para>
Query whether <replaceable>command</replaceable> is on whitelist.
For permanent operation see <link linkend="FirewallD1.config.policies.Methods.queryLockdownWhitelistCommand">org.fedoraproject.FirewallD1.config.policies.Methods.queryLockdownWhitelistCommand</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.policies.Methods.queryLockdownWhitelistContext">
<term><methodname>queryLockdownWhitelistContext</methodname>(s: context) → b</term>
<listitem>
<para>
Query whether <replaceable>context</replaceable> is on whitelist.
For permanent operation see <link linkend="FirewallD1.config.policies.Methods.queryLockdownWhitelistContext">org.fedoraproject.FirewallD1.config.policies.Methods.queryLockdownWhitelistContext</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.policies.Methods.queryLockdownWhitelistUid">
<term><methodname>queryLockdownWhitelistUid</methodname>(i: uid) → b</term>
<listitem>
<para>
Query whether user id <replaceable>uid</replaceable> is on whitelist.
For permanent operation see <link linkend="FirewallD1.config.policies.Methods.queryLockdownWhitelistUid">org.fedoraproject.FirewallD1.config.policies.Methods.queryLockdownWhitelistUid</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.policies.Methods.queryLockdownWhitelistUser">
<term><methodname>queryLockdownWhitelistUser</methodname>(s: user) → b</term>
<listitem>
<para>
Query whether <replaceable>user</replaceable> is on whitelist.
For permanent operation see <link linkend="FirewallD1.config.policies.Methods.queryLockdownWhitelistUser">org.fedoraproject.FirewallD1.config.policies.Methods.queryLockdownWhitelistUser</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.policies.Methods.removeLockdownWhitelistCommand">
<term><methodname>removeLockdownWhitelistCommand</methodname>(s: command) → Nothing</term>
<listitem>
<para>
Remove <replaceable>command</replaceable> from whitelist.
For permanent operation see <link linkend="FirewallD1.config.policies.Methods.removeLockdownWhitelistCommand">org.fedoraproject.FirewallD1.config.policies.Methods.removeLockdownWhitelistCommand</link>.
</para>
<para>
Possible errors: NOT_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.policies.Methods.removeLockdownWhitelistContext">
<term><methodname>removeLockdownWhitelistContext</methodname>(s: context) → Nothing</term>
<listitem>
<para>
Remove <replaceable>context</replaceable> from whitelist.
For permanent operation see <link linkend="FirewallD1.config.policies.Methods.removeLockdownWhitelistContext">org.fedoraproject.FirewallD1.config.policies.Methods.removeLockdownWhitelistContext</link>.
</para>
<para>
Possible errors: NOT_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.policies.Methods.removeLockdownWhitelistUid">
<term><methodname>removeLockdownWhitelistUid</methodname>(i: uid) → Nothing</term>
<listitem>
<para>
Remove user id <replaceable>uid</replaceable> from whitelist.
For permanent operation see <link linkend="FirewallD1.config.policies.Methods.removeLockdownWhitelistUid">org.fedoraproject.FirewallD1.config.policies.Methods.removeLockdownWhitelistUid</link>.
</para>
<para>
Possible errors: NOT_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.policies.Methods.removeLockdownWhitelistUser">
<term><methodname>removeLockdownWhitelistUser</methodname>(s: user) → Nothing</term>
<listitem>
<para>
Remove <replaceable>user</replaceable> from whitelist.
For permanent operation see <link linkend="FirewallD1.config.policies.Methods.removeLockdownWhitelistUser">org.fedoraproject.FirewallD1.config.policies.Methods.removeLockdownWhitelistUser</link>.
</para>
<para>
Possible errors: NOT_ENABLED
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect3>
<refsect3 id="FirewallD1.policies.Signals">
<title>Signals</title>
<variablelist>
<varlistentry id="FirewallD1.policies.Signals.LockdownDisabled">
<term>LockdownDisabled()</term>
<listitem>
<para>
Emitted when lockdown has been disabled.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.policies.Signals.LockdownEnabled">
<term>LockdownEnabled()</term>
<listitem>
<para>
Emitted when lockdown has been enabled.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.policies.Signals.LockdownWhitelistCommandAdded">
<term>LockdownWhitelistCommandAdded(s: command)</term>
<listitem>
<para>
Emitted when <replaceable>command</replaceable> has been added to whitelist.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.policies.Signals.LockdownWhitelistCommandRemoved">
<term>LockdownWhitelistCommandRemoved(s: command)</term>
<listitem>
<para>
Emitted when <replaceable>command</replaceable> has been removed from whitelist.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.policies.Signals.LockdownWhitelistContextAdded">
<term>LockdownWhitelistContextAdded(s: context)</term>
<listitem>
<para>
Emitted when <replaceable>context</replaceable> has been added to whitelist.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.policies.Signals.LockdownWhitelistContextRemoved">
<term>LockdownWhitelistContextRemoved(s: context)</term>
<listitem>
<para>
Emitted when <replaceable>context</replaceable> has been removed from whitelist.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.policies.Signals.LockdownWhitelistUidAdded">
<term>LockdownWhitelistUidAdded(i: uid)</term>
<listitem>
<para>
Emitted when user id <replaceable>uid</replaceable> has been added to whitelist.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.policies.Signals.LockdownWhitelistUidRemoved">
<term>LockdownWhitelistUidRemoved(i: uid)</term>
<listitem>
<para>
Emitted when user id <replaceable>uid</replaceable> has been removed from whitelist.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.policies.Signals.LockdownWhitelistUserAdded">
<term>LockdownWhitelistUserAdded(s: user)</term>
<listitem>
<para>
Emitted when <replaceable>user</replaceable> has been added to whitelist.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.policies.Signals.LockdownWhitelistUserRemoved">
<term>LockdownWhitelistUserRemoved(s: user)</term>
<listitem>
<para>
Emitted when <replaceable>user</replaceable> has been removed from whitelist.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect3>
</refsect2>
<refsect2 id="FirewallD1.zone">
<title>org.fedoraproject.FirewallD1.zone</title>
<para>
Operations in this interface allows to get, add, remove and query runtime zone's settings.
For permanent settings see <link linkend="FirewallD1.config.zone">org.fedoraproject.FirewallD1.config.zone</link> interface.
</para>
<refsect3 id="FirewallD1.zone.Methods">
<title>Methods</title>
<variablelist>
<varlistentry id="FirewallD1.zone.Methods.addForwardPort">
<term><methodname>addForwardPort</methodname>(s: zone, s: port, s: protocol, s: toport, s: toaddr, i: timeout) → s</term>
<listitem>
<para>
Add the IPv4 forward port into <replaceable>zone</replaceable>.
If <replaceable>zone</replaceable> is empty, use default zone.
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.
If <replaceable>timeout</replaceable> is non-zero, the operation will be active only for the amount of seconds.
For permanent settings see <link linkend="FirewallD1.config.zone.Methods.addForwardPort">org.fedoraproject.FirewallD1.config.zone.Methods.addForwardPort</link>.
</para>
<para>
Returns name of zone to which the forward port was added.
</para>
<para>
Possible errors: INVALID_ZONE, INVALID_PORT, MISSING_PROTOCOL, INVALID_PROTOCOL, INVALID_ADDR, INVALID_FORWARD, ALREADY_ENABLED, INVALID_COMMAND
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.addIcmpBlock">
<term><methodname>addIcmpBlock</methodname>(s: zone, s: icmp, i: timeout) → s</term>
<listitem>
<para>
Add an ICMP block <replaceable>icmp</replaceable> into <replaceable>zone</replaceable>.
The <replaceable>icmp</replaceable> is the one of the icmp types firewalld supports.
To get a listing of supported icmp types use <link linkend="FirewallD1.Methods.listIcmpTypes">org.fedoraproject.FirewallD1.Methods.listIcmpTypes</link>
If <replaceable>zone</replaceable> is empty, use default zone.
If <replaceable>timeout</replaceable> is non-zero, the operation will be active only for the amount of seconds.
For permanent settings see <link linkend="FirewallD1.config.zone.Methods.addIcmpBlock">org.fedoraproject.FirewallD1.config.zone.Methods.addIcmpBlock</link>.
</para>
<para>
Returns name of zone to which the ICMP block was added.
</para>
<para>
Possible errors: INVALID_ZONE, INVALID_ICMPTYPE, ALREADY_ENABLED, INVALID_COMMAND
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.addIcmpBlockInversion">
<term><methodname>addIcmpBlockInversion</methodname>(s: zone) → s</term>
<listitem>
<para>
Add ICMP block inversion to <replaceable>zone</replaceable>.
If <replaceable>zone</replaceable> is empty, use default zone.
For permanent settings see <link linkend="FirewallD1.config.zone.Methods.addIcmpBlockInversion">org.fedoraproject.FirewallD1.config.zone.Methods.addIcmpBlockInversion</link>.
</para>
<para>
Returns name of zone to which the ICMP block inversion was added.
</para>
<para>
Possible errors: INVALID_ZONE, ALREADY_ENABLED, INVALID_COMMAND
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.addInterface">
<term><methodname>addInterface</methodname>(s: zone, s: interface) → s</term>
<listitem>
<para>
Bind <replaceable>interface</replaceable> with <replaceable>zone</replaceable>.
From now on all traffic going through the <replaceable>interface</replaceable> will respect the <replaceable>zone</replaceable>'s settings.
If <replaceable>zone</replaceable> is empty, use default zone.
For permanent settings see <link linkend="FirewallD1.config.zone.Methods.addInterface">org.fedoraproject.FirewallD1.config.zone.Methods.addInterface</link>.
</para>
<para>
Returns name of zone to which the interface was bound.
</para>
<para>
Possible errors: INVALID_ZONE, INVALID_INTERFACE, ALREADY_ENABLED, INVALID_COMMAND
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.addMasquerade">
<term><methodname>addMasquerade</methodname>(s: zone, i: timeout) → s</term>
<listitem>
<para>
Enable masquerade in <replaceable>zone</replaceable>.
If <replaceable>zone</replaceable> is empty, use default zone.
If <replaceable>timeout</replaceable> is non-zero, masquerading will be active for the amount of seconds.
For permanent settings see <link linkend="FirewallD1.config.zone.Methods.addMasquerade">org.fedoraproject.FirewallD1.config.zone.Methods.addMasquerade</link>.
</para>
<para>
Returns name of zone in which the masquerade was enabled.
</para>
<para>
Possible errors: INVALID_ZONE, ALREADY_ENABLED, INVALID_COMMAND
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.addPort">
<term><methodname>addPort</methodname>(s: zone, s: port, s: protocol, i: timeout) → s</term>
<listitem>
<para>
Add port into <replaceable>zone</replaceable>.
If <replaceable>zone</replaceable> is empty, use default zone.
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>.
If <replaceable>timeout</replaceable> is non-zero, the operation will be active only for the amount of seconds.
For permanent settings see <link linkend="FirewallD1.config.zone.Methods.addPort">org.fedoraproject.FirewallD1.config.zone.Methods.addPort</link>.
</para>
<para>
Returns name of zone to which the port was added.
</para>
<para>
Possible errors: INVALID_ZONE, INVALID_PORT, MISSING_PROTOCOL, INVALID_PROTOCOL, ALREADY_ENABLED, INVALID_COMMAND
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.addProtocol">
<term><methodname>addProtocol</methodname>(s: zone, s: protocol, i: timeout) → s</term>
<listitem>
<para>
Add protocol into <replaceable>zone</replaceable>.
If <replaceable>zone</replaceable> is empty, use default zone.
The protocol can be any protocol supported by the system. Please have a look at <filename>/etc/protocols</filename> for supported protocols.
If <replaceable>timeout</replaceable> is non-zero, the operation will be active only for the amount of seconds.
For permanent settings see <link linkend="FirewallD1.config.zone.Methods.addProtocol">org.fedoraproject.FirewallD1.config.zone.Methods.addProtocol</link>.
</para>
<para>
Returns name of zone to which the protocol was added.
</para>
<para>
Possible errors: INVALID_ZONE, INVALID_PROTOCOL, ALREADY_ENABLED, INVALID_COMMAND
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.addRichRule">
<term><methodname>addRichRule</methodname>(s: zone, s: rule, i: timeout) → s</term>
<listitem>
<para>
Add rich language <replaceable>rule</replaceable> into <replaceable>zone</replaceable>.
For the rich language rule syntax, please have a look at <citerefentry><refentrytitle>firewalld.direct</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
If <replaceable>zone</replaceable> is empty, use default zone.
If <replaceable>timeout</replaceable> is non-zero, the operation will be active only for the amount of seconds.
For permanent settings see <link linkend="FirewallD1.config.zone.Methods.addRichRule">org.fedoraproject.FirewallD1.config.zone.Methods.addRichRule</link>.
</para>
<para>
Returns name of zone to which the rich language rule was added.
</para>
<para>
Possible errors: INVALID_ZONE, INVALID_RULE, ALREADY_ENABLED, INVALID_COMMAND
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.addService">
<term><methodname>addService</methodname>(s: zone, s: service, i: timeout) → s</term>
<listitem>
<para>
Add <replaceable>service</replaceable> into <replaceable>zone</replaceable>.
If <replaceable>zone</replaceable> is empty, use default zone.
If <replaceable>timeout</replaceable> is non-zero, the operation will be active only for the amount of seconds.
To get a list of supported services, use <link linkend="FirewallD1.Methods.listServices">org.fedoraproject.FirewallD1.Methods.listServices</link>.
For permanent settings see <link linkend="FirewallD1.config.zone.Methods.addService">org.fedoraproject.FirewallD1.config.zone.Methods.addService</link>.
</para>
<para>
Returns name of zone to which the service was added.
</para>
<para>
Possible errors: INVALID_ZONE, INVALID_SERVICE, ALREADY_ENABLED, INVALID_COMMAND
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.addSource">
<term><methodname>addSource</methodname>(s: zone, s: source) → s</term>
<listitem>
<para>
Bind <replaceable>source</replaceable> with <replaceable>zone</replaceable>.
From now on all traffic going from this <replaceable>source</replaceable> will respect the <replaceable>zone</replaceable>'s settings.
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. Use of host names is not supported.
If <replaceable>zone</replaceable> is empty, use default zone.
For permanent settings see <link linkend="FirewallD1.config.zone.Methods.addSource">org.fedoraproject.FirewallD1.config.zone.Methods.addSource</link>.
</para>
<para>
Returns name of zone to which the source was bound.
</para>
<para>
Possible errors: INVALID_ZONE, INVALID_ADDR, ALREADY_ENABLED, INVALID_COMMAND
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.addSourcePort">
<term><methodname>addSourcePort</methodname>(s: zone, s: port, s: protocol, i: timeout) → s</term>
<listitem>
<para>
Add source port into <replaceable>zone</replaceable>.
If <replaceable>zone</replaceable> is empty, use default zone.
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>.
If <replaceable>timeout</replaceable> is non-zero, the operation will be active only for the amount of seconds.
For permanent settings see <link linkend="FirewallD1.config.zone.Methods.addSourcePort">org.fedoraproject.FirewallD1.config.zone.Methods.addSourcePort</link>.
</para>
<para>
Returns name of zone to which the port was added.
</para>
<para>
Possible errors: INVALID_ZONE, INVALID_PORT, MISSING_PROTOCOL, INVALID_PROTOCOL, ALREADY_ENABLED, INVALID_COMMAND
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.changeZone">
<term><methodname>changeZone</methodname>(s: zone, s: interface) → s</term>
<listitem>
<para>
This function is deprecated, use <link linkend="FirewallD1.zone.Methods.changeZoneOfInterface">org.fedoraproject.FirewallD1.zone.Methods.changeZoneOfInterface</link> instead.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.changeZoneOfInterface">
<term><methodname>changeZoneOfInterface</methodname>(s: zone, s: interface) → s</term>
<listitem>
<para>
Change a zone an <replaceable>interface</replaceable> is bound to to <replaceable>zone</replaceable>.
It's basically removeInterface(<replaceable>interface</replaceable>) followed by addInterface(<replaceable>zone</replaceable>, <replaceable>interface</replaceable>).
If <replaceable>interface</replaceable> has not been bound to a zone before, it behaves like <methodname>addInterface</methodname>.
If <replaceable>zone</replaceable> is empty, use default zone.
</para>
<para>
Returns name of zone to which the interface was bound.
</para>
<para>
Possible errors: INVALID_ZONE, ZONE_ALREADY_SET, ZONE_CONFLICT
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.changeZoneOfSource">
<term><methodname>changeZoneOfSource</methodname>(s: zone, s: source) → s</term>
<listitem>
<para>
Change a zone an <replaceable>source</replaceable> is bound to to <replaceable>zone</replaceable>.
It's basically removeSource(<replaceable>source</replaceable>) followed by addSource(<replaceable>zone</replaceable>, <replaceable>source</replaceable>).
If <replaceable>source</replaceable> has not been bound to a zone before, it behaves like <methodname>addSource</methodname>.
If <replaceable>zone</replaceable> is empty, use default zone.
</para>
<para>
Returns name of zone to which the source was bound.
</para>
<para>
Possible errors: INVALID_ZONE, ZONE_ALREADY_SET, ZONE_CONFLICT
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.getActiveZones">
<term><methodname>getActiveZones</methodname>() → a{sa{sas}}</term>
<listitem>
<para>
Return dictionary of 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.
</para>
<para>
Return value is a dictionary where keys are zone names (s) and values are again dictionaries where keys are either 'interfaces' or 'sources' and values are arrays of interface names (s) or sources (s).
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.getForwardPorts">
<term><methodname>getForwardPorts</methodname>(s: zone) → aas</term>
<listitem>
<para>
Return array of IPv4 forward ports previously added into <replaceable>zone</replaceable>.
If <replaceable>zone</replaceable> is empty, use default zone.
For getting permanent settings see <link linkend="FirewallD1.config.zone.Methods.getForwardPorts">org.fedoraproject.FirewallD1.config.zone.Methods.getForwardPorts</link>.
</para>
<para>
Return value is array of 4-tuples, where each 4-tuple consists of (port, protocol, to-port, to-addr). to-addr might be empty in case of local forwarding.
</para>
<para>
Possible errors: INVALID_ZONE
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.getIcmpBlocks">
<term><methodname>getIcmpBlocks</methodname>(s: zone) → as</term>
<listitem>
<para>
Return array of ICMP type (s) blocks previously added into <replaceable>zone</replaceable>.
If <replaceable>zone</replaceable> is empty, use default zone.
For getting permanent settings see <link linkend="FirewallD1.config.zone.Methods.getIcmpBlocks">org.fedoraproject.FirewallD1.config.zone.Methods.getIcmpBlocks</link>.
</para>
<para>
Possible errors: INVALID_ZONE
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.getIcmpBlockInversion">
<term><methodname>getIcmpBlockInversion</methodname>(s: zone) → b</term>
<listitem>
<para>
Return whether ICMP block inversion was previously added to <replaceable>zone</replaceable>.
If <replaceable>zone</replaceable> is empty, use default zone.
For getting permanent settings see <link linkend="FirewallD1.config.zone.Methods.getIcmpBlockInversion">org.fedoraproject.FirewallD1.config.zone.Methods.getIcmpBlockInversion</link>.
</para>
<para>
Possible errors: INVALID_ZONE
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.getInterfaces">
<term><methodname>getInterfaces</methodname>(s: zone) → as</term>
<listitem>
<para>
Return array of interfaces (s) previously bound with <replaceable>zone</replaceable>.
If <replaceable>zone</replaceable> is empty, use default zone.
For getting permanent settings see <link linkend="FirewallD1.config.zone.Methods.getInterfaces">org.fedoraproject.FirewallD1.config.zone.Methods.getInterfaces</link>.
</para>
<para>
Possible errors: INVALID_ZONE
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.getPorts">
<term><methodname>getPorts</methodname>(s: zone) → aas</term>
<listitem>
<para>
Return array of ports (2-tuple of port and protocol) previously enabled in <replaceable>zone</replaceable>.
If <replaceable>zone</replaceable> is empty, use default zone.
For getting permanent settings see <link linkend="FirewallD1.config.zone.Methods.getPorts">org.fedoraproject.FirewallD1.config.zone.Methods.getPorts</link>.
</para>
<para>
Possible errors: INVALID_ZONE
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.getProtocols">
<term><methodname>getProtocols</methodname>(s: zone) → as</term>
<listitem>
<para>
Return array of protocols (s) previously enabled in <replaceable>zone</replaceable>.
If <replaceable>zone</replaceable> is empty, use default zone.
For getting permanent settings see <link linkend="FirewallD1.config.zone.Methods.getProtocols">org.fedoraproject.FirewallD1.config.zone.Methods.getProtocols</link>.
</para>
<para>
Possible errors: INVALID_ZONE
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.getRichRules">
<term><methodname>getRichRules</methodname>(s: zone) → as</term>
<listitem>
<para>
Return array of rich language rules (s) previously added into <replaceable>zone</replaceable>.
If <replaceable>zone</replaceable> is empty, use default zone.
For getting permanent settings see <link linkend="FirewallD1.config.zone.Methods.getRichRules">org.fedoraproject.FirewallD1.config.zone.Methods.getRichRules</link>.
</para>
<para>
Possible errors: INVALID_ZONE
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.getServices">
<term><methodname>getServices</methodname>(s: zone) → as</term>
<listitem>
<para>
Return array of services (s) previously enabled in <replaceable>zone</replaceable>.
If <replaceable>zone</replaceable> is empty, use default zone.
For getting permanent settings see <link linkend="FirewallD1.config.zone.Methods.getServices">org.fedoraproject.FirewallD1.config.zone.Methods.getServices</link>.
</para>
<para>
Possible errors: INVALID_ZONE
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.getSourcePorts">
<term><methodname>getSourcePorts</methodname>(s: zone) → aas</term>
<listitem>
<para>
Return array of source ports (2-tuple of port and protocol) previously enabled in <replaceable>zone</replaceable>.
If <replaceable>zone</replaceable> is empty, use default zone.
For getting permanent settings see <link linkend="FirewallD1.config.zone.Methods.getSourcePorts">org.fedoraproject.FirewallD1.config.zone.Methods.getSourcePorts</link>.
</para>
<para>
Possible errors: INVALID_ZONE
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.getSources">
<term><methodname>getSources</methodname>(s: zone) → as</term>
<listitem>
<para>
Return array of sources (s) previously bound with <replaceable>zone</replaceable>.
If <replaceable>zone</replaceable> is empty, use default zone.
For getting permanent settings see <link linkend="FirewallD1.config.zone.Methods.getSources">org.fedoraproject.FirewallD1.config.zone.Methods.getSources</link>.
</para>
<para>
Possible errors: INVALID_ZONE
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.getZoneOfInterface">
<term><methodname>getZoneOfInterface</methodname>(s: interface) → s</term>
<listitem>
<para>
Return name (s) of zone the <replaceable>interface</replaceable> is bound to or empty string.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.getZoneOfSource">
<term><methodname>getZoneOfSource</methodname>(s: source) → s</term>
<listitem>
<para>
Return name (s) of zone the <replaceable>source</replaceable> is bound to or empty string.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.getZones">
<term><methodname>getZones</methodname>() → as</term>
<listitem>
<para>
Return array of names (s) of predefined zones known to current runtime environment.
For list of zones known to permanent environment see <link linkend="FirewallD1.config.Methods.listZones">org.fedoraproject.FirewallD1.config.Methods.listZones</link>.
The lists (of zones known to runtime and permanent environment) will contain same zones in most cases,
but might differ for example if <link linkend="FirewallD1.config.Methods.addZone">org.fedoraproject.FirewallD1.config.Methods.addZone</link> has been called recently, but firewalld has not been reloaded since then.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.isImmutable">
<term><methodname>isImmutable</methodname>(s: zone) → b</term>
<listitem>
<para>
Deprecated.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.queryForwardPort">
<term><methodname>queryForwardPort</methodname>(s: zone, s: port, s: protocol, s: toport, s: toaddr) → b</term>
<listitem>
<para>
Return whether the IPv4 forward port (<replaceable>port</replaceable>, <replaceable>protocol</replaceable>, <replaceable>toport</replaceable>, <replaceable>toaddr</replaceable>) has been added into <replaceable>zone</replaceable>.
If <replaceable>zone</replaceable> is empty, use default zone.
For permanent operation see <link linkend="FirewallD1.config.zone.Methods.queryForwardPort">org.fedoraproject.FirewallD1.config.zone.Methods.queryForwardPort</link>.
</para>
<para>
Possible errors: INVALID_ZONE, INVALID_PORT, MISSING_PROTOCOL, INVALID_PROTOCOL, INVALID_ADDR, INVALID_FORWARD
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.queryIcmpBlock">
<term><methodname>queryIcmpBlock</methodname>(s: zone, s: icmp) → b</term>
<listitem>
<para>
Return whether an ICMP block for <replaceable>icmp</replaceable> has been added into <replaceable>zone</replaceable>.
If <replaceable>zone</replaceable> is empty, use default zone.
For permanent operation see <link linkend="FirewallD1.config.zone.Methods.queryIcmpBlock">org.fedoraproject.FirewallD1.config.zone.Methods.queryIcmpBlock</link>.
</para>
<para>
Possible errors: INVALID_ZONE, INVALID_ICMPTYPE
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.queryIcmpBlockInversion">
<term><methodname>queryIcmpBlockInversion</methodname>(s: zone) → b</term>
<listitem>
<para>
Return whether ICMP block inversion has been added to <replaceable>zone</replaceable>.
If <replaceable>zone</replaceable> is empty, use default zone.
For permanent operation see <link linkend="FirewallD1.config.zone.Methods.queryIcmpBlockInversion">org.fedoraproject.FirewallD1.config.zone.Methods.queryIcmpBlockInversion</link>.
</para>
<para>
Possible errors: INVALID_ZONE, INVALID_ICMPTYPE
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.queryInterface">
<term><methodname>queryInterface</methodname>(s: zone, s: interface) → b</term>
<listitem>
<para>
Query whether <replaceable>interface</replaceable> has been bound to <replaceable>zone</replaceable>.
If <replaceable>zone</replaceable> is empty, use default zone.
For permanent operation see <link linkend="FirewallD1.config.zone.Methods.queryInterface">org.fedoraproject.FirewallD1.config.zone.Methods.queryInterface</link>.
</para>
<para>
Possible errors: INVALID_ZONE, INVALID_INTERFACE
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.queryMasquerade">
<term><methodname>queryMasquerade</methodname>(s: zone) → b</term>
<listitem>
<para>
Return whether masquerading has been enabled in <replaceable>zone</replaceable>
If <replaceable>zone</replaceable> is empty, use default zone.
For permanent operation see <link linkend="FirewallD1.config.zone.Methods.queryMasquerade">org.fedoraproject.FirewallD1.config.zone.Methods.queryMasquerade</link>.
</para>
<para>
Possible errors: INVALID_ZONE
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.queryPort">
<term><methodname>queryPort</methodname>(s: zone, s: port, s: protocol) → b</term>
<listitem>
<para>
Return whether <replaceable>port</replaceable>/<replaceable>protocol</replaceable> has been added in <replaceable>zone</replaceable>.
If <replaceable>zone</replaceable> is empty, use default zone.
For permanent operation see <link linkend="FirewallD1.config.zone.Methods.queryPort">org.fedoraproject.FirewallD1.config.zone.Methods.queryPort</link>.
</para>
<para>
Possible errors: INVALID_ZONE, INVALID_PORT, MISSING_PROTOCOL, INVALID_PROTOCOL
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.queryProtocol">
<term><methodname>queryProtocol</methodname>(s: zone, s: protocol) → b</term>
<listitem>
<para>
Return whether <replaceable>protocol</replaceable> has been added in <replaceable>zone</replaceable>.
If <replaceable>zone</replaceable> is empty, use default zone.
For permanent operation see <link linkend="FirewallD1.config.zone.Methods.queryProtocol">org.fedoraproject.FirewallD1.config.zone.Methods.queryProtocol</link>.
</para>
<para>
Possible errors: INVALID_ZONE, INVALID_PROTOCOL
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.queryRichRule">
<term><methodname>queryRichRule</methodname>(s: zone, s: rule) → b</term>
<listitem>
<para>
Return whether rich rule <replaceable>rule</replaceable> has been added in <replaceable>zone</replaceable>.
If <replaceable>zone</replaceable> is empty, use default zone.
For permanent operation see <link linkend="FirewallD1.config.zone.Methods.queryRichRule">org.fedoraproject.FirewallD1.config.zone.Methods.queryRichRule</link>.
</para>
<para>
Possible errors: INVALID_ZONE, INVALID_RULE
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.queryService">
<term><methodname>queryService</methodname>(s: zone, s: service) → b</term>
<listitem>
<para>
Return whether <replaceable>service</replaceable> has been added for <replaceable>zone</replaceable>.
If <replaceable>zone</replaceable> is empty, use default zone.
For permanent operation see <link linkend="FirewallD1.config.zone.Methods.queryService">org.fedoraproject.FirewallD1.config.zone.Methods.queryService</link>.
</para>
<para>
Possible errors: INVALID_ZONE, INVALID_SERVICE
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.querySource">
<term><methodname>querySource</methodname>(s: zone, s: source) → b</term>
<listitem>
<para>
Query whether <replaceable>source</replaceable>has been bound to <replaceable>zone</replaceable>.
If <replaceable>zone</replaceable> is empty, use default zone.
For permanent operation see <link linkend="FirewallD1.config.zone.Methods.querySource">org.fedoraproject.FirewallD1.config.zone.Methods.querySource</link>.
</para>
<para>
Possible errors: INVALID_ZONE, INVALID_ADDR
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.querySourcePort">
<term><methodname>querySourcePort</methodname>(s: zone, s: port, s: protocol) → b</term>
<listitem>
<para>
Return whether <replaceable>port</replaceable>/<replaceable>protocol</replaceable> has been added in <replaceable>zone</replaceable>.
If <replaceable>zone</replaceable> is empty, use default zone.
For permanent operation see <link linkend="FirewallD1.config.zone.Methods.querySourcePort">org.fedoraproject.FirewallD1.config.zone.Methods.querySourcePort</link>.
</para>
<para>
Possible errors: INVALID_ZONE, INVALID_PORT, MISSING_PROTOCOL, INVALID_PROTOCOL
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.removeForwardPort">
<term><methodname>removeForwardPort</methodname>(s: zone, s: port, s: protocol, s: toport, s: toaddr) → s</term>
<listitem>
<para>
Remove IPv4 forward port ((<replaceable>port</replaceable>, <replaceable>protocol</replaceable>, <replaceable>toport</replaceable>, <replaceable>toaddr</replaceable>)) from <replaceable>zone</replaceable>.
If <replaceable>zone</replaceable> is empty, use default zone.
For permanent operation see <link linkend="FirewallD1.config.zone.Methods.removeForwardPort">org.fedoraproject.FirewallD1.config.zone.Methods.removeForwardPort</link>.
</para>
<para>
Returns name of zone from which the forward port was removed.
</para>
<para>
Possible errors: INVALID_ZONE, INVALID_PORT, MISSING_PROTOCOL, INVALID_PROTOCOL, INVALID_ADDR, INVALID_FORWARD, NOT_ENABLED, INVALID_COMMAND
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.removeIcmpBlock">
<term><methodname>removeIcmpBlock</methodname>(s: zone, s: icmp) → s</term>
<listitem>
<para>
Remove ICMP block <replaceable>icmp</replaceable> from <replaceable>zone</replaceable>.
If <replaceable>zone</replaceable> is empty, use default zone.
For permanent operation see <link linkend="FirewallD1.config.zone.Methods.removeIcmpBlock">org.fedoraproject.FirewallD1.config.zone.Methods.removeIcmpBlock</link>.
</para>
<para>
Returns name of zone from which the ICMP block was removed.
</para>
<para>
Possible errors: INVALID_ZONE, INVALID_ICMPTYPE, NOT_ENABLED, INVALID_COMMAND
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.removeIcmpBlockInversion">
<term><methodname>removeIcmpBlockInversion</methodname>(s: zone) → s</term>
<listitem>
<para>
Remove ICMP block inversion from <replaceable>zone</replaceable>.
If <replaceable>zone</replaceable> is empty, use default zone.
For permanent operation see <link linkend="FirewallD1.config.zone.Methods.removeIcmpBlockInversion">org.fedoraproject.FirewallD1.config.zone.Methods.removeIcmpBlockInversion</link>.
</para>
<para>
Returns name of zone from which the ICMP block inversion was removed.
</para>
<para>
Possible errors: INVALID_ZONE, NOT_ENABLED, INVALID_COMMAND
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.removeInterface">
<term><methodname>removeInterface</methodname>(s: zone, s: interface) → s</term>
<listitem>
<para>
Remove binding of <replaceable>interface</replaceable> from <replaceable>zone</replaceable>.
If <replaceable>zone</replaceable> is empty, the interface will be removed from zone it belongs to.
For permanent operation see <link linkend="FirewallD1.config.zone.Methods.removeInterface">org.fedoraproject.FirewallD1.config.zone.Methods.removeInterface</link>.
</para>
<para>
Returns name of zone from which the <replaceable>interface</replaceable> was removed.
</para>
<para>
Possible errors: INVALID_ZONE, INVALID_INTERFACE, NOT_ENABLED, INVALID_COMMAND
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.removeMasquerade">
<term><methodname>removeMasquerade</methodname>(s: zone) → s</term>
<listitem>
<para>
Disable masquerade for <replaceable>zone</replaceable>.
If <replaceable>zone</replaceable> is empty, use default zone.
For permanent operation see <link linkend="FirewallD1.config.zone.Methods.removeMasquerade">org.fedoraproject.FirewallD1.config.zone.Methods.removeMasquerade</link>.
</para>
<para>
Returns name of zone for which the masquerade was disabled.
</para>
<para>
Possible errors: INVALID_ZONE, NOT_ENABLED, INVALID_COMMAND
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.removePort">
<term><methodname>removePort</methodname>(s: zone, s: port, s: protocol) → s</term>
<listitem>
<para>
Remove <replaceable>port</replaceable>/<replaceable>protocol</replaceable> from <replaceable>zone</replaceable>.
If <replaceable>zone</replaceable> is empty, use default zone.
For permanent operation see <link linkend="FirewallD1.config.zone.Methods.removePort">org.fedoraproject.FirewallD1.config.zone.Methods.removePort</link>.
</para>
<para>
Returns name of zone from which the port was removed.
</para>
<para>
Possible errors: INVALID_ZONE, INVALID_PORT, MISSING_PROTOCOL, INVALID_PROTOCOL, NOT_ENABLED, INVALID_COMMAND
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.removeProtocol">
<term><methodname>removeProtocol</methodname>(s: zone, s: protocol) → s</term>
<listitem>
<para>
Remove protocol from <replaceable>zone</replaceable>.
If <replaceable>zone</replaceable> is empty, use default zone.
For permanent operation see <link linkend="FirewallD1.config.zone.Methods.removeProtocol">org.fedoraproject.FirewallD1.config.zone.Methods.removeProtocol</link>.
</para>
<para>
Returns name of zone from which the protocol was removed.
</para>
<para>
Possible errors: INVALID_ZONE, INVALID_PROTOCOL, NOT_ENABLED, INVALID_COMMAND
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.removeRichRule">
<term><methodname>removeRichRule</methodname>(s: zone, s: rule) → s</term>
<listitem>
<para>
Remove rich language <replaceable>rule</replaceable> from <replaceable>zone</replaceable>.
If <replaceable>zone</replaceable> is empty, use default zone.
For permanent operation see <link linkend="FirewallD1.config.zone.Methods.removeRichRule">org.fedoraproject.FirewallD1.config.zone.Methods.removeRichRule</link>.
</para>
<para>
Returns name of zone from which the rich language rule was removed.
</para>
<para>
Possible errors: INVALID_ZONE, INVALID_RULE, NOT_ENABLED, INVALID_COMMAND
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.removeService">
<term><methodname>removeService</methodname>(s: zone, s: service) → s</term>
<listitem>
<para>
Remove <replaceable>service</replaceable> from <replaceable>zone</replaceable>.
If <replaceable>zone</replaceable> is empty, use default zone.
For permanent operation see <link linkend="FirewallD1.config.zone.Methods.removeService">org.fedoraproject.FirewallD1.config.zone.Methods.removeService</link>.
</para>
<para>
Returns name of zone from which the service was removed.
</para>
<para>
Possible errors: INVALID_ZONE, INVALID_SERVICE, NOT_ENABLED, INVALID_COMMAND
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.removeSource">
<term><methodname>removeSource</methodname>(s: zone, s: source) → s</term>
<listitem>
<para>
Remove binding of <replaceable>source</replaceable> from <replaceable>zone</replaceable>.
If <replaceable>zone</replaceable> is empty, the source will be removed from zone it belongs to.
For permanent operation see <link linkend="FirewallD1.config.zone.Methods.removeSource">org.fedoraproject.FirewallD1.config.zone.Methods.removeSource</link>.
</para>
<para>
Returns name of zone from which the <replaceable>source</replaceable> was removed.
</para>
<para>
Possible errors: INVALID_ZONE, INVALID_ADDR, NOT_ENABLED, INVALID_COMMAND
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Methods.removeSourcePort">
<term><methodname>removeSourcePort</methodname>(s: zone, s: port, s: protocol) → s</term>
<listitem>
<para>
Remove <replaceable>port</replaceable>/<replaceable>protocol</replaceable> from <replaceable>zone</replaceable>.
If <replaceable>zone</replaceable> is empty, use default zone.
For permanent operation see <link linkend="FirewallD1.config.zone.Methods.removeSourcePort">org.fedoraproject.FirewallD1.config.zone.Methods.removeSourcePort</link>.
</para>
<para>
Returns name of zone from which the source port was removed.
</para>
<para>
Possible errors: INVALID_ZONE, INVALID_PORT, MISSING_PROTOCOL, INVALID_PROTOCOL, NOT_ENABLED, INVALID_COMMAND
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect3>
<refsect3 id="FirewallD1.zone.Signals">
<title>Signals</title>
<variablelist>
<varlistentry id="FirewallD1.zone.Signals.ForwardPortAdded">
<term>ForwardPortAdded(s: zone, s: port, s: protocol, s: toport, s: toaddr, i: timeout)</term>
<listitem>
<para>
Emitted when forward port has been added to <replaceable>zone</replaceable> with <replaceable>timeout</replaceable>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Signals.ForwardPortRemoved">
<term>ForwardPortRemoved(s: zone, s: port, s: protocol, s: toport, s: toaddr)</term>
<listitem>
<para>
Emitted when forward port has been removed from <replaceable>zone</replaceable>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Signals.IcmpBlockAdded">
<term>IcmpBlockAdded(s: zone, s: icmp, i: timeout)</term>
<listitem>
<para>
Emitted when ICMP block for <replaceable>icmp</replaceable> has been added to <replaceable>zone</replaceable> with <replaceable>timeout</replaceable>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Signals.IcmpBlockInversionAdded">
<term>IcmpBlockInversionAdded(s: zone)</term>
<listitem>
<para>
Emitted when ICMP block inversion has been added to <replaceable>zone</replaceable>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Signals.IcmpBlockInversionRemoved">
<term>IcmpBlockInversionRemoved(s: zone)</term>
<listitem>
<para>
Emitted when ICMP block inversion has been removed from <replaceable>zone</replaceable>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Signals.IcmpBlockRemoved">
<term>IcmpBlockRemoved(s: zone, s: icmp)</term>
<listitem>
<para>
Emitted when ICMP block for <replaceable>icmp</replaceable> has been removed from <replaceable>zone</replaceable>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Signals.InterfaceAdded">
<term>InterfaceAdded(s: zone, s: interface)</term>
<listitem>
<para>
Emitted when <replaceable>interface</replaceable> has been added to <replaceable>zone</replaceable>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Signals.InterfaceRemoved">
<term>InterfaceRemoved(s: zone, s: interface)</term>
<listitem>
<para>
Emitted when <replaceable>interface</replaceable> has been removed from <replaceable>zone</replaceable>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Signals.MasqueradeAdded">
<term>MasqueradeAdded(s: zone, i: timeout)</term>
<listitem>
<para>
Emitted when masquerade has been enabled for <replaceable>zone</replaceable>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Signals.MasqueradeRemoved">
<term>MasqueradeRemoved(s: zone)</term>
<listitem>
<para>
Emitted when masquerade has been disabled for <replaceable>zone</replaceable>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Signals.PortAdded">
<term>PortAdded(s: zone, s: port, s: protocol, i: timeout)</term>
<listitem>
<para>
Emitted when <replaceable>port</replaceable>/<replaceable>protocol</replaceable> has been added to <replaceable>zone</replaceable> with <replaceable>timeout</replaceable>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Signals.PortRemoved">
<term>PortRemoved(s: zone, s: port, s: protocol)</term>
<listitem>
<para>
Emitted when <replaceable>port</replaceable>/<replaceable>protocol</replaceable> has been removed from <replaceable>zone</replaceable>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Signals.ProtocolAdded">
<term>ProtocolAdded(s: zone, s: protocol, i: timeout)</term>
<listitem>
<para>
Emitted when <replaceable>protocol</replaceable> has been added to <replaceable>zone</replaceable> with <replaceable>timeout</replaceable>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Signals.ProtocolRemoved">
<term>ProtocolRemoved(s: zone, s: protocol)</term>
<listitem>
<para>
Emitted when <replaceable>protocol</replaceable> has been removed from <replaceable>zone</replaceable>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Signals.RichRuleAdded">
<term>RichRuleAdded(s: zone, s: rule, i: timeout)</term>
<listitem>
<para>
Emitted when rich language <replaceable>rule</replaceable> has been added to <replaceable>zone</replaceable> with <replaceable>timeout</replaceable>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Signals.RichRuleRemoved">
<term>RichRuleRemoved(s: zone, s: rule)</term>
<listitem>
<para>
Emitted when rich language <replaceable>rule</replaceable> has been removed from <replaceable>zone</replaceable>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Signals.ServiceAdded">
<term>ServiceAdded(s: zone, s: service, i: timeout)</term>
<listitem>
<para>
Emitted when <replaceable>service</replaceable> has been added to <replaceable>zone</replaceable> with <replaceable>timeout</replaceable>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Signals.ServiceRemoved">
<term>ServiceRemoved(s: zone, s: service)</term>
<listitem>
<para>
Emitted when <replaceable>service</replaceable> has been removed from <replaceable>zone</replaceable>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Signals.SourceAdded">
<term>SourceAdded(s: zone, s: source)</term>
<listitem>
<para>
Emitted when <replaceable>source</replaceable> has been added to <replaceable>zone</replaceable>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Signals.SourcePortAdded">
<term>SourcePortAdded(s: zone, s: port, s: protocol, i: timeout)</term>
<listitem>
<para>
Emitted when <replaceable>source-port</replaceable>/<replaceable>protocol</replaceable> has been added to <replaceable>zone</replaceable> with <replaceable>timeout</replaceable>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Signals.SourcePortRemoved">
<term>SourcePortRemoved(s: zone, s: port, s: protocol)</term>
<listitem>
<para>
Emitted when <replaceable>source-port</replaceable>/<replaceable>protocol</replaceable> has been removed from <replaceable>zone</replaceable>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Signals.SourceRemoved">
<term>SourceRemoved(s: zone, s: source)</term>
<listitem>
<para>
Emitted when <replaceable>source</replaceable> has been removed from <replaceable>zone</replaceable>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Signals.ZoneChanged">
<term>ZoneChanged(s: zone, s: interface)</term>
<listitem>
<para>
Deprecated
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Signals.ZoneOfInterfaceChanged">
<term>ZoneOfInterfaceChanged(s: zone, s: interface)</term>
<listitem>
<para>
Emitted when a zone an <replaceable>interface</replaceable> is part of has been changed to <replaceable>zone</replaceable>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.zone.Signals.ZoneOfSourceChanged">
<term>ZoneOfSourceChanged(s: zone, s: source)</term>
<listitem>
<para>
Emitted when a zone an <replaceable>source</replaceable> is part of has been changed to <replaceable>zone</replaceable>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect3>
</refsect2>
<refsect2 id="FirewallD1.config">
<title>org.fedoraproject.FirewallD1.config</title>
<para>
Allows to permanently add, remove and query zones, services and icmp types.
</para>
<refsect3 id="FirewallD1.config.Methods">
<title>Methods</title>
<variablelist>
<varlistentry id="FirewallD1.config.Methods.addIPSet">
<term><methodname>addIPSet</methodname>(s: ipset, (ssssa{ss}as): settings) → o</term>
<listitem>
<para>
Add <replaceable>ipset</replaceable> with given <replaceable>settings</replaceable> into permanent configuration.
Settings are in format: <parameter>version</parameter>, <parameter>name</parameter>, <parameter>description</parameter>, <parameter>type</parameter>, dictionary of <parameter>options</parameter> and array of <parameter>entries</parameter>.
</para>
<para>
<variablelist>
<varlistentry><term><parameter>version (s)</parameter>: see <literal>version</literal> attribute of <literal>ipset</literal> tag in <citerefentry><refentrytitle>firewalld.ipset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>name (s)</parameter>: see <literal>short</literal> tag in <citerefentry><refentrytitle>firewalld.ipset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>description (s)</parameter>: see <literal>description</literal> tag in <citerefentry><refentrytitle>firewalld.ipset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>type (s)</parameter>: see <literal>type</literal> attribute of <literal>ipset</literal> tag in <citerefentry><refentrytitle>firewalld.ipset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>options (a{ss})</parameter>: dictionary of {option : value} . See <literal>options</literal> tag in <citerefentry><refentrytitle>firewalld.ipset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>entries (as)</parameter>: array of entries, see <literal>entry</literal> tag in <citerefentry><refentrytitle>firewalld.ipset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
</variablelist>
</para>
<para>
Possible errors: NAME_CONFLICT, INVALID_NAME, INVALID_TYPE
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.Methods.addIcmpType">
<term><methodname>addIcmpType</methodname>(s: icmptype, (sssas): settings) → o</term>
<listitem>
<para>
Add <replaceable>icmptype</replaceable> with given <replaceable>settings</replaceable> into permanent configuration.
Settings are in format: <parameter>version</parameter>, <parameter>name</parameter>, <parameter>description</parameter>, array of <parameter>destinations</parameter>.
Returns object path of the new icmp type.
</para>
<para>
<variablelist>
<varlistentry><term><parameter>version (s)</parameter>: see <literal>version</literal> attribute of <literal>icmptype</literal> tag in <citerefentry><refentrytitle>firewalld.icmptype</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>name (s)</parameter>: see <literal>short</literal> tag in <citerefentry><refentrytitle>firewalld.icmptype</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>description (s)</parameter>: see <literal>description</literal> tag in <citerefentry><refentrytitle>firewalld.icmptype</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>destinations (as)</parameter>: array, either empty or containing strings 'ipv4' or 'ipv6', see <literal>destination</literal> tag in <citerefentry><refentrytitle>firewalld.icmptype</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
</variablelist>
</para>
<para>
Possible errors: NAME_CONFLICT, INVALID_NAME, INVALID_TYPE
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.Methods.addService">
<annotation name="org.freedesktop.DBus.Deprecated" />
<term><methodname>addService</methodname>(s: service, (sssa(ss)asa{ss}asa(ss)): settings) → o</term>
<listitem>
<para>
This function is deprecated, use <link linkend="FirewallD1.config.Methods.addService2">org.fedoraproject.FirewallD1.config.Methods.addService2</link> instead.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.Methods.addService2">
<term><methodname>addService2</methodname>s: service, a{sv}: settings) → o</term>
<listitem>
<para>
Add <replaceable>service</replaceable> with given <replaceable>settings</replaceable> into permanent configuration.
Settings are a dictionary indexed by keywords. For the type of each value see below. To zero a value pass an empty string or list.
</para>
<para>
<variablelist>
<varlistentry><term><parameter>version (s)</parameter>: see <literal>version</literal> attribute of <literal>service</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>name (s)</parameter>: see <literal>short</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>description (s)</parameter>: see <literal>description</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>ports (a(ss))</parameter>: array of port and protocol pairs. See <literal>port</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>module names (as)</parameter>: array of kernel netfilter helpers, see <literal>module</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>destinations (a{ss})</parameter>: dictionary of {IP family : IP address} where 'IP family' key can be either 'ipv4' or 'ipv6'. See <literal>destination</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>protocols (as)</parameter>: array of protocols, see <literal>protocol</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>source_ports (a(ss))</parameter>: array of port and protocol pairs. See <literal>source-port</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>includes (as)</parameter>: array of service includes, see <literal>include</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>helpers (as)</parameter>: array of service helpers, see <literal>helper</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
</variablelist>
</para>
<para>
Possible errors: NAME_CONFLICT, INVALID_NAME, INVALID_TYPE
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.Methods.addZone">
<term><methodname>addZone</methodname>(s: zone, (sssbsasa(ss)asba(ssss)asasasasa(ss)b): settings) → o</term>
<listitem>
<para>
Add <replaceable>zone</replaceable> with given <replaceable>settings</replaceable> into permanent configuration.
Settings are in format: <parameter>version</parameter>, <parameter>name</parameter>, <parameter>description</parameter>, <parameter>UNUSED</parameter>, <parameter>target</parameter>, array of <parameter>services</parameter>, array of <parameter>ports</parameter> (port, protocol), array of <parameter>icmp-blocks</parameter>, <parameter>masquerade</parameter>, array of <parameter>forward-ports</parameter> (port, protocol, to-port, to-addr), array of <parameter>interfaces</parameter>, array of <parameter>sources</parameter>, array of <parameter>rich rules</parameter>, array of <parameter>protocols</parameter> and array of <parameter>source-ports</parameter> (port, protocol).
</para>
<para>
<variablelist>
<varlistentry><term><parameter>version (s)</parameter>: see <literal>version</literal> attribute of <literal>zone</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>name (s)</parameter>: see <literal>short</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>description (s)</parameter>: see <literal>description</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>UNUSED (b)</parameter>: this boolean value is no longer used for anything.</term></varlistentry>
<varlistentry><term><parameter>target (s)</parameter>: see <literal>target</literal> attribute of <literal>zone</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>services (as)</parameter>: array of service names, see <literal>service</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>ports (a(ss))</parameter>: array of port and protocol pairs. See <literal>port</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>icmp-blocks (as)</parameter>: array of icmp-blocks. See <literal>icmp-block</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>masquerade (b)</parameter>: see <literal>masquerade</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>forward-ports (a(ssss))</parameter>: array of (port, protocol, to-port, to-addr). See <literal>forward-port</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>interfaces (as)</parameter>: array of interfaces. See <literal>interface</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>source addresses (as)</parameter>: array of source addresses. See <literal>source</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>rich rules (as)</parameter>: array of rich-language rules. See <literal>rule</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>protocols (as)</parameter>: array of protocols. See <literal>protocol</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>source-ports (a(ss))</parameter>: array of port and protocol pairs. See <literal>source-port</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
</variablelist>
</para>
<para>
Possible errors: NAME_CONFLICT, INVALID_NAME, INVALID_TYPE
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.Methods.getHelperByName">
<term><methodname>getHelperByName</methodname>(s: helper) → o</term>
<listitem>
<para>
Return object path (permanent configuration) of <replaceable>helper</replaceable> with given name.
</para>
<para>
Possible errors: INVALID_HELPER
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.Methods.getHelperNames">
<term><methodname>getHelperNames</methodname>() → as</term>
<listitem>
<para>
Return list of <replaceable>helper</replaceable> names (permanent configuration).
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.Methods.getIPSetByName">
<term><methodname>getIPSetByName</methodname>(s: ipset) → o</term>
<listitem>
<para>
Return object path (permanent configuration) of <replaceable>ipset</replaceable> with given name.
</para>
<para>
Possible errors: INVALID_IPSET
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.Methods.getIPSetNames">
<term><methodname>getIPSetNames</methodname>() → as</term>
<listitem>
<para>
Return list of <replaceable>ipset</replaceable> names (permanent configuration).
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.Methods.getIcmpTypeByName">
<term><methodname>getIcmpTypeByName</methodname>(s: icmptype) → o</term>
<listitem>
<para>
Return object path (permanent configuration) of <replaceable>icmptype</replaceable> with given name.
</para>
<para>
Possible errors: INVALID_ICMPTYPE
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.Methods.getIcmpTypeNames">
<term><methodname>getIcmpTypeNames</methodname>() → as</term>
<listitem>
<para>
Return list of <replaceable>icmptype</replaceable> names (permanent configuration).
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.Methods.getServiceByName">
<term><methodname>getServiceByName</methodname>(s: service) → o</term>
<listitem>
<para>
Return object path (permanent configuration) of <replaceable>service</replaceable> with given name.
</para>
<para>
Possible errors: INVALID_SERVICE
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.Methods.getServiceNames">
<term><methodname>getServiceNames</methodname>() → as</term>
<listitem>
<para>
Return list of <replaceable>service</replaceable> names (permanent configuration).
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.Methods.getZoneByName">
<term><methodname>getZoneByName</methodname>(s: zone) → o</term>
<listitem>
<para>
Return object path (permanent configuration) of <replaceable>zone</replaceable> with given name.
</para>
<para>
Possible errors: INVALID_ZONE
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.Methods.getZoneNames">
<term><methodname>getZoneNames</methodname>() → as</term>
<listitem>
<para>
Return list of <replaceable>zone</replaceable> names (permanent configuration) of.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.Methods.getZoneOfInterface">
<term><methodname>getZoneOfInterface</methodname>(s: iface) → s</term>
<listitem>
<para>
Return name of zone the <replaceable>iface</replaceable> is bound to or empty string.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.Methods.getZoneOfSource">
<term><methodname>getZoneOfSource</methodname>(s: source) → s</term>
<listitem>
<para>
Return name of zone the <replaceable>source</replaceable> is bound to or empty string.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.Methods.listHelpers">
<term><methodname>listHelpers</methodname>() → ao</term>
<listitem>
<para>
Return array of object paths (o) of <link linkend="FirewallD1.config.helper">helper</link> in permanent configuration.
For runtime configuration see <link linkend="FirewallD1.Methods.getHelpers">org.fedoraproject.FirewallD1.Methods.getHelpers</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.Methods.listIPSets">
<term><methodname>listIPSets</methodname>() → ao</term>
<listitem>
<para>
Return array of object paths (o) of <link linkend="FirewallD1.config.ipset">ipset</link> in permanent configuration.
For runtime configuration see <link linkend="FirewallD1.ipset.Methods.getIPSets">org.fedoraproject.FirewallD1.ipset.Methods.getIPSets</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.Methods.listIcmpTypes">
<term><methodname>listIcmpTypes</methodname>() → ao</term>
<listitem>
<para>
Return array of object paths (o) of <link linkend="FirewallD1.config.icmptype">icmp types</link> in permanent configuration.
For runtime configuration see <link linkend="FirewallD1.Methods.listIcmpTypes">org.fedoraproject.FirewallD1.Methods.listIcmpTypes</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.Methods.listServices">
<term><methodname>listServices</methodname>() → ao</term>
<listitem>
<para>
Return array of objects paths (o) of <link linkend="FirewallD1.config.service">services</link> in permanent configuration.
For runtime configuration see <link linkend="FirewallD1.Methods.listServices">org.fedoraproject.FirewallD1.Methods.listServices</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.Methods.listZones">
<term><methodname>listZones</methodname>() → ao</term>
<listitem>
<para>
List object paths of zones known to permanent environment.
For list of zones known to runtime environment see <link linkend="FirewallD1.zone.Methods.getZones">org.fedoraproject.FirewallD1.zone.Methods.getZones</link>.
The lists (of zones known to runtime and permanent environment) will contain same zones in most cases,
but might differ for example if <link linkend="FirewallD1.config.Methods.addZone">org.fedoraproject.FirewallD1.config.Methods.addZone</link> has been called recently, but firewalld has not been reloaded since then.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect3>
<refsect3 id="FirewallD1.config.Signals">
<title>Signals</title>
<variablelist>
<varlistentry id="FirewallD1.config.Signals.HelperAdded">
<term>HelperAdded(s: helper)</term>
<listitem>
<para>
Emitted when <replaceable>helper</replaceable> has been added.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.Signals.IPSetAdded">
<term>IPSetAdded(s: ipset)</term>
<listitem>
<para>
Emitted when <replaceable>ipset</replaceable> has been added.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.Signals.IcmpTypeAdded">
<term>IcmpTypeAdded(s: icmptype)</term>
<listitem>
<para>
Emitted when <replaceable>icmptype</replaceable> has been added.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.Signals.ServiceAdded">
<term>ServiceAdded(s: service)</term>
<listitem>
<para>
Emitted when <replaceable>service</replaceable> has been added.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.Signals.ZoneAdded">
<term>ZoneAdded(s: zone)</term>
<listitem>
<para>
Emitted when <replaceable>zone</replaceable> has been added.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect3>
<refsect3 id="FirewallD1.config.Properties">
<title>Properties</title>
<variablelist>
<varlistentry id="FirewallD1.config.Properties.AllowZoneDrifting">
<term><parameter>AllowZoneDrifting</parameter> - s - (rw)</term>
<listitem><para>
Older versions of firewalld had undocumented behavior known
as "zone drifting". This allowed packets to ingress multiple
zones - this is a violation of zone based firewalls. However,
some users rely on this behavior to have a "catch-all" zone,
e.g. the default zone. You can enable this if you desire such
behavior. It's disabled by default for security reasons.
Note: If "yes" packets will only drift from source based zones
to interface based zones (including the default zone). Packets
never drift from interface based zones to other interfaces
based zones (including the default zone).
Valid values; "yes", "no". Defaults to "yes".
</para></listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.Properties.AutomaticHelpers">
<term>AutomaticHelpers - s - (rw)</term>
<listitem>
<para>
Deprecated. Getting this value always returns "no". Setting this value is ignored.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.Properties.CleanupOnExit">
<term>CleanupOnExit - s - (rw)</term>
<listitem>
<para>
If firewalld stops, it cleans up all firewall rules. Setting this option to no or false leaves the current firewall rules untouched.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.Properties.DefaultZone">
<term>DefaultZone - s - (ro)</term>
<listitem>
<para>
Default zone for connections or interfaces if the zone is not selected or specified by NetworkManager, initscripts or command line tool.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.Properties.FirewallBackend">
<term>FirewallBackend - s - (rw)</term>
<listitem>
<para>
Selects the firewalld backend for all rules except the direct
interface. Valid options are; nftables, iptables. Default in
nftables.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.Properties.FlushAllOnReload">
<term>FirewallBackend - s - (rw)</term>
<listitem>
<para>
Flush all runtime rules on a reload. Valid options are; yes, no.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.Properties.IPv6_rpfilter">
<term><parameter>IPv6_rpfilter</parameter> - s - (rw)</term>
<listitem><para>Indicates whether the reverse path filter test on a packet for IPv6 is enabled. If a reply to the packet would be sent via the same interface that the packet arrived on, the packet will match and be accepted, otherwise dropped.</para></listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.Properties.IndividualCalls">
<term><parameter>IndividualCalls</parameter> - s - (ro)</term>
<listitem><para>Indicates whether individual calls combined -restore calls are used. If enabled, this increases the time that is needed to apply changes and to start the daemon, but is good for debugging.
</para></listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.Properties.Lockdown">
<term>Lockdown - s - (rw)</term>
<listitem>
<para>
If this property is enabled, firewall changes with the D-Bus interface will be limited to applications that are listed in the lockdown whitelist.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.Properties.LogDenied">
<term>LogDenied - s - (rw)</term>
<listitem>
<para>
If LogDenied is enabled, then logging rules are added 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.
Possible values are: <literal>all</literal>, <literal>unicast</literal>, <literal>broadcast</literal>, <literal>multicast</literal> and <literal>off</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.Properties.MinimalMark">
<term>MinimalMark - i - (rw)</term>
<listitem>
<para>
Deprecated. This option is ignored and no longer used. Marks are no longer used internally.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.Properties.RFC3964_IPv4">
<term>FirewallBackend - s - (rw)</term>
<listitem>
<para>
As per RFC 3964, filter IPv6 traffic with 6to4 destination
addresses that correspond to IPv4 addresses that should not be
routed over the public internet. Valid options are; yes, no.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect3>
</refsect2>
<refsect2 id="FirewallD1.config.direct">
<title>org.fedoraproject.FirewallD1.config.direct</title>
<para>
Interface for permanent direct configuration, see also <citerefentry><refentrytitle>firewalld.direct</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime direct configuration see <link linkend="FirewallD1.direct">org.fedoraproject.FirewallD1.direct</link> interface.
</para>
<refsect3 id="FirewallD1.config.direct.Methods">
<title>Methods</title>
<variablelist>
<varlistentry id="FirewallD1.config.direct.Methods.addChain">
<term><methodname>addChain</methodname>(s: ipv, s: table, s: chain) → Nothing</term>
<listitem>
<para>
Add a new <replaceable>chain</replaceable> to <replaceable>table</replaceable> for <replaceable>ipv</replaceable> being either <literal>ipv4</literal> (iptables) or <literal>ipv6</literal> (ip6tables) or <literal>eb</literal> (ebtables).
Make sure there's no other chain with this name already.
There already exist basic chains to use with direct methods, for example <literal>INPUT_direct</literal> chain.
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.
For runtime operation see <link linkend="FirewallD1.direct.Methods.addChain">org.fedoraproject.FirewallD1.direct.Methods.addChain</link>.
</para>
<para>
Possible errors: INVALID_IPV, INVALID_TABLE, ALREADY_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.direct.Methods.addPassthrough">
<term><methodname>addPassthrough</methodname>(s: ipv, as: args) → Nothing</term>
<listitem>
<para>
Add a passthrough rule with the arguments <replaceable>args</replaceable> for <replaceable>ipv</replaceable> being either <literal>ipv4</literal> (iptables) or <literal>ipv6</literal> (ip6tables) or <literal>eb</literal> (ebtables).
For runtime operation see <link linkend="FirewallD1.direct.Methods.addPassthrough">org.fedoraproject.FirewallD1.direct.Methods.addPassthrough</link>.
</para>
<para>
Possible errors: INVALID_IPV, ALREADY_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.direct.Methods.addRule">
<term><methodname>addRule</methodname>(s: ipv, s: table, s: chain, i: priority, as: args) → Nothing</term>
<listitem>
<para>
Add a rule with the arguments <replaceable>args</replaceable> to <replaceable>chain</replaceable> in <replaceable>table</replaceable> with <replaceable>priority</replaceable> for <replaceable>ipv</replaceable> being either <literal>ipv4</literal> (iptables) or <literal>ipv6</literal> (ip6tables) or <literal>eb</literal> (ebtables).
The priority 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.
For runtime operation see <link linkend="FirewallD1.direct.Methods.addRule">org.fedoraproject.FirewallD1.direct.Methods.addRule</link>.
</para>
<para>
Possible errors: INVALID_IPV, INVALID_TABLE, ALREADY_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.direct.Methods.getAllChains">
<term><methodname>getAllChains</methodname>() → a(sss)</term>
<listitem>
<para>
Get all chains added to all tables in format: ipv, table, chain.
This concerns only chains previously added with <methodname>addChain</methodname>.
Return value is a array of (<parameter>ipv</parameter>, <parameter>table</parameter>, <parameter>chain</parameter>).
For runtime operation see <link linkend="FirewallD1.direct.Methods.getAllChains">org.fedoraproject.FirewallD1.direct.Methods.getAllChains</link>.
</para>
<para>
<variablelist>
<varlistentry><term><parameter>ipv (s)</parameter>: either <literal>ipv4</literal> (iptables) or <literal>ipv6</literal> (ip6tables) or <literal>eb</literal> (ebtables).</term></varlistentry>
<varlistentry><term><parameter>table (s)</parameter>: one of <literal>filter</literal>, <literal>mangle</literal>, <literal>nat</literal>, <literal>raw</literal>, <literal>security</literal></term></varlistentry>
<varlistentry><term><parameter>chain (s)</parameter>: name of a chain.</term></varlistentry>
</variablelist>
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.direct.Methods.getAllPassthroughs">
<term><methodname>getAllPassthroughs</methodname>() → a(sas)</term>
<listitem>
<para>
Get all passthrough rules added in all ipv types in format: ipv, rule.
This concerns only rules previously added with <methodname>addPassthrough</methodname>.
Return value is a array of (<parameter>ipv</parameter>, array of <parameter>arguments</parameter>).
For runtime operation see <link linkend="FirewallD1.direct.Methods.getAllPassthroughs">org.fedoraproject.FirewallD1.direct.Methods.getAllPassthroughs</link>.
</para>
<para>
<variablelist>
<varlistentry><term><parameter>ipv (s)</parameter>: either <literal>ipv4</literal> (iptables) or <literal>ipv6</literal> (ip6tables) or <literal>eb</literal> (ebtables).</term></varlistentry>
<varlistentry><term><parameter>arguments (as)</parameter>: array of commands, parameters and other iptables/ip6tables/ebtables command line options.</term></varlistentry>
</variablelist>
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.direct.Methods.getAllRules">
<term><methodname>getAllRules</methodname>() → a(sssias)</term>
<listitem>
<para>
Get all rules added to all chains in all tables in format: ipv, table, chain, priority, rule.
This concerns only rules previously added with <methodname>addRule</methodname>.
Return value is a array of (<parameter>ipv</parameter>, <parameter>table</parameter>, <parameter>chain</parameter>, <parameter>priority</parameter>, array of <parameter>arguments</parameter>).
For runtime operation see <link linkend="FirewallD1.direct.Methods.getAllRules">org.fedoraproject.FirewallD1.direct.Methods.getAllRules</link>.
</para>
<para>
<variablelist>
<varlistentry><term><parameter>ipv (s)</parameter>: either <literal>ipv4</literal> (iptables) or <literal>ipv6</literal> (ip6tables) or <literal>eb</literal> (ebtables).</term></varlistentry>
<varlistentry><term><parameter>table (s)</parameter>: one of <literal>filter</literal>, <literal>mangle</literal>, <literal>nat</literal>, <literal>raw</literal>, <literal>security</literal></term></varlistentry>
<varlistentry><term><parameter>chain (s)</parameter>: name of a chain.</term></varlistentry>
<varlistentry><term><parameter>priority (i)</parameter>: used to order rules.</term></varlistentry>
<varlistentry><term><parameter>arguments (as)</parameter>: array of commands, parameters and other iptables/ip6tables/ebtables command line options.</term></varlistentry>
</variablelist>
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.direct.Methods.getChains">
<term><methodname>getChains</methodname>(s: ipv, s: table) → as</term>
<listitem>
<para>
Return an array of chains (s) added to <replaceable>table</replaceable> for <replaceable>ipv</replaceable> being either <literal>ipv4</literal> (iptables) or <literal>ipv6</literal> (ip6tables) or <literal>eb</literal> (ebtables).
This concerns only chains previously added with <methodname>addChain</methodname>.
For runtime operation see <link linkend="FirewallD1.direct.Methods.getChains">org.fedoraproject.FirewallD1.direct.Methods.getChains</link>.
</para>
<para>
Possible errors: INVALID_IPV, INVALID_TABLE
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.direct.Methods.getPassthroughs">
<term><methodname>getPassthroughs</methodname>(s: ipv) → aas</term>
<listitem>
<para>
Get tracked passthrough rules added in either <literal>ipv4</literal> (iptables) or <literal>ipv6</literal> (ip6tables) or <literal>eb</literal> (ebtables).
This concerns only rules previously added with <methodname>addPassthrough</methodname>.
Return value is a array of (array of <parameter>arguments</parameter>).
For runtime operation see <link linkend="FirewallD1.direct.Methods.getPassthroughs">org.fedoraproject.FirewallD1.direct.Methods.getPassthroughs</link>.
</para>
<para>
<variablelist>
<varlistentry><term><parameter>arguments (as)</parameter>: array of commands, parameters and other iptables/ip6tables/ebtables command line options.</term></varlistentry>
</variablelist>
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.direct.Methods.getRules">
<term><methodname>getRules</methodname>(s: ipv, s: table, s: chain) → a(ias)</term>
<listitem>
<para>
Get all rules added to <replaceable>chain</replaceable> in <replaceable>table</replaceable> for <replaceable>ipv</replaceable> being either <literal>ipv4</literal> (iptables) or <literal>ipv6</literal> (ip6tables) or <literal>eb</literal> (ebtables).
This concerns only rules previously added with <methodname>addRule</methodname>.
Return value is a array of (<parameter>priority</parameter>, array of <parameter>arguments</parameter>).
For runtime operation see <link linkend="FirewallD1.direct.Methods.getRules">org.fedoraproject.FirewallD1.direct.Methods.getRules</link>.
</para>
<para>
<variablelist>
<varlistentry><term><parameter>priority (i)</parameter>: used to order rules.</term></varlistentry>
<varlistentry><term><parameter>arguments (as)</parameter>: array of commands, parameters and other iptables/ip6tables/ebtables command line options.</term></varlistentry>
</variablelist>
</para>
<para>
Possible errors: INVALID_IPV, INVALID_TABLE
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.direct.Methods.getSettings">
<term><methodname>getSettings</methodname>() → (a(sss)a(sssias)a(sas))</term>
<listitem>
<para>
Get settings of permanent direct configuration in format: array of <parameter>chains</parameter>, array of <parameter>rules</parameter>, array of <parameter>passthroughs</parameter>.
</para>
<para>
<variablelist>
<varlistentry><term><parameter>chains (a(sss))</parameter>: array of (<parameter>ipv</parameter>, <parameter>table</parameter>, <parameter>chain</parameter>), see 'chain' in <citerefentry><refentrytitle>firewalld.direct</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>.
<varlistentry><term><parameter>rules (a(sssias))</parameter>: array of (<parameter>ipv</parameter>, <parameter>table</parameter>, <parameter>chain</parameter>, <parameter>priority</parameter>, array of <parameter>arguments</parameter>), see 'rule' in <citerefentry><refentrytitle>firewalld.direct</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>.
<varlistentry><term><parameter>passthroughs (a(sas))</parameter>: array of (<parameter>ipv</parameter>, array of <parameter>arguments</parameter>), see passthrough in <citerefentry><refentrytitle>firewalld.direct</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>.
</variablelist>
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.direct.Methods.queryChain">
<term><methodname>queryChain</methodname>(s: ipv, s: table, s: chain) → b</term>
<listitem>
<para>
Return whether a <replaceable>chain</replaceable> exists in <replaceable>table</replaceable> for <replaceable>ipv</replaceable> being either <literal>ipv4</literal> (iptables) or <literal>ipv6</literal> (ip6tables) or <literal>eb</literal> (ebtables).
This concerns only chains previously added with <methodname>addChain</methodname>.
For runtime operation see <link linkend="FirewallD1.direct.Methods.queryChain">org.fedoraproject.FirewallD1.direct.Methods.queryChain</link>.
</para>
<para>
Possible errors: INVALID_IPV, INVALID_TABLE
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.direct.Methods.queryPassthrough">
<term><methodname>queryPassthrough</methodname>(s: ipv, as: args) → b</term>
<listitem>
<para>
Return whether a tracked passthrough rule with the arguments <replaceable>args</replaceable> exists for <replaceable>ipv</replaceable> being either <literal>ipv4</literal> (iptables) or <literal>ipv6</literal> (ip6tables) or <literal>eb</literal> (ebtables).
This concerns only rules previously added with <methodname>addPassthrough</methodname>.
For runtime operation see <link linkend="FirewallD1.direct.Methods.queryPassthrough">org.fedoraproject.FirewallD1.direct.Methods.queryPassthrough</link>.
</para>
<para>
Possible errors: INVALID_IPV
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.direct.Methods.queryRule">
<term><methodname>queryRule</methodname>(s: ipv, s: table, s: chain, i: priority, as: args) → b</term>
<listitem>
<para>
Return whether a rule with <replaceable>priority</replaceable> and the arguments <replaceable>args</replaceable> exists in <replaceable>chain</replaceable> in <replaceable>table</replaceable> for <replaceable>ipv</replaceable> being either <literal>ipv4</literal> (iptables) or <literal>ipv6</literal> (ip6tables) or <literal>eb</literal> (ebtables).
This concerns only rules previously added with <methodname>addRule</methodname>.
For runtime operation see <link linkend="FirewallD1.direct.Methods.queryRule">org.fedoraproject.FirewallD1.direct.Methods.queryRule</link>.
</para>
<para>
Possible errors: INVALID_IPV, INVALID_TABLE
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.direct.Methods.removeChain">
<term><methodname>removeChain</methodname>(s: ipv, s: table, s: chain) → Nothing</term>
<listitem>
<para>
Remove a <replaceable>chain</replaceable> from <replaceable>table</replaceable> for <replaceable>ipv</replaceable> being either <literal>ipv4</literal> (iptables) or <literal>ipv6</literal> (ip6tables) or <literal>eb</literal> (ebtables).
Only chains previously added with <methodname>addChain</methodname> can be removed this way.
For runtime operation see <link linkend="FirewallD1.direct.Methods.removeChain">org.fedoraproject.FirewallD1.direct.Methods.removeChain</link>.
</para>
<para>
Possible errors: INVALID_IPV, INVALID_TABLE, NOT_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.direct.Methods.removePassthrough">
<term><methodname>removePassthrough</methodname>(s: ipv, as: args) → Nothing</term>
<listitem>
<para>
Remove a passthrough rule with arguments <replaceable>args</replaceable> for <replaceable>ipv</replaceable> being either <literal>ipv4</literal> (iptables) or <literal>ipv6</literal> (ip6tables) or <literal>eb</literal> (ebtables).
Only rules previously added with <methodname>addPassthrough</methodname> can be removed this way.
For runtime operation see <link linkend="FirewallD1.direct.Methods.removePassthrough">org.fedoraproject.FirewallD1.direct.Methods.removePassthrough</link>.
</para>
<para>
Possible errors: INVALID_IPV, NOT_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.direct.Methods.removeRule">
<term><methodname>removeRule</methodname>(s: ipv, s: table, s: chain, i: priority, as: args) → Nothing</term>
<listitem>
<para>
Remove a rule with <replaceable>priority</replaceable> and arguments <replaceable>args</replaceable> from <replaceable>chain</replaceable> in <replaceable>table</replaceable> for <replaceable>ipv</replaceable> being either <literal>ipv4</literal> (iptables) or <literal>ipv6</literal> (ip6tables) or <literal>eb</literal> (ebtables).
Only rules previously added with <methodname>addRule</methodname> can be removed this way.
For runtime operation see <link linkend="FirewallD1.direct.Methods.removeRule">org.fedoraproject.FirewallD1.direct.Methods.removeRule</link>.
</para>
<para>
Possible errors: INVALID_IPV, INVALID_TABLE, NOT_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.direct.Methods.removeRules">
<term><methodname>removeRules</methodname>(s: ipv, s: table, s: chain) → Nothing</term>
<listitem>
<para>
Remove all rules from <replaceable>chain</replaceable> in <replaceable>table</replaceable> for <replaceable>ipv</replaceable> being either <literal>ipv4</literal> (iptables) or <literal>ipv6</literal> (ip6tables) or <literal>eb</literal> (ebtables).
This concerns only rules previously added with <methodname>addRule</methodname>.
For runtime operation see <link linkend="FirewallD1.direct.Methods.removeRules">org.fedoraproject.FirewallD1.direct.Methods.removeRules</link>.
</para>
<para>
Possible errors: INVALID_IPV, INVALID_TABLE
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.direct.Methods.update">
<term><methodname>update</methodname>((a(sss)a(sssias)a(sas)): settings) → Nothing</term>
<listitem>
<para>
Update permanent direct configuration with given <replaceable>settings</replaceable>.
Settings are in format: array of <parameter>chains</parameter>, array of <parameter>rules</parameter>, array of <parameter>passthroughs</parameter>.
</para>
<para>
<variablelist>
<varlistentry><term><parameter>chains (a(sss))</parameter>: array of (<parameter>ipv</parameter>, <parameter>table</parameter>, <parameter>chain</parameter>), see 'chain' in <citerefentry><refentrytitle>firewalld.direct</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>.
<varlistentry><term><parameter>rules (a(sssias))</parameter>: array of (<parameter>ipv</parameter>, <parameter>table</parameter>, <parameter>chain</parameter>, <parameter>priority</parameter>, array of <parameter>arguments</parameter>), see 'rule' in <citerefentry><refentrytitle>firewalld.direct</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>.
<varlistentry><term><parameter>passthroughs (a(sas))</parameter>: array of (<parameter>ipv</parameter>, array of <parameter>arguments</parameter>), see passthrough in <citerefentry><refentrytitle>firewalld.direct</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>.
</variablelist>
</para>
<para>
Possible errors: INVALID_TYPE
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect3>
<refsect3 id="FirewallD1.config.direct.Signals">
<title>Signals</title>
<variablelist>
<varlistentry id="FirewallD1.config.direct.Signals.Updated">
<term>Updated()</term>
<listitem>
<para>
Emitted when configuration has been updated.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect3>
</refsect2>
<refsect2 id="FirewallD1.config.policies">
<title>org.fedoraproject.FirewallD1.config.policies</title>
<para>
Interface for permanent lockdown-whitelist configuration, see also <citerefentry><refentrytitle>firewalld.lockdown-whitelist</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime configuration see <link linkend="FirewallD1.policies">org.fedoraproject.FirewallD1.policies</link> interface.
</para>
<refsect3 id="FirewallD1.config.policies.Methods">
<title>Methods</title>
<variablelist>
<varlistentry id="FirewallD1.config.policies.Methods.addLockdownWhitelistCommand">
<term><methodname>addLockdownWhitelistCommand</methodname>(s: command) → Nothing</term>
<listitem>
<para>
Add <replaceable>command</replaceable> to whitelist.
See <literal>command</literal> option in <citerefentry><refentrytitle>firewalld.lockdown-whitelist</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime operation see <link linkend="FirewallD1.policies.Methods.addLockdownWhitelistCommand">org.fedoraproject.FirewallD1.policies.Methods.addLockdownWhitelistCommand</link>.
</para>
<para>
Possible errors: ALREADY_ENABLED, INVALID_TYPE
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.policies.Methods.addLockdownWhitelistContext">
<term><methodname>addLockdownWhitelistContext</methodname>(s: context) → Nothing</term>
<listitem>
<para>
Add <replaceable>context</replaceable> to whitelist.
See <literal>selinux</literal> option in <citerefentry><refentrytitle>firewalld.lockdown-whitelist</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime operation see <link linkend="FirewallD1.policies.Methods.addLockdownWhitelistContext">org.fedoraproject.FirewallD1.policies.Methods.addLockdownWhitelistContext</link>.
</para>
<para>
Possible errors: ALREADY_ENABLED, INVALID_TYPE
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.policies.Methods.addLockdownWhitelistUid">
<term><methodname>addLockdownWhitelistUid</methodname>(i: uid) → Nothing</term>
<listitem>
<para>
Add user id <replaceable>uid</replaceable> to whitelist.
See <literal>user</literal> option in <citerefentry><refentrytitle>firewalld.lockdown-whitelist</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime operation see <link linkend="FirewallD1.policies.Methods.addLockdownWhitelistUid">org.fedoraproject.FirewallD1.policies.Methods.addLockdownWhitelistUid</link>.
</para>
<para>
Possible errors: ALREADY_ENABLED, INVALID_TYPE
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.policies.Methods.addLockdownWhitelistUser">
<term><methodname>addLockdownWhitelistUser</methodname>(s: user) → Nothing</term>
<listitem>
<para>
Add <replaceable>user</replaceable> name to whitelist.
See <literal>user</literal> option in <citerefentry><refentrytitle>firewalld.lockdown-whitelist</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime operation see <link linkend="FirewallD1.policies.Methods.addLockdownWhitelistUser">org.fedoraproject.FirewallD1.policies.Methods.addLockdownWhitelistUser</link>.
</para>
<para>
Possible errors: ALREADY_ENABLED, INVALID_TYPE
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.policies.Methods.getLockdownWhitelist">
<term><methodname>getLockdownWhitelist</methodname>() → (asasasai)</term>
<listitem>
<para>
Get settings of permanent lockdown-whitelist configuration in format: <parameter>commands</parameter>, <parameter>selinux contexts</parameter>, <parameter>users</parameter>, <parameter>uids</parameter>
</para>
<para>
<variablelist>
<varlistentry><term><parameter>commands (as)</parameter>: see <literal>command</literal> option in <citerefentry><refentrytitle>firewalld.lockdown-whitelist</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>selinux contexts (as)</parameter>: see <literal>selinux</literal> option in <citerefentry><refentrytitle>firewalld.lockdown-whitelist</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>users (as)</parameter>: see <literal>name</literal> attribute of <literal>user</literal> option in <citerefentry><refentrytitle>firewalld.lockdown-whitelist</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>uids (ai)</parameter>: see <literal>id</literal> attribute of <literal>user</literal> option in <citerefentry><refentrytitle>firewalld.lockdown-whitelist</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
</variablelist>
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.policies.Methods.getLockdownWhitelistCommands">
<term><methodname>getLockdownWhitelistCommands</methodname>() → as</term>
<listitem>
<para>
List all command lines (s) that are on whitelist.
For runtime operation see <link linkend="FirewallD1.policies.Methods.getLockdownWhitelistCommands">org.fedoraproject.FirewallD1.policies.Methods.getLockdownWhitelistCommands</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.policies.Methods.getLockdownWhitelistContexts">
<term><methodname>getLockdownWhitelistContexts</methodname>() → as</term>
<listitem>
<para>
List all contexts (s) that are on whitelist.
For runtime operation see <link linkend="FirewallD1.policies.Methods.getLockdownWhitelistContexts">org.fedoraproject.FirewallD1.policies.Methods.getLockdownWhitelistContexts</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.policies.Methods.getLockdownWhitelistUids">
<term><methodname>getLockdownWhitelistUids</methodname>() → ai</term>
<listitem>
<para>
List all user ids (i) that are on whitelist.
For runtime operation see <link linkend="FirewallD1.policies.Methods.getLockdownWhitelistUids">org.fedoraproject.FirewallD1.policies.Methods.getLockdownWhitelistUids</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.policies.Methods.getLockdownWhitelistUsers">
<term><methodname>getLockdownWhitelistUsers</methodname>() → as</term>
<listitem>
<para>
List all users (s) that are on whitelist.
For runtime operation see <link linkend="FirewallD1.policies.Methods.getLockdownWhitelistUsers">org.fedoraproject.FirewallD1.policies.Methods.getLockdownWhitelistUsers</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.policies.Methods.queryLockdownWhitelistCommand">
<term><methodname>queryLockdownWhitelistCommand</methodname>(s: command) → b</term>
<listitem>
<para>
Query whether <replaceable>command</replaceable> is on whitelist.
For runtime operation see <link linkend="FirewallD1.policies.Methods.queryLockdownWhitelistCommand">org.fedoraproject.FirewallD1.policies.Methods.queryLockdownWhitelistCommand</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.policies.Methods.queryLockdownWhitelistContext">
<term><methodname>queryLockdownWhitelistContext</methodname>(s: context) → b</term>
<listitem>
<para>
Query whether <replaceable>context</replaceable> is on whitelist.
For runtime operation see <link linkend="FirewallD1.policies.Methods.queryLockdownWhitelistContext">org.fedoraproject.FirewallD1.policies.Methods.queryLockdownWhitelistContext</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.policies.Methods.queryLockdownWhitelistUid">
<term><methodname>queryLockdownWhitelistUid</methodname>(i: uid) → b</term>
<listitem>
<para>
Query whether user id <replaceable>uid</replaceable> is on whitelist.
For runtime operation see <link linkend="FirewallD1.policies.Methods.queryLockdownWhitelistUid">org.fedoraproject.FirewallD1.policies.Methods.queryLockdownWhitelistUid</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.policies.Methods.queryLockdownWhitelistUser">
<term><methodname>queryLockdownWhitelistUser</methodname>(s: user) → b</term>
<listitem>
<para>
Query whether <replaceable>user</replaceable> is on whitelist.
For runtime operation see <link linkend="FirewallD1.policies.Methods.queryLockdownWhitelistUser">org.fedoraproject.FirewallD1.policies.Methods.queryLockdownWhitelistUser</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.policies.Methods.removeLockdownWhitelistCommand">
<term><methodname>removeLockdownWhitelistCommand</methodname>(s: command) → Nothing</term>
<listitem>
<para>
Remove <replaceable>command</replaceable> from whitelist.
For runtime operation see <link linkend="FirewallD1.policies.Methods.removeLockdownWhitelistCommand">org.fedoraproject.FirewallD1.policies.Methods.removeLockdownWhitelistCommand</link>.
</para>
<para>
Possible errors: NOT_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.policies.Methods.removeLockdownWhitelistContext">
<term><methodname>removeLockdownWhitelistContext</methodname>(s: context) → Nothing</term>
<listitem>
<para>
Remove <replaceable>context</replaceable> from whitelist.
For runtime operation see <link linkend="FirewallD1.policies.Methods.removeLockdownWhitelistContext">org.fedoraproject.FirewallD1.policies.Methods.removeLockdownWhitelistContext</link>.
</para>
<para>
Possible errors: NOT_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.policies.Methods.removeLockdownWhitelistUid">
<term><methodname>removeLockdownWhitelistUid</methodname>(i: uid) → Nothing</term>
<listitem>
<para>
Remove user id <replaceable>uid</replaceable> from whitelist.
For runtime operation see <link linkend="FirewallD1.policies.Methods.removeLockdownWhitelistUid">org.fedoraproject.FirewallD1.policies.Methods.removeLockdownWhitelistUid</link>.
</para>
<para>
Possible errors: NOT_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.policies.Methods.removeLockdownWhitelistUser">
<term><methodname>removeLockdownWhitelistUser</methodname>(s: user) → Nothing</term>
<listitem>
<para>
Remove <replaceable>user</replaceable> from whitelist.
For runtime operation see <link linkend="FirewallD1.policies.Methods.removeLockdownWhitelistUser">org.fedoraproject.FirewallD1.policies.Methods.removeLockdownWhitelistUser</link>.
</para>
<para>
Possible errors: NOT_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.policies.Methods.setLockdownWhitelist">
<term><methodname>setLockdownWhitelist</methodname>((asasasai): settings) → Nothing</term>
<listitem>
<para>
Set permanent lockdown-whitelist configuration to <replaceable>settings</replaceable>.
Settings are in format: <parameter>commands</parameter>, <parameter>selinux contexts</parameter>, <parameter>users</parameter>, <parameter>uids</parameter>
</para>
<para>
<variablelist>
<varlistentry><term><parameter>commands (as)</parameter>: see <literal>command</literal> option in <citerefentry><refentrytitle>firewalld.lockdown-whitelist</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>selinux contexts (as)</parameter>: see <literal>selinux</literal> option in <citerefentry><refentrytitle>firewalld.lockdown-whitelist</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>users (as)</parameter>: see <literal>name</literal> attribute of <literal>user</literal> option in <citerefentry><refentrytitle>firewalld.lockdown-whitelist</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>uids (ai)</parameter>: see <literal>id</literal> attribute of <literal>user</literal> option in <citerefentry><refentrytitle>firewalld.lockdown-whitelist</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
</variablelist>
</para>
<para>
Possible errors: INVALID_TYPE
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect3>
<refsect3 id="FirewallD1.config.policies.Signals">
<title>Signals</title>
<variablelist>
<varlistentry id="FirewallD1.config.policies.Signals.LockdownWhitelistUpdated">
<term>LockdownWhitelistUpdated()</term>
<listitem>
<para>
Emitted when permanent lockdown-whitelist configuration has been updated.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect3>
</refsect2>
<refsect2 id="FirewallD1.config.ipset">
<title>org.fedoraproject.FirewallD1.config.ipset</title>
<para>
Interface for permanent ipset configuration, see also <citerefentry><refentrytitle>firewalld.ipset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
<refsect3 id="FirewallD1.config.ipset.Methods">
<title>Methods</title>
<variablelist>
<varlistentry id="FirewallD1.config.ipset.Methods.addEntry">
<term><methodname>addEntry</methodname>(s: entry) → Nothing</term>
<listitem>
<para>
Permanently add <replaceable>entry</replaceable> to list of entries of ipset.
See <literal>entry</literal> tag in <citerefentry><refentrytitle>firewalld.ipset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime operation see <link linkend="FirewallD1.ipset.Methods.addEntry">org.fedoraproject.FirewallD1.ipset.Methods.addEntry</link>.
</para>
<para>
Possible errors: ALREADY_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.ipset.Methods.addOption">
<term><methodname>addOption</methodname>(s: key, s: value) → Nothing</term>
<listitem>
<para>
Permanently add (<replaceable>key</replaceable>, <replaceable>value</replaceable>) to the ipset.
See <literal>option</literal> tag in <citerefentry><refentrytitle>firewalld.ipset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
<para>
Possible errors: ALREADY_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.ipset.Methods.getDescription">
<term><methodname>getDescription</methodname>() → s</term>
<listitem>
<para>
Get description of ipset.
See <literal>description</literal> tag in <citerefentry><refentrytitle>firewalld.ipset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.ipset.Methods.getEntries">
<term><methodname>getEntries</methodname>() → as</term>
<listitem>
<para>
Get list of entries added to ipset.
See <literal>entry</literal> tag in <citerefentry><refentrytitle>firewalld.ipset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime operation see <link linkend="FirewallD1.ipset.Methods.getEntries">org.fedoraproject.FirewallD1.ipset.Methods.getEntries</link>.
</para>
<para>
Possible errors: IPSET_WITH_TIMEOUT
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.ipset.Methods.getOptions">
<term><methodname>getOptions</methodname>() → a{ss}</term>
<listitem>
<para>
Get dictionary of <parameter>options</parameter> set for ipset.
See <literal>option</literal> tag in <citerefentry><refentrytitle>firewalld.ipset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.ipset.Methods.getSettings">
<term><methodname>getSettings</methodname>() → (ssssa{ss}as)</term>
<listitem>
<para>
Return permament settings of the ipset.
For getting runtime settings see <link linkend="FirewallD1.ipset.Methods.getIPSetSettings">org.fedoraproject.FirewallD1.ipset.Methods.getIPSetSettings</link>.
Settings are in format: <parameter>version</parameter>, <parameter>name</parameter>, <parameter>description</parameter>, <parameter>type</parameter>, dictionary of <parameter>options</parameter> and array of <parameter>entries</parameter>.
</para>
<para>
<variablelist>
<varlistentry><term><parameter>version (s)</parameter>: see <literal>version</literal> attribute of <literal>ipset</literal> tag in <citerefentry><refentrytitle>firewalld.ipset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>name (s)</parameter>: see <literal>short</literal> tag in <citerefentry><refentrytitle>firewalld.ipset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>description (s)</parameter>: see <literal>description</literal> tag in <citerefentry><refentrytitle>firewalld.ipset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>type (s)</parameter>: see <literal>type</literal> attribute of <literal>ipset</literal> tag in <citerefentry><refentrytitle>firewalld.ipset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>options (a{ss})</parameter>: dictionary of {option : value} . See <literal>options</literal> tag in <citerefentry><refentrytitle>firewalld.ipset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>entries (as)</parameter>: array of entries, see <literal>entry</literal> tag in <citerefentry><refentrytitle>firewalld.ipset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
</variablelist>
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.ipset.Methods.getShort">
<term><methodname>getShort</methodname>() → s</term>
<listitem>
<para>
Get name of ipset.
See <literal>short</literal> tag in <citerefentry><refentrytitle>firewalld.ipset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.ipset.Methods.getType">
<term><methodname>getType</methodname>() → s</term>
<listitem>
<para>
Get type of ipset.
See <literal>type</literal> attribute of <literal>ipset</literal> tag in <citerefentry><refentrytitle>firewalld.ipset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.ipset.Methods.getVersion">
<term><methodname>getVersion</methodname>() → s</term>
<listitem>
<para>
Get version of ipset.
See <literal>version</literal> attribute of <literal>ipset</literal> tag in <citerefentry><refentrytitle>firewalld.ipset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.ipset.Methods.loadDefaults">
<term><methodname>loadDefaults</methodname>() → Nothing</term>
<listitem>
<para>
Load default settings for built-in ipset.
</para>
<para>
Possible errors: NO_DEFAULTS
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.ipset.Methods.queryEntry">
<term><methodname>queryEntry</methodname>(s: entry) → b</term>
<listitem>
<para>
Return whether <replaceable>entry</replaceable> has been added to <replaceable>ipset</replaceable>.
For runtime operation see <link linkend="FirewallD1.ipset.Methods.queryEntry">org.fedoraproject.FirewallD1.ipset.Methods.queryEntry</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.ipset.Methods.queryOption">
<term><methodname>queryOption</methodname>(s: key, s: value) → b</term>
<listitem>
<para>
Return whether (<replaceable>key</replaceable>, <replaceable>value</replaceable>) has been added to options of the <replaceable>ipset</replaceable>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.ipset.Methods.remove">
<term><methodname>remove</methodname>() → Nothing</term>
<listitem>
<para>
Remove not built-in ipset.
</para>
<para>
Possible errors: BUILTIN_IPSET
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.ipset.Methods.removeEntry">
<term><methodname>removeEntry</methodname>(s: entry) → Nothing</term>
<listitem>
<para>
Permanently remove <replaceable>entry</replaceable> from ipset.
See <literal>entry</literal> tag in <citerefentry><refentrytitle>firewalld.ipset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime operation see <link linkend="FirewallD1.ipset.Methods.removeEntry">org.fedoraproject.FirewallD1.ipset.Methods.removeEntry</link>.
</para>
<para>
Possible errors: NOT_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.ipset.Methods.removeOption">
<term><methodname>removeOption</methodname>(s: key) → Nothing</term>
<listitem>
<para>
Permanently remove <replaceable>key</replaceable> from the ipset.
See <literal>option</literal> tag in <citerefentry><refentrytitle>firewalld.ipset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
<para>
Possible errors: NOT_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.ipset.Methods.rename">
<term><methodname>rename</methodname>(s: name) → Nothing</term>
<listitem>
<para>
Rename not built-in ipset to <replaceable>name</replaceable>.
</para>
<para>
Possible errors: BUILTIN_IPSET
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.ipset.Methods.setDescription">
<term><methodname>setDescription</methodname>(s: description) → Nothing</term>
<listitem>
<para>
Permanently set description of ipset to <replaceable>description</replaceable>.
See <literal>description</literal> tag in <citerefentry><refentrytitle>firewalld.ipset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.ipset.Methods.setEntries">
<term><methodname>setEntries</methodname>(as: entries) → Nothing</term>
<listitem>
<para>
Permanently set list of entries to <replaceable>entries</replaceable>.
See <literal>entry</literal> tag in <citerefentry><refentrytitle>firewalld.ipset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.ipset.Methods.setOptions">
<term><methodname>setOptions</methodname>(a{ss}: options) → Nothing</term>
<listitem>
<para>
Permanently set dict of options to <replaceable>options</replaceable>.
See <literal>option</literal> tag in <citerefentry><refentrytitle>firewalld.ipset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.ipset.Methods.setShort">
<term><methodname>setShort</methodname>(s: short) → Nothing</term>
<listitem>
<para>
Permanently set name of ipset to <replaceable>short</replaceable>.
See <literal>short</literal> tag in <citerefentry><refentrytitle>firewalld.ipset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.ipset.Methods.setType">
<term><methodname>setType</methodname>(s: ipset_type) → Nothing</term>
<listitem>
<para>
Permanently set type of ipset to <replaceable>ipset_type</replaceable>.
See <literal>type</literal> attribute of <literal>ipset</literal> tag in <citerefentry><refentrytitle>firewalld.ipset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.ipset.Methods.setVersion">
<term><methodname>setVersion</methodname>(s: version) → Nothing</term>
<listitem>
<para>
Permanently set version of ipset to <replaceable>version</replaceable>.
See <literal>version</literal> attribute of <literal>ipset</literal> tag in <citerefentry><refentrytitle>firewalld.ipset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.ipset.Methods.update">
<term><methodname>update</methodname>((ssssa{ss}as): settings) → Nothing</term>
<listitem>
<para>
Update settings of ipset to <replaceable>settings</replaceable>.
Settings are in format: <parameter>version</parameter>, <parameter>name</parameter>, <parameter>description</parameter>, <parameter>type</parameter>, dictionary of <parameter>options</parameter> and array of <parameter>entries</parameter>.
</para>
<para>
<variablelist>
<varlistentry><term><parameter>version (s)</parameter>: see <literal>version</literal> attribute of <literal>ipset</literal> tag in <citerefentry><refentrytitle>firewalld.ipset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>name (s)</parameter>: see <literal>short</literal> tag in <citerefentry><refentrytitle>firewalld.ipset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>description (s)</parameter>: see <literal>description</literal> tag in <citerefentry><refentrytitle>firewalld.ipset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>type (s)</parameter>: see <literal>type</literal> attribute of <literal>ipset</literal> tag in <citerefentry><refentrytitle>firewalld.ipset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>options (a{ss})</parameter>: dictionary of {option : value} . See <literal>options</literal> tag in <citerefentry><refentrytitle>firewalld.ipset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>entries (as)</parameter>: array of entries, see <literal>entry</literal> tag in <citerefentry><refentrytitle>firewalld.ipset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
</variablelist>
</para>
<para>
Possible errors: INVALID_TYPE
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect3>
<refsect3 id="FirewallD1.config.ipset.Signals">
<title>Signals</title>
<variablelist>
<varlistentry id="FirewallD1.config.ipset.Signals.Removed">
<term>Removed(s: name)</term>
<listitem>
<para>
Emitted when ipset with <replaceable>name</replaceable> has been removed.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.ipset.Signals.Renamed">
<term>Renamed(s: name)</term>
<listitem>
<para>
Emitted when ipset has been renamed to <replaceable>name</replaceable>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.ipset.Signals.Updated">
<term>Updated(s: name)</term>
<listitem>
<para>
Emitted when ipset with <replaceable>name</replaceable> has been updated.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect3>
<refsect3 id="FirewallD1.config.ipset.Properties">
<title>Properties</title>
<variablelist>
<varlistentry id="FirewallD1.config.ipset.Properties.builtin">
<term>builtin - b - (ro)</term>
<listitem>
<para>
True if ipset is build-in, false else.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.ipset.Properties.default">
<term>default - b - (ro)</term>
<listitem>
<para>
True if build-in ipset has default settings. False if it has been modified. Always False for not build-in ipsets.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.ipset.Properties.filename">
<term>filename - s - (ro)</term>
<listitem>
<para>
Name (including .xml extension) of file where the configuration is stored.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.ipset.Properties.name">
<term>name - s - (ro)</term>
<listitem>
<para>
Name of ipset.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.ipset.Properties.path">
<term>path - s - (ro)</term>
<listitem>
<para>
Path to directory where the ipset configuration is stored. Should be either /usr/lib/firewalld/ipsets or /etc/firewalld/ipsets.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect3>
</refsect2>
<refsect2 id="FirewallD1.config.zone">
<title>org.fedoraproject.FirewallD1.config.zone</title>
<para>
Interface for permanent zone configuration, see also <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
<refsect3 id="FirewallD1.config.zone.Methods">
<title>Methods</title>
<variablelist>
<varlistentry id="FirewallD1.config.zone.Methods.addForwardPort">
<term><methodname>addForwardPort</methodname>(s: port, s: protocol, s: toport, s: toaddr) → Nothing</term>
<listitem>
<para>
Permanently add (<replaceable>port</replaceable>, <replaceable>protocol</replaceable>, <replaceable>toport</replaceable>, <replaceable>toaddr</replaceable>) to list of forward ports of zone.
See <literal>forward-port</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime operation see <link linkend="FirewallD1.zone.Methods.addForwardPort">org.fedoraproject.FirewallD1.zone.Methods.addForwardPort</link>.
</para>
<para>
Possible errors: ALREADY_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.addIcmpBlock">
<term><methodname>addIcmpBlock</methodname>(s: icmptype) → Nothing</term>
<listitem>
<para>
Permanently add <replaceable>icmptype</replaceable> to list of icmp types blocked in zone.
See <literal>icmp-block</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime operation see <link linkend="FirewallD1.zone.Methods.addIcmpBlock">org.fedoraproject.FirewallD1.zone.Methods.addIcmpBlock</link>.
</para>
<para>
Possible errors: ALREADY_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.addIcmpBlockInversion">
<term><methodname>addIcmpBlock</methodname>(s: icmptype) → Nothing</term>
<listitem>
<para>
Permanently add icmp block inversion to zone.
See <literal>icmp-block-inversion</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime operation see <link linkend="FirewallD1.zone.Methods.addIcmpBlockInversion">org.fedoraproject.FirewallD1.zone.Methods.addIcmpBlockInversion</link>.
</para>
<para>
Possible errors: ALREADY_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.addInterface">
<term><methodname>addInterface</methodname>(s: interface) → Nothing</term>
<listitem>
<para>
Permanently add <replaceable>interface</replaceable> to list of interfaces bound to zone.
See <literal>interface</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime operation see <link linkend="FirewallD1.zone.Methods.addInterface">org.fedoraproject.FirewallD1.zone.Methods.addInterface</link>.
</para>
<para>
Possible errors: ALREADY_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.addMasquerade">
<term><methodname>addMasquerade</methodname>() → Nothing</term>
<listitem>
<para>
Permanently enable masquerading in zone.
See <literal>masquerade</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime operation see <link linkend="FirewallD1.zone.Methods.addMasquerade">org.fedoraproject.FirewallD1.zone.Methods.addMasquerade</link>.
</para>
<para>
Possible errors: ALREADY_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.addPort">
<term><methodname>addPort</methodname>(s: port, s: protocol) → Nothing</term>
<listitem>
<para>
Permanently add (<replaceable>port</replaceable>, <replaceable>protocol</replaceable>) to list of ports of zone.
See <literal>port</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime operation see <link linkend="FirewallD1.zone.Methods.addPort">org.fedoraproject.FirewallD1.zone.Methods.addPort</link>.
</para>
<para>
Possible errors: ALREADY_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.addProtocol">
<term><methodname>addProtocol</methodname>(s: protocol) → Nothing</term>
<listitem>
<para>
Permanently add protocol into <replaceable>zone</replaceable>.
The protocol can be any protocol supported by the system. Please have a look at <filename>/etc/protocols</filename> for supported protocols.
For runtime operation see <link linkend="FirewallD1.zone.Methods.addProtocol">org.fedoraproject.FirewallD1.zone.Methods.addProtocol</link>.
</para>
<para>
Possible errors: INVALID_PROTOCOL, ALREADY_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.addRichRule">
<term><methodname>addRichRule</methodname>(s: rule) → Nothing</term>
<listitem>
<para>
Permanently add <replaceable>rule</replaceable> to list of rich-language rules in zone.
See <literal>rule</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime operation see <link linkend="FirewallD1.zone.Methods.addRichRule">org.fedoraproject.FirewallD1.zone.Methods.addRichRule</link>.
</para>
<para>
Possible errors: ALREADY_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.addService">
<term><methodname>addService</methodname>(s: service) → Nothing</term>
<listitem>
<para>
Permanently add <replaceable>service</replaceable> to list of services used in zone.
See <literal>service</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime operation see <link linkend="FirewallD1.zone.Methods.addService">org.fedoraproject.FirewallD1.zone.Methods.addService</link>.
</para>
<para>
Possible errors: ALREADY_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.addSource">
<term><methodname>addSource</methodname>(s: source) → Nothing</term>
<listitem>
<para>
Permanently add <replaceable>source</replaceable> to list of source addresses bound to zone.
See <literal>source</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime operation see <link linkend="FirewallD1.zone.Methods.addSource">org.fedoraproject.FirewallD1.zone.Methods.addSource</link>.
</para>
<para>
Possible errors: ALREADY_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.addSourcePort">
<term><methodname>addSourcePort</methodname>(s: port, s: protocol) → Nothing</term>
<listitem>
<para>
Permanently add (<replaceable>port</replaceable>, <replaceable>protocol</replaceable>) to list of source ports of zone.
See <literal>source-port</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime operation see <link linkend="FirewallD1.zone.Methods.addSourcePort">org.fedoraproject.FirewallD1.zone.Methods.addSourcePort</link>.
</para>
<para>
Possible errors: ALREADY_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.getDescription">
<term><methodname>getDescription</methodname>() → s</term>
<listitem>
<para>
Get description of zone.
See <literal>description</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.getForwardPorts">
<term><methodname>getForwardPorts</methodname>() → a(ssss)</term>
<listitem>
<para>
Get list of (<replaceable>port</replaceable>, <replaceable>protocol</replaceable>, <replaceable>toport</replaceable>, <replaceable>toaddr</replaceable>) defined in zone.
See <literal>forward-port</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime operation see <link linkend="FirewallD1.zone.Methods.getForwardPorts">org.fedoraproject.FirewallD1.zone.Methods.getForwardPorts</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.getIcmpBlockInversion">
<term><methodname>getIcmpBlockInversion</methodname>() → b</term>
<listitem>
<para>
Get icmp block inversion flag of zone.
See <literal>icmp-block-inversion</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.getIcmpBlocks">
<term><methodname>getIcmpBlocks</methodname>() → as</term>
<listitem>
<para>
Get list of icmp type names blocked in zone.
See <literal>icmp-block</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime operation see <link linkend="FirewallD1.zone.Methods.getIcmpBlocks">org.fedoraproject.FirewallD1.zone.Methods.getIcmpBlocks</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.getInterfaces">
<term><methodname>getInterfaces</methodname>() → as</term>
<listitem>
<para>
Get list of interfaces bound to zone.
See <literal>interface</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime operation see <link linkend="FirewallD1.zone.Methods.getInterfaces">org.fedoraproject.FirewallD1.zone.Methods.getInterfaces</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.getMasquerade">
<term><methodname>getMasquerade</methodname>() → b</term>
<listitem>
<para>
Return whether <replaceable>masquerade</replaceable> is enabled in zone.
This is the same as queryMasquerade() method.
See <literal>masquerade</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.getPorts">
<term><methodname>getPorts</methodname>() → a(ss)</term>
<listitem>
<para>
Get list of (<replaceable>port</replaceable>, <replaceable>protocol</replaceable>) defined in zone.
See <literal>port</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime operation see <link linkend="FirewallD1.zone.Methods.getPorts">org.fedoraproject.FirewallD1.zone.Methods.getPorts</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.getProtocols">
<term><methodname>getProtocols</methodname>() → as</term>
<listitem>
<para>
Return array of protocols (s) previously enabled in <replaceable>zone</replaceable>.
For getting runtime settings see <link linkend="FirewallD1.zone.Methods.getProtocols">org.fedoraproject.FirewallD1.zone.Methods.getProtocols</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.getRichRules">
<term><methodname>getRichRules</methodname>() → as</term>
<listitem>
<para>
Get list of rich-language rules in zone.
See <literal>rule</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime operation see <link linkend="FirewallD1.zone.Methods.getRichRules">org.fedoraproject.FirewallD1.zone.Methods.getRichRules</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.getServices">
<term><methodname>getServices</methodname>() → as</term>
<listitem>
<para>
Get list of service names used in zone.
See <literal>service</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime operation see <link linkend="FirewallD1.zone.Methods.getServices">org.fedoraproject.FirewallD1.zone.Methods.getServices</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.getSettings">
<term><methodname>getSettings</methodname>() → (sssbsasa(ss)asba(ssss)asasasasa(ss)b)</term>
<listitem>
<para>
Return permanent settings of given <replaceable>zone</replaceable>.
For getting runtime settings see <link linkend="FirewallD1.Methods.getZoneSettings">org.fedoraproject.FirewallD1.Methods.getZoneSettings</link>.
Settings are in format: <parameter>version</parameter>, <parameter>name</parameter>, <parameter>description</parameter>, <parameter>UNUSED</parameter>, <parameter>target</parameter>, array of <parameter>services</parameter>, array of <parameter>ports</parameter> (port, protocol), array of <parameter>icmp-blocks</parameter>, <parameter>masquerade</parameter>, array of <parameter>forward-ports</parameter> (port, protocol, to-port, to-addr), array of <parameter>interfaces</parameter>, array of <parameter>sources</parameter>, array of <parameter>rich rules</parameter>, array of <parameter>protocols</parameter> and array of <parameter>source-ports</parameter> (port, protocol).
</para>
<para>
<variablelist>
<varlistentry><term><parameter>version (s)</parameter>: see <literal>version</literal> attribute of <literal>zone</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>name (s)</parameter>: see <literal>short</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>description (s)</parameter>: see <literal>description</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>UNUSED (b)</parameter>: this boolean value is no longer used for anything.</term></varlistentry>
<varlistentry><term><parameter>target (s)</parameter>: see <literal>target</literal> attribute of <literal>zone</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>services (as)</parameter>: array of service names, see <literal>service</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>ports (a(ss))</parameter>: array of port and protocol pairs. See <literal>port</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>icmp-blocks (as)</parameter>: array of icmp-blocks. See <literal>icmp-block</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>masquerade (b)</parameter>: see <literal>masquerade</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>forward-ports (a(ssss))</parameter>: array of (port, protocol, to-port, to-addr). See <literal>forward-port</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>interfaces (as)</parameter>: array of interfaces. See <literal>interface</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>source addresses (as)</parameter>: array of source addresses. See <literal>source</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>rich rules (as)</parameter>: array of rich-language rules. See <literal>rule</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>protocols (as)</parameter>: array of protocols. See <literal>protocol</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>source-ports (a(ss))</parameter>: array of port and protocol pairs. See <literal>source-port</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
</variablelist>
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.getShort">
<term><methodname>getShort</methodname>() → s</term>
<listitem>
<para>
Get name of zone.
See <literal>short</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.getSourcePorts">
<term><methodname>getSourcePorts</methodname>() → a(ss)</term>
<listitem>
<para>
Get list of (<replaceable>port</replaceable>, <replaceable>protocol</replaceable>) defined in zone.
See <literal>source-port</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime operation see <link linkend="FirewallD1.zone.Methods.getSourcePorts">org.fedoraproject.FirewallD1.zone.Methods.getSourcePorts</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.getSources">
<term><methodname>getSources</methodname>() → as</term>
<listitem>
<para>
Get list of source addresses bound to zone.
See <literal>source</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime operation see <link linkend="FirewallD1.zone.Methods.getSources">org.fedoraproject.FirewallD1.zone.Methods.getSources</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.getTarget">
<term><methodname>getTarget</methodname>() → s</term>
<listitem>
<para>
Get target of zone.
See <literal>target</literal> attribute of <literal>zone</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.getVersion">
<term><methodname>getVersion</methodname>() → s</term>
<listitem>
<para>
Get version of zone.
See <literal>version</literal> attribute of <literal>zone</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.loadDefaults">
<term><methodname>loadDefaults</methodname>() → Nothing</term>
<listitem>
<para>
Load default settings for built-in zone.
</para>
<para>
Possible errors: NO_DEFAULTS
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.queryForwardPort">
<term><methodname>queryForwardPort</methodname>(s: port, s: protocol, s: toport, s: toaddr) → b</term>
<listitem>
<para>
Return whether (<replaceable>port</replaceable>, <replaceable>protocol</replaceable>, <replaceable>toport</replaceable>, <replaceable>toaddr</replaceable>) is in list of forward ports of zone.
See <literal>forward-port</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime operation see <link linkend="FirewallD1.zone.Methods.queryForwardPort">org.fedoraproject.FirewallD1.zone.Methods.queryForwardPort</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.queryIcmpBlock">
<term><methodname>queryIcmpBlock</methodname>(s: icmptype) → b</term>
<listitem>
<para>
Return whether <replaceable>icmptype</replaceable> is in list of icmp types blocked in zone.
See <literal>icmp-block</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime operation see <link linkend="FirewallD1.zone.Methods.queryIcmpBlock">org.fedoraproject.FirewallD1.zone.Methods.queryIcmpBlock</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.queryIcmpBlockInversion">
<term><methodname>queryIcmpBlockInversion</methodname>() → b</term>
<listitem>
<para>
Return whether <replaceable>icmp block inversion</replaceable> is in enabled in zone.
See <literal>icmp-block-inversion</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime operation see <link linkend="FirewallD1.zone.Methods.queryIcmpBlockInversion">org.fedoraproject.FirewallD1.zone.Methods.queryIcmpBlockInversion</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.queryInterface">
<term><methodname>queryInterface</methodname>(s: interface) → b</term>
<listitem>
<para>
Return whether <replaceable>interface</replaceable> is in list of interfaces bound to zone.
See <literal>interface</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime operation see <link linkend="FirewallD1.zone.Methods.queryInterface">org.fedoraproject.FirewallD1.zone.Methods.queryInterface</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.queryMasquerade">
<term><methodname>queryMasquerade</methodname>() → b</term>
<listitem>
<para>
Return whether <replaceable>masquerade</replaceable> is enabled in zone.
This is the same as getMasquerade() method.
See <literal>masquerade</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime operation see <link linkend="FirewallD1.zone.Methods.queryMasquerade">org.fedoraproject.FirewallD1.zone.Methods.queryMasquerade</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.queryPort">
<term><methodname>queryPort</methodname>(s: port, s: protocol) → b</term>
<listitem>
<para>
Return whether (<replaceable>port</replaceable>, <replaceable>protocol</replaceable>) is in list of ports of zone.
See <literal>port</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime operation see <link linkend="FirewallD1.zone.Methods.queryPort">org.fedoraproject.FirewallD1.zone.Methods.queryPort</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.queryProtocol">
<term><methodname>queryProtocol</methodname>(s: protocol) → b</term>
<listitem>
<para>
Return whether <replaceable>protocol</replaceable> has been added in <replaceable>zone</replaceable>.
For runtime operation see <link linkend="FirewallD1.zone.Methods.queryProtocol">org.fedoraproject.FirewallD1.zone.Methods.queryProtocol</link>.
</para>
<para>
Possible errors: INVALID_PROTOCOL
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.queryRichRule">
<term><methodname>queryRichRule</methodname>(s: rule) → b</term>
<listitem>
<para>
Return whether <replaceable>rule</replaceable> is in list of rich-language rules in zone.
See <literal>rule</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime operation see <link linkend="FirewallD1.zone.Methods.queryRichRule">org.fedoraproject.FirewallD1.zone.Methods.queryRichRule</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.queryService">
<term><methodname>queryService</methodname>(s: service) → b</term>
<listitem>
<para>
Return whether <replaceable>service</replaceable> is in list of services used in zone.
See <literal>service</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime operation see <link linkend="FirewallD1.zone.Methods.queryService">org.fedoraproject.FirewallD1.zone.Methods.queryService</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.querySource">
<term><methodname>querySource</methodname>(s: source) → b</term>
<listitem>
<para>
Return whether <replaceable>source</replaceable> is in list of source addresses bound to zone.
See <literal>source</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime operation see <link linkend="FirewallD1.zone.Methods.querySource">org.fedoraproject.FirewallD1.zone.Methods.querySource</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.querySourcePort">
<term><methodname>querySourcePort</methodname>(s: port, s: protocol) → b</term>
<listitem>
<para>
Return whether (<replaceable>port</replaceable>, <replaceable>protocol</replaceable>) is in list of source ports of zone.
See <literal>source-port</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime operation see <link linkend="FirewallD1.zone.Methods.querySourcePort">org.fedoraproject.FirewallD1.zone.Methods.querySourcePort</link>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.remove">
<term><methodname>remove</methodname>() → Nothing</term>
<listitem>
<para>
Remove not built-in zone.
</para>
<para>
Possible errors: BUILTIN_ZONE
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.removeForwardPort">
<term><methodname>removeForwardPort</methodname>(s: port, s: protocol, s: toport, s: toaddr) → Nothing</term>
<listitem>
<para>
Permanently remove (<replaceable>port</replaceable>, <replaceable>protocol</replaceable>, <replaceable>toport</replaceable>, <replaceable>toaddr</replaceable>) from list of forward ports of zone.
See <literal>forward-port</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime operation see <link linkend="FirewallD1.zone.Methods.removeForwardPort">org.fedoraproject.FirewallD1.zone.Methods.removeForwardPort</link>.
</para>
<para>
Possible errors: NOT_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.removeIcmpBlock">
<term><methodname>removeIcmpBlock</methodname>(s: icmptype) → Nothing</term>
<listitem>
<para>
Permanently remove <replaceable>icmptype</replaceable> from list of icmp types blocked in zone.
See <literal>icmp-block</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime operation see <link linkend="FirewallD1.zone.Methods.removeIcmpBlock">org.fedoraproject.FirewallD1.zone.Methods.removeIcmpBlock</link>.
</para>
<para>
Possible errors: NOT_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.removeIcmpBlockInversion">
<term><methodname>removeIcmpBlockInversion</methodname>() → Nothing</term>
<listitem>
<para>
Permanently remove <replaceable>icmp block inversion</replaceable> from the zone.
See <literal>icmp-block-inversion</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime operation see <link linkend="FirewallD1.zone.Methods.removeIcmpBlockInversion">org.fedoraproject.FirewallD1.zone.Methods.removeIcmpBlockInversion</link>.
</para>
<para>
Possible errors: NOT_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.removeInterface">
<term><methodname>removeInterface</methodname>(s: interface) → Nothing</term>
<listitem>
<para>
Permanently remove <replaceable>interface</replaceable> from list of interfaces bound to zone.
See <literal>interface</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime operation see <link linkend="FirewallD1.zone.Methods.removeInterface">org.fedoraproject.FirewallD1.zone.Methods.removeInterface</link>.
</para>
<para>
Possible errors: NOT_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.removeMasquerade">
<term><methodname>removeMasquerade</methodname>() → Nothing</term>
<listitem>
<para>
Permanently disable masquerading in zone.
See <literal>masquerade</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime operation see <link linkend="FirewallD1.zone.Methods.removeMasquerade">org.fedoraproject.FirewallD1.zone.Methods.removeMasquerade</link>.
</para>
<para>
Possible errors: NOT_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.removePort">
<term><methodname>removePort</methodname>(s: port, s: protocol) → Nothing</term>
<listitem>
<para>
Permanently remove (<replaceable>port</replaceable>, <replaceable>protocol</replaceable>) from list of ports of zone.
See <literal>port</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime operation see <link linkend="FirewallD1.zone.Methods.removePort">org.fedoraproject.FirewallD1.zone.Methods.removePort</link>.
</para>
<para>
Possible errors: NOT_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.removeProtocol">
<term><methodname>removeProtocol</methodname>(s: protocol) → Nothing</term>
<listitem>
<para>
Permanently remove protocol from <replaceable>zone</replaceable>.
For runtime operation see <link linkend="FirewallD1.zone.Methods.removeProtocol">org.fedoraproject.FirewallD1.zone.Methods.removeProtocol</link>.
</para>
<para>
Possible errors: INVALID_PROTOCOL, NOT_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.removeRichRule">
<term><methodname>removeRichRule</methodname>(s: rule) → Nothing</term>
<listitem>
<para>
Permanently remove <replaceable>rule</replaceable> from list of rich-language rules in zone.
See <literal>rule</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime operation see <link linkend="FirewallD1.zone.Methods.removeRichRule">org.fedoraproject.FirewallD1.zone.Methods.removeRichRule</link>.
</para>
<para>
Possible errors: NOT_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.removeService">
<term><methodname>removeService</methodname>(s: service) → Nothing</term>
<listitem>
<para>
Permanently remove <replaceable>service</replaceable> from list of services used in zone.
See <literal>service</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime operation see <link linkend="FirewallD1.zone.Methods.removeService">org.fedoraproject.FirewallD1.zone.Methods.removeService</link>.
</para>
<para>
Possible errors: NOT_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.removeSource">
<term><methodname>removeSource</methodname>(s: source) → Nothing</term>
<listitem>
<para>
Permanently remove <replaceable>source</replaceable> from list of source addresses bound to zone.
See <literal>source</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime operation see <link linkend="FirewallD1.zone.Methods.removeSource">org.fedoraproject.FirewallD1.zone.Methods.removeSource</link>.
</para>
<para>
Possible errors: NOT_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.removeSourcePort">
<term><methodname>removeSourcePort</methodname>(s: port, s: protocol) → Nothing</term>
<listitem>
<para>
Permanently remove (<replaceable>port</replaceable>, <replaceable>protocol</replaceable>) from list of source ports of zone.
See <literal>source-port</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
For runtime operation see <link linkend="FirewallD1.zone.Methods.removeSourcePort">org.fedoraproject.FirewallD1.zone.Methods.removeSourcePort</link>.
</para>
<para>
Possible errors: NOT_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.rename">
<term><methodname>rename</methodname>(s: name) → Nothing</term>
<listitem>
<para>
Rename not built-in zone to <replaceable>name</replaceable>.
</para>
<para>
Possible errors: BUILTIN_ZONE
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.setDescription">
<term><methodname>setDescription</methodname>(s: description) → Nothing</term>
<listitem>
<para>
Permanently set description of zone to <replaceable>description</replaceable>.
See <literal>description</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.setForwardPorts">
<term><methodname>setForwardPorts</methodname>(a(ssss): ports) → Nothing</term>
<listitem>
<para>
Permanently set forward ports of zone to list of (<replaceable>port</replaceable>, <replaceable>protocol</replaceable>, <replaceable>toport</replaceable>, <replaceable>toaddr</replaceable>).
See <literal>forward-port</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.setIcmpBlockInversion">
<term><methodname>setIcmpBlockInversion</methodname>(b: flag) → Nothing</term>
<listitem>
<para>
Permanently set icmp block inversion flag of zone to <replaceable>flag</replaceable>.
See <literal>icmp-block-inversion</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.setIcmpBlocks">
<term><methodname>setIcmpBlocks</methodname>(as: icmptypes) → Nothing</term>
<listitem>
<para>
Permanently set list of icmp types blocked in zone to <replaceable>icmptypes</replaceable>.
See <literal>icmp-block</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.setInterfaces">
<term><methodname>setInterfaces</methodname>(as: interfaces) → Nothing</term>
<listitem>
<para>
Permanently set list of interfaces bound to zone to <replaceable>interfaces</replaceable>.
See <literal>interface</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.setMasquerade">
<term><methodname>setMasquerade</methodname>(b: masquerade) → Nothing</term>
<listitem>
<para>
Permanently set masquerading in zone to <replaceable>masquerade</replaceable>.
See <literal>masquerade</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.setPorts">
<term><methodname>setPorts</methodname>(a(ss): ports) → Nothing</term>
<listitem>
<para>
Permanently set ports of zone to list of (<replaceable>port</replaceable>, <replaceable>protocol</replaceable>).
See <literal>port</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.setProtocols">
<term><methodname>setProtocols</methodname>(as: protocols) → Nothing</term>
<listitem>
<para>
Permanently set list of protocols used in zone to <replaceable>protocols</replaceable>.
See <literal>protocol</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.setRichRules">
<term><methodname>setRichRules</methodname>(as: rules) → Nothing</term>
<listitem>
<para>
Permanently set list of rich-language rules to <replaceable>rules</replaceable>.
See <literal>rule</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.setServices">
<term><methodname>setServices</methodname>(as: services) → Nothing</term>
<listitem>
<para>
Permanently set list of services used in zone to <replaceable>services</replaceable>.
See <literal>service</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.setShort">
<term><methodname>setShort</methodname>(s: short) → Nothing</term>
<listitem>
<para>
Permanently set name of zone to <replaceable>short</replaceable>.
See <literal>short</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.setSourcePorts">
<term><methodname>setSourcePorts</methodname>(a(ss): ports) → Nothing</term>
<listitem>
<para>
Permanently set source-ports of zone to list of (<replaceable>port</replaceable>, <replaceable>protocol</replaceable>).
See <literal>source-port</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.setSources">
<term><methodname>setSources</methodname>(as: sources) → Nothing</term>
<listitem>
<para>
Permanently set list of source addresses bound to zone to <replaceable>sources</replaceable>.
See <literal>source</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.setTarget">
<term><methodname>setTarget</methodname>(s: target) → Nothing</term>
<listitem>
<para>
Permanently set target of zone to <replaceable>target</replaceable>.
See <literal>target</literal> attribute of <literal>zone</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.setVersion">
<term><methodname>setVersion</methodname>(s: version) → Nothing</term>
<listitem>
<para>
Permanently set version of zone to <replaceable>version</replaceable>.
See <literal>version</literal> attribute of <literal>zone</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Methods.update">
<term><methodname>update</methodname>((sssbsasa(ss)asba(ssss)asasasasa(ss)b): settings) → Nothing</term>
<listitem>
<para>
Update settings of zone to <replaceable>settings</replaceable>.
Settings are in format: <parameter>version</parameter>, <parameter>name</parameter>, <parameter>description</parameter>, <parameter>UNUSED</parameter>, <parameter>target</parameter>, array of <parameter>services</parameter>, array of <parameter>ports</parameter> (port, protocol), array of <parameter>icmp-blocks</parameter>, <parameter>masquerade</parameter>, array of <parameter>forward-ports</parameter> (port, protocol, to-port, to-addr), array of <parameter>interfaces</parameter>, array of <parameter>sources</parameter>, array of <parameter>rich rules</parameter>, array of <parameter>protocols</parameter> and array of <parameter>source-ports</parameter> (port, protocol).
</para>
<para>
<variablelist>
<varlistentry><term><parameter>version (s)</parameter>: see <literal>version</literal> attribute of <literal>zone</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>name (s)</parameter>: see <literal>short</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>description (s)</parameter>: see <literal>description</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>UNUSED (b)</parameter>: this boolean value is no longer used for anything.</term></varlistentry>
<varlistentry><term><parameter>target (s)</parameter>: see <literal>target</literal> attribute of <literal>zone</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>services (as)</parameter>: array of service names, see <literal>service</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>ports (a(ss))</parameter>: array of port and protocol pairs. See <literal>port</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>icmp-blocks (as)</parameter>: array of icmp-blocks. See <literal>icmp-block</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>masquerade (b)</parameter>: see <literal>masquerade</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>forward-ports (a(ssss))</parameter>: array of (port, protocol, to-port, to-addr). See <literal>forward-port</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>interfaces (as)</parameter>: array of interfaces. See <literal>interface</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>source addresses (as)</parameter>: array of source addresses. See <literal>source</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>rich rules (as)</parameter>: array of rich-language rules. See <literal>rule</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>protocols (as)</parameter>: array of protocols. See <literal>protocol</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>source-ports (a(ss))</parameter>: array of port and protocol pairs. See <literal>source-port</literal> tag in <citerefentry><refentrytitle>firewalld.zone</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
</variablelist>
</para>
<para>
Possible errors: INVALID_TYPE
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect3>
<refsect3 id="FirewallD1.config.zone.Signals">
<title>Signals</title>
<variablelist>
<varlistentry id="FirewallD1.config.zone.Signals.Removed">
<term>Removed(s: name)</term>
<listitem>
<para>
Emitted when zone with <replaceable>name</replaceable> has been removed.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Signals.Renamed">
<term>Renamed(s: name)</term>
<listitem>
<para>
Emitted when zone has been renamed to <replaceable>name</replaceable>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Signals.Updated">
<term>Updated(s: name)</term>
<listitem>
<para>
Emitted when zone with <replaceable>name</replaceable> has been updated.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect3>
<refsect3 id="FirewallD1.config.zone.Properties">
<title>Properties</title>
<variablelist>
<varlistentry id="FirewallD1.config.zone.Properties.builtin">
<term>builtin - b - (ro)</term>
<listitem>
<para>
True if zone is build-in, false else.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Properties.default">
<term>default - b - (ro)</term>
<listitem>
<para>
True if build-in zone has default settings. False if it has been modified. Always False for not build-in zones.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Properties.filename">
<term>filename - s - (ro)</term>
<listitem>
<para>
Name (including .xml extension) of file where the configuration is stored.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Properties.name">
<term>name - s - (ro)</term>
<listitem>
<para>
Name of zone.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.zone.Properties.path">
<term>path - s - (ro)</term>
<listitem>
<para>
Path to directory where the zone configuration is stored. Should be either /usr/lib/firewalld/zones or /etc/firewalld/zones.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect3>
</refsect2>
<refsect2 id="FirewallD1.config.service">
<title>org.fedoraproject.FirewallD1.config.service</title>
<para>
Interface for permanent service configuration, see also <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
<refsect3 id="FirewallD1.config.service.Methods">
<title>Methods</title>
<variablelist>
<varlistentry id="FirewallD1.config.service.Methods.addModule">
<annotation name="org.freedesktop.DBus.Deprecated" />
<term><methodname>addModule</methodname>(s: module) → Nothing</term>
<listitem>
<para>
This method is deprecated. Please use "helpers" in the update2() method.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.service.Methods.addPort">
<term><methodname>addPort</methodname>(s: port, s: protocol) → Nothing</term>
<listitem>
<para>
Permanently add (<replaceable>port</replaceable>, <replaceable>protocol</replaceable>) to list of ports in service.
See <literal>port</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
<para>
Possible errors: ALREADY_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.service.Methods.addProtocol">
<term><methodname>addProtocol</methodname>(s: protocol) → Nothing</term>
<listitem>
<para>
Permanently add protocol into <replaceable>zone</replaceable>.
The protocol can be any protocol supported by the system. Please have a look at <filename>/etc/protocols</filename> for supported protocols.
See <literal>protocol</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
<para>
Possible errors: INVALID_PROTOCOL, ALREADY_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.service.Methods.addSourcePort">
<term><methodname>addSourcePort</methodname>(s: port, s: protocol) → Nothing</term>
<listitem>
<para>
Permanently add (<replaceable>port</replaceable>, <replaceable>protocol</replaceable>) to list of source ports in service.
See <literal>source-port</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
<para>
Possible errors: ALREADY_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.service.Methods.getDescription">
<term><methodname>getDescription</methodname>() → s</term>
<listitem>
<para>
Get description of service.
See <literal>description</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.service.Methods.getDestination">
<term><methodname>getDestination</methodname>(s: family) → s</term>
<listitem>
<para>
Get destination for IP family being either 'ipv4' or 'ipv6'.
See <literal>destination</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
<para>
Possible errors: ALREADY_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.service.Methods.getDestinations">
<term><methodname>getDestinations</methodname>() → a{ss}</term>
<listitem>
<para>
Get list of destinations.
Return value is a dictionary of {IP family : IP address} where 'IP family' key can be either 'ipv4' or 'ipv6'.
See <literal>destination</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.service.Methods.getModules">
<annotation name="org.freedesktop.DBus.Deprecated" />
<term><methodname>getModules</methodname>() → as</term>
<listitem>
<para>
This method is deprecated. Please use "helpers" in the getSettings2() method.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.service.Methods.getPorts">
<term><methodname>getPorts</methodname>() → a(ss)</term>
<listitem>
<para>
Get list of (<replaceable>port</replaceable>, <replaceable>protocol</replaceable>) defined in service.
See <literal>port</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.service.Methods.getProtocols">
<term><methodname>getProtocols</methodname>() → as</term>
<listitem>
<para>
Return array of protocols (s) defined in <replaceable>service</replaceable>.
See <literal>protocol</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.service.Methods.getSettings">
<annotation name="org.freedesktop.DBus.Deprecated" />
<term><methodname>getSettings</methodname>() → (sssa(ss)asa{ss}asa(ss))</term>
<listitem>
<para>
This function is deprecated, use <link linkend="FirewallD1.config.service.Methods.getSettings2">org.fedoraproject.FirewallD1.config.service.Methods.getSettings2</link> instead.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.service.Methods.getSettings2">
<term><methodname>getSettings2</methodname>(s: <parameter>service</parameter>) → s{sv}</term>
<listitem>
<para>
Return runtime settings of given <replaceable>service</replaceable>.
For getting runtime settings see <link linkend="FirewallD1.Methods.getServiceSettings2">org.fedoraproject.FirewallD1.Methods.getServiceSettings2</link>.
Settings are a dictionary indexed by keywords. For the type of each value see below. If the value is empty it may be ommitted.
</para>
<para>
<variablelist>
<varlistentry><term><parameter>version (s)</parameter>: see <literal>version</literal> attribute of <literal>service</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>name (s)</parameter>: see <literal>short</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>description (s)</parameter>: see <literal>description</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>ports (a(ss))</parameter>: array of port and protocol pairs. See <literal>port</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>module names (as)</parameter>: array of kernel netfilter helpers, see <literal>module</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>destinations (a{ss})</parameter>: dictionary of {IP family : IP address} where 'IP family' key can be either 'ipv4' or 'ipv6'. See <literal>destination</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>protocols (as)</parameter>: array of protocols, see <literal>protocol</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>source_ports (a(ss))</parameter>: array of port and protocol pairs. See <literal>source-port</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>includes (as)</parameter>: array of service includes, see <literal>include</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>helpers (as)</parameter>: array of service helpers, see <literal>helper</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
</variablelist>
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.service.Methods.getShort">
<term><methodname>getShort</methodname>() → s</term>
<listitem>
<para>
Get name of service.
See <literal>short</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.service.Methods.getSourcePorts">
<term><methodname>getSourcePorts</methodname>() → a(ss)</term>
<listitem>
<para>
Get list of (<replaceable>port</replaceable>, <replaceable>protocol</replaceable>) defined in service.
See <literal>source-port</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.service.Methods.getVersion">
<term><methodname>getVersion</methodname>() → s</term>
<listitem>
<para>
Get version of service.
See <literal>version</literal> attribute of <literal>service</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.service.Methods.loadDefaults">
<term><methodname>loadDefaults</methodname>() → Nothing</term>
<listitem>
<para>
Load default settings for built-in service.
</para>
<para>
Possible errors: NO_DEFAULTS
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.service.Methods.queryDestination">
<term><methodname>queryDestination</methodname>(s: family, s: address) → b</term>
<listitem>
<para>
Return whether a <replaceable>destination</replaceable> is in dictionary of destinations of this service.
destination is in format: (<replaceable>IP family</replaceable>, <replaceable>IP address</replaceable>) where <replaceable>IP family</replaceable> can be either 'ipv4' or 'ipv6'.
See <literal>destination</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.service.Methods.queryModule">
<annotation name="org.freedesktop.DBus.Deprecated" />
<term><methodname>queryModule</methodname>(s: module) → b</term>
<listitem>
<para>
This method is deprecated. Please use "helpers" in the getSettings2() method.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.service.Methods.queryPort">
<term><methodname>queryPort</methodname>(s: port, s: protocol) → b</term>
<listitem>
<para>
Return whether (<replaceable>port</replaceable>, <replaceable>protocol</replaceable>) is in list of ports in service.
See <literal>port</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.service.Methods.queryProtocol">
<term><methodname>queryProtocol</methodname>(s: protocol) → b</term>
<listitem>
<para>
Return whether <replaceable>protocol</replaceable> is in list of protocols in service.
See <literal>protocol</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.service.Methods.querySourcePort">
<term><methodname>querySourcePort</methodname>(s: port, s: protocol) → b</term>
<listitem>
<para>
Return whether (<replaceable>port</replaceable>, <replaceable>protocol</replaceable>) is in list of source ports in service.
See <literal>source-port</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.service.Methods.remove">
<term><methodname>remove</methodname>() → Nothing</term>
<listitem>
<para>
Remove not built-in service.
</para>
<para>
Possible errors: BUILTIN_SERVICE
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.service.Methods.removeDestination">
<term><methodname>removeDestination</methodname>(s: family) → Nothing</term>
<listitem>
<para>
Permanently remove a destination with <replaceable>family</replaceable> ('ipv4' or 'ipv6') from service.
See <literal>destination</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
<para>
Possible errors: NOT_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.service.Methods.removeModule">
<annotation name="org.freedesktop.DBus.Deprecated" />
<term><methodname>removeModule</methodname>(s: module) → Nothing</term>
<listitem>
<para>
This method is deprecated. Please use "helpers" in the update2() method.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.service.Methods.removePort">
<term><methodname>removePort</methodname>(s: port, s: protocol) → Nothing</term>
<listitem>
<para>
Permanently remove (<replaceable>port</replaceable>, <replaceable>protocol</replaceable>) from list of ports in service.
See <literal>port</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
<para>
Possible errors: NOT_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.service.Methods.removeProtocol">
<term><methodname>removeProtocol</methodname>(s: protocol) → Nothing</term>
<listitem>
<para>
Permanently remove <replaceable>protocol</replaceable> from list of protocols in service.
See <literal>protocol</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
<para>
Possible errors: NOT_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.service.Methods.removeSourcePort">
<term><methodname>removeSourcePort</methodname>(s: port, s: protocol) → Nothing</term>
<listitem>
<para>
Permanently remove (<replaceable>port</replaceable>, <replaceable>protocol</replaceable>) from list of source ports in service.
See <literal>source-port</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
<para>
Possible errors: NOT_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.service.Methods.rename">
<term><methodname>rename</methodname>(s: name) → Nothing</term>
<listitem>
<para>
Rename not built-in service to <replaceable>name</replaceable>.
</para>
<para>
Possible errors: BUILTIN_SERVICE
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.service.Methods.setDescription">
<term><methodname>setDescription</methodname>(s: description) → Nothing</term>
<listitem>
<para>
Permanently set description of service to <replaceable>description</replaceable>.
See <literal>description</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.service.Methods.setDestination">
<term><methodname>setDestination</methodname>(s: family, s: address) → Nothing</term>
<listitem>
<para>
Permanently set a destination address.
destination is in format: (<replaceable>IP family</replaceable>, <replaceable>IP address</replaceable>) where <replaceable>IP family</replaceable> can be either 'ipv4' or 'ipv6'.
See <literal>destination</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
<para>
Possible errors: ALREADY_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.service.Methods.setDestinations">
<term><methodname>setDestinations</methodname>(a{ss}: destinations) → Nothing</term>
<listitem>
<para>
Permanently set destinations of service to <replaceable>destinations</replaceable>, which is a dictionary of {IP family : IP address} where 'IP family' key can be either 'ipv4' or 'ipv6'.
See <literal>destination</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.service.Methods.setModules">
<annotation name="org.freedesktop.DBus.Deprecated" />
<term><methodname>setModules</methodname>(as: modules) → Nothing</term>
<listitem>
<para>
This method is deprecated. Please use "helpers" in the update2() method.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.service.Methods.setPorts">
<term><methodname>setPorts</methodname>(a(ss): ports) → Nothing</term>
<listitem>
<para>
Permanently set ports of service to list of (<replaceable>port</replaceable>, <replaceable>protocol</replaceable>).
See <literal>port</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.service.Methods.setProtocols">
<term><methodname>setProtocols</methodname>(as: protocols) → Nothing</term>
<listitem>
<para>
Permanently set protocols of service to list of <replaceable>protocols</replaceable>.
See <literal>protocol</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.service.Methods.setShort">
<term><methodname>setShort</methodname>(s: short) → Nothing</term>
<listitem>
<para>
Permanently set name of service to <replaceable>short</replaceable>.
See <literal>short</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.service.Methods.setSourcePorts">
<term><methodname>setSourcePorts</methodname>(a(ss): ports) → Nothing</term>
<listitem>
<para>
Permanently set source-ports of service to list of (<replaceable>port</replaceable>, <replaceable>protocol</replaceable>).
See <literal>source-port</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.service.Methods.setVersion">
<term><methodname>setVersion</methodname>(s: version) → Nothing</term>
<listitem>
<para>
Permanently set version of service to <replaceable>version</replaceable>.
See <literal>version</literal> attribute of <literal>service</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.service.Methods.update">
<annotation name="org.freedesktop.DBus.Deprecated" />
<term><methodname>update</methodname>((sssa(ss)asa{ss}asa(ss)): settings) → Nothing</term>
<listitem>
<para>
This function is deprecated, use <link linkend="FirewallD1.config.service.Methods.update2">org.fedoraproject.FirewallD1.config.service.Methods.update2</link> instead.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.service.Methods.update2">
<term><methodname>update2</methodname>a{sv}: settings) → Nothing</term>
<listitem>
<para>
Update settings of service to <replaceable>settings</replaceable>.
Settings are a dictionary indexed by keywords. For the type of each value see below. To zero a value pass an empty string or list.
</para>
<para>
<variablelist>
<varlistentry><term><parameter>version (s)</parameter>: see <literal>version</literal> attribute of <literal>service</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>name (s)</parameter>: see <literal>short</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>description (s)</parameter>: see <literal>description</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>ports (a(ss))</parameter>: array of port and protocol pairs. See <literal>port</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>module names (as)</parameter>: array of kernel netfilter helpers, see <literal>module</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>destinations (a{ss})</parameter>: dictionary of {IP family : IP address} where 'IP family' key can be either 'ipv4' or 'ipv6'. See <literal>destination</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>protocols (as)</parameter>: array of protocols, see <literal>protocol</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>source_ports (a(ss))</parameter>: array of port and protocol pairs. See <literal>source-port</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>includes (as)</parameter>: array of service includes, see <literal>include</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>helpers (as)</parameter>: array of service helpers, see <literal>helper</literal> tag in <citerefentry><refentrytitle>firewalld.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
</variablelist>
</para>
<para>
Possible errors: INVALID_TYPE
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect3>
<refsect3 id="FirewallD1.config.service.Signals">
<title>Signals</title>
<variablelist>
<varlistentry id="FirewallD1.config.service.Signals.Removed">
<term>Removed(s: name)</term>
<listitem>
<para>
Emitted when service with <replaceable>name</replaceable> has been removed.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.service.Signals.Renamed">
<term>Renamed(s: name)</term>
<listitem>
<para>
Emitted when service has been renamed to <replaceable>name</replaceable>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.service.Signals.Updated">
<term>Updated(s: name)</term>
<listitem>
<para>
Emitted when service with <replaceable>name</replaceable> has been updated.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect3>
<refsect3 id="FirewallD1.config.service.Properties">
<title>Properties</title>
<variablelist>
<varlistentry id="FirewallD1.config.service.Properties.builtin">
<term>builtin - b - (ro)</term>
<listitem>
<para>
True if service is build-in, false else.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.service.Properties.default">
<term>default - b - (ro)</term>
<listitem>
<para>
True if build-in service has default settings. False if it has been modified. Always False for not build-in services.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.service.Properties.filename">
<term>filename - s - (ro)</term>
<listitem>
<para>
Name (including .xml extension) of file where the configuration is stored.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.service.Properties.name">
<term>name - s - (ro)</term>
<listitem>
<para>
Name of service.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.service.Properties.path">
<term>path - s - (ro)</term>
<listitem>
<para>
Path to directory where the configuration is stored. Should be either /usr/lib/firewalld/services or /etc/firewalld/services.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect3>
</refsect2>
<refsect2 id="FirewallD1.config.helper">
<title>org.fedoraproject.FirewallD1.config.helper</title>
<para>
Interface for permanent helper configuration, see also <citerefentry><refentrytitle>firewalld.helper</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
<refsect3 id="FirewallD1.config.helper.Methods">
<title>Methods</title>
<variablelist>
<varlistentry id="FirewallD1.config.helper.Methods.addPort">
<term><methodname>addPort</methodname>(s: port, s: protocol) → Nothing</term>
<listitem>
<para>
Permanently add (<replaceable>port</replaceable>, <replaceable>protocol</replaceable>) to list of ports in helper.
See <literal>port</literal> tag in <citerefentry><refentrytitle>firewalld.helper</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
<para>
Possible errors: ALREADY_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.helper.Methods.getDescription">
<term><methodname>getDescription</methodname>() → s</term>
<listitem>
<para>
Get description of helper.
See <literal>description</literal> tag in <citerefentry><refentrytitle>firewalld.helper</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.helper.Methods.getFamily">
<term><methodname>getFamily</methodname>() → s</term>
<listitem>
<para>
Get family being 'ipv4', 'ipv6' or empty for both.
See <literal>family</literal> tag in <citerefentry><refentrytitle>firewalld.helper</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.helper.Methods.getModule">
<term><methodname>getModule</methodname>() → s</term>
<listitem>
<para>
Get modules (netfilter kernel helpers) used in helper.
See <literal>module</literal> tag in <citerefentry><refentrytitle>firewalld.helper</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.helper.Methods.getPorts">
<term><methodname>getPorts</methodname>() → a(ss)</term>
<listitem>
<para>
Get list of (<replaceable>port</replaceable>, <replaceable>protocol</replaceable>) defined in helper.
See <literal>port</literal> tag in <citerefentry><refentrytitle>firewalld.helper</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.helper.Methods.getSettings">
<term><methodname>getSettings</methodname>() → (sssssa(ss))</term>
<listitem>
<para>
Return permanent settings of a <replaceable>helper</replaceable>.
For getting runtime settings see <link linkend="FirewallD1.Methods.getHelperSettings">org.fedoraproject.FirewallD1.Methods.getHelperSettings</link>.
Settings are in format: <parameter>version</parameter>, <parameter>name</parameter>, <parameter>description</parameter>, <parameter>family</parameter>, <parameter>module</parameter>, array of <parameter>ports</parameter> (port, protocol).
</para>
<para>
<variablelist>
<varlistentry><term><parameter>version (s)</parameter>: see <literal>version</literal> attribute of <literal>helper</literal> tag in <citerefentry><refentrytitle>firewalld.helper</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>name (s)</parameter>: see <literal>short</literal> tag in <citerefentry><refentrytitle>firewalld.helper</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>description (s)</parameter>: see <literal>description</literal> tag in <citerefentry><refentrytitle>firewalld.helper</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>family (s)</parameter>: see <literal>family</literal> tag in <citerefentry><refentrytitle>firewalld.helper</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>module (s)</parameter>: see <literal>module</literal> tag in <citerefentry><refentrytitle>firewalld.helper</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>ports (a(ss))</parameter>: array of port and protocol pairs. See <literal>port</literal> tag in <citerefentry><refentrytitle>firewalld.helper</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
</variablelist>
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.helper.Methods.getShort">
<term><methodname>getShort</methodname>() → s</term>
<listitem>
<para>
Get name of helper.
See <literal>short</literal> tag in <citerefentry><refentrytitle>firewalld.helper</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.helper.Methods.getVersion">
<term><methodname>getVersion</methodname>() → s</term>
<listitem>
<para>
Get version of helper.
See <literal>version</literal> attribute of <literal>helper</literal> tag in <citerefentry><refentrytitle>firewalld.helper</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.helper.Methods.loadDefaults">
<term><methodname>loadDefaults</methodname>() → Nothing</term>
<listitem>
<para>
Load default settings for built-in helper.
</para>
<para>
Possible errors: NO_DEFAULTS
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.helper.Methods.queryFamily">
<term><methodname>queryFamily</methodname>(s: module) → b</term>
<listitem>
<para>
Return whether <replaceable>family</replaceable> is set for helper.
See <literal>family</literal> tag in <citerefentry><refentrytitle>firewalld.helper</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.helper.Methods.queryModule">
<term><methodname>queryModule</methodname>(s: module) → b</term>
<listitem>
<para>
Return whether <replaceable>module</replaceable> (netfilter kernel helpers) is used in helper.
See <literal>module</literal> tag in <citerefentry><refentrytitle>firewalld.helper</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.helper.Methods.queryPort">
<term><methodname>queryPort</methodname>(s: port, s: protocol) → b</term>
<listitem>
<para>
Return whether (<replaceable>port</replaceable>, <replaceable>protocol</replaceable>) is in list of ports in helper.
See <literal>port</literal> tag in <citerefentry><refentrytitle>firewalld.helper</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.helper.Methods.remove">
<term><methodname>remove</methodname>() → Nothing</term>
<listitem>
<para>
Remove not built-in helper.
</para>
<para>
Possible errors: BUILTIN_HELPER
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.helper.Methods.removePort">
<term><methodname>removePort</methodname>(s: port, s: protocol) → Nothing</term>
<listitem>
<para>
Permanently remove (<replaceable>port</replaceable>, <replaceable>protocol</replaceable>) from list of ports in helper.
See <literal>port</literal> tag in <citerefentry><refentrytitle>firewalld.helper</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
<para>
Possible errors: NOT_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.helper.Methods.rename">
<term><methodname>rename</methodname>(s: name) → Nothing</term>
<listitem>
<para>
Rename not built-in helper to <replaceable>name</replaceable>.
</para>
<para>
Possible errors: BUILTIN_HELPER
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.helper.Methods.setDescription">
<term><methodname>setDescription</methodname>(s: description) → Nothing</term>
<listitem>
<para>
Permanently set description of helper to <replaceable>description</replaceable>.
See <literal>description</literal> tag in <citerefentry><refentrytitle>firewalld.helper</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.helper.Methods.setFamily">
<term><methodname>setFamily</methodname>(s: family) → Nothing</term>
<listitem>
<para>
Permanently set family of helper to <replaceable>family</replaceable>.
See <literal>family</literal> tag in <citerefentry><refentrytitle>firewalld.helper</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.helper.Methods.setModule">
<term><methodname>setModule</methodname>(s: module) → Nothing</term>
<listitem>
<para>
Permanently set module of helper to <replaceable>description</replaceable>.
See <literal>module</literal> tag in <citerefentry><refentrytitle>firewalld.helper</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.helper.Methods.setPorts">
<term><methodname>setPorts</methodname>(a(ss): ports) → Nothing</term>
<listitem>
<para>
Permanently set ports of helper to list of (<replaceable>port</replaceable>, <replaceable>protocol</replaceable>).
See <literal>port</literal> tag in <citerefentry><refentrytitle>firewalld.helper</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.helper.Methods.setShort">
<term><methodname>setShort</methodname>(s: short) → Nothing</term>
<listitem>
<para>
Permanently set name of helper to <replaceable>short</replaceable>.
See <literal>short</literal> tag in <citerefentry><refentrytitle>firewalld.helper</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.helper.Methods.setVersion">
<term><methodname>setVersion</methodname>(s: version) → Nothing</term>
<listitem>
<para>
Permanently set version of helper to <replaceable>version</replaceable>.
See <literal>version</literal> attribute of <literal>helper</literal> tag in <citerefentry><refentrytitle>firewalld.helper</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.helper.Methods.update">
<term><methodname>update</methodname>((sssssa(ss)): settings) → Nothing</term>
<listitem>
<para>
Update settings of helper to <replaceable>settings</replaceable>.
Settings are in format: <parameter>version</parameter>, <parameter>name</parameter>, <parameter>description</parameter>, <parameter>family</parameter>, <parameter>module</parameter> and array of <parameter>ports</parameter>.
</para>
<para>
<variablelist>
<varlistentry><term><parameter>version (s)</parameter>: see <literal>version</literal> attribute of <literal>helper</literal> tag in <citerefentry><refentrytitle>firewalld.helper</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>name (s)</parameter>: see <literal>short</literal> tag in <citerefentry><refentrytitle>firewalld.helper</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>description (s)</parameter>: see <literal>description</literal> tag in <citerefentry><refentrytitle>firewalld.helper</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>family (s)</parameter>: see <literal>family</literal> tag in <citerefentry><refentrytitle>firewalld.helper</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>module (s)</parameter>: see <literal>module</literal> tag in <citerefentry><refentrytitle>firewalld.helper</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>ports (a(ss))</parameter>: array of port and protocol pairs. See <literal>port</literal> tag in <citerefentry><refentrytitle>firewalld.helper</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
</variablelist>
</para>
<para>
Possible errors: INVALID_HELPER
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect3>
<refsect3 id="FirewallD1.config.helper.Signals">
<title>Signals</title>
<variablelist>
<varlistentry id="FirewallD1.config.helper.Signals.Removed">
<term>Removed(s: name)</term>
<listitem>
<para>
Emitted when helper with <replaceable>name</replaceable> has been removed.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.helper.Signals.Renamed">
<term>Renamed(s: name)</term>
<listitem>
<para>
Emitted when helper has been renamed to <replaceable>name</replaceable>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.helper.Signals.Updated">
<term>Updated(s: name)</term>
<listitem>
<para>
Emitted when helper with <replaceable>name</replaceable> has been updated.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect3>
<refsect3 id="FirewallD1.config.helper.Properties">
<title>Properties</title>
<variablelist>
<varlistentry id="FirewallD1.config.helper.Properties.builtin">
<term>builtin - b - (ro)</term>
<listitem>
<para>
True if helper is build-in, false else.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.helper.Properties.default">
<term>default - b - (ro)</term>
<listitem>
<para>
True if build-in helper has default settings. False if it has been modified. Always False for not build-in helpers.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.helper.Properties.filename">
<term>filename - s - (ro)</term>
<listitem>
<para>
Name (including .xml extension) of file where the configuration is stored.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.helper.Properties.name">
<term>name - s - (ro)</term>
<listitem>
<para>
Name of helper.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.helper.Properties.path">
<term>path - s - (ro)</term>
<listitem>
<para>
Path to directory where the configuration is stored. Should be either /usr/lib/firewalld/helpers or /etc/firewalld/helpers.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect3>
</refsect2>
<refsect2 id="FirewallD1.config.icmptype">
<title>org.fedoraproject.FirewallD1.config.icmptype</title>
<para>
Interface for permanent icmp type configuration, see also <citerefentry><refentrytitle>firewalld.icmptype</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
<refsect3 id="FirewallD1.config.icmptype.Methods">
<title>Methods</title>
<variablelist>
<varlistentry id="FirewallD1.config.icmptype.Methods.addDestination">
<term><methodname>addDestination</methodname>(s: destination) → Nothing</term>
<listitem>
<para>
Permanently add a <replaceable>destination</replaceable> ('ipv4' or 'ipv6') to list of destinations of this icmp type.
See <literal>destination</literal> tag in <citerefentry><refentrytitle>firewalld.icmptype</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
<para>
Possible errors: ALREADY_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.icmptype.Methods.getDescription">
<term><methodname>getDescription</methodname>() → s</term>
<listitem>
<para>
Get description of icmp type.
See <literal>description</literal> tag in <citerefentry><refentrytitle>firewalld.icmptype</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.icmptype.Methods.getDestinations">
<term><methodname>getDestinations</methodname>() → as</term>
<listitem>
<para>
Get list of destinations.
See <literal>destination</literal> tag in <citerefentry><refentrytitle>firewalld.icmptype</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.icmptype.Methods.getSettings">
<term><methodname>getSettings</methodname>() → (sssas)</term>
<listitem>
<para>
Return permanent settings of <replaceable>icmp type</replaceable>.
For getting runtime settings see <link linkend="FirewallD1.Methods.getIcmpTypeSettings">org.fedoraproject.FirewallD1.Methods.getIcmpTypeSettings</link>.
Settings are in format: <parameter>version</parameter>, <parameter>name</parameter>, <parameter>description</parameter>, array of <parameter>destinations</parameter>.
</para>
<para>
<variablelist>
<varlistentry><term><parameter>version (s)</parameter>: see <literal>version</literal> attribute of <literal>icmptype</literal> tag in <citerefentry><refentrytitle>firewalld.icmptype</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>name (s)</parameter>: see <literal>short</literal> tag in <citerefentry><refentrytitle>firewalld.icmptype</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>description (s)</parameter>: see <literal>description</literal> tag in <citerefentry><refentrytitle>firewalld.icmptype</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>destinations (as)</parameter>: array, either empty or containing strings 'ipv4' and/or 'ipv6', see destination tag in <citerefentry><refentrytitle>firewalld.icmptype</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
</variablelist>
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.icmptype.Methods.getShort">
<term><methodname>getShort</methodname>() → s</term>
<listitem>
<para>
Get name of icmp type.
See <literal>short</literal> tag in <citerefentry><refentrytitle>firewalld.icmptype</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.icmptype.Methods.getVersion">
<term><methodname>getVersion</methodname>() → s</term>
<listitem>
<para>
Get version of icmp type.
See <literal>version</literal> attribute of <literal>icmptype</literal> tag in <citerefentry><refentrytitle>firewalld.icmptype</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.icmptype.Methods.loadDefaults">
<term><methodname>loadDefaults</methodname>() → Nothing</term>
<listitem>
<para>
Load default settings for built-in icmp type.
</para>
<para>
Possible errors: NO_DEFAULTS
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.icmptype.Methods.queryDestination">
<term><methodname>queryDestination</methodname>(s: destination) → b</term>
<listitem>
<para>
Return whether a <replaceable>destination</replaceable> ('ipv4' or 'ipv6') is in list of destinations of this icmp type.
See <literal>destination</literal> tag in <citerefentry><refentrytitle>firewalld.icmptype</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.icmptype.Methods.remove">
<term><methodname>remove</methodname>() → Nothing</term>
<listitem>
<para>
Remove not built-in icmp type.
</para>
<para>
Possible errors: BUILTIN_ICMPTYPE
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.icmptype.Methods.removeDestination">
<term><methodname>removeDestination</methodname>(s: destination) → Nothing</term>
<listitem>
<para>
Permanently remove a <replaceable>destination</replaceable> ('ipv4' or 'ipv6') from list of destinations of this icmp type.
See <literal>destination</literal> tag in <citerefentry><refentrytitle>firewalld.icmptype</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
<para>
Possible errors: NOT_ENABLED
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.icmptype.Methods.rename">
<term><methodname>rename</methodname>(s: name) → Nothing</term>
<listitem>
<para>
Rename not built-in icmp type to <replaceable>name</replaceable>.
</para>
<para>
Possible errors: BUILTIN_ICMPTYPE
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.icmptype.Methods.setDescription">
<term><methodname>setDescription</methodname>(s: description) → Nothing</term>
<listitem>
<para>
Permanently set description of icmp type to <replaceable>description</replaceable>.
See <literal>description</literal> tag in <citerefentry><refentrytitle>firewalld.icmptype</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.icmptype.Methods.setDestinations">
<term><methodname>setDestinations</methodname>(as: destinations) → Nothing</term>
<listitem>
<para>
Permanently set destinations of icmp type to <replaceable>destinations</replaceable>, which is array, either empty or containing strings 'ipv4' and/or 'ipv6'.
See <literal>destination</literal> tag in <citerefentry><refentrytitle>firewalld.icmptype</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.icmptype.Methods.setShort">
<term><methodname>setShort</methodname>(s: short) → Nothing</term>
<listitem>
<para>
Permanently set name of icmp type to <replaceable>short</replaceable>.
See <literal>short</literal> tag in <citerefentry><refentrytitle>firewalld.icmptype</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.icmptype.Methods.setVersion">
<term><methodname>setVersion</methodname>(s: version) → Nothing</term>
<listitem>
<para>
Permanently set version of icmp type to <replaceable>version</replaceable>.
See <literal>version</literal> attribute of <literal>icmptype</literal> tag in <citerefentry><refentrytitle>firewalld.icmptype</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.icmptype.Methods.update">
<term><methodname>update</methodname>((sssas): settings) → Nothing</term>
<listitem>
<para>
Update permanent settings of icmp type to <replaceable>settings</replaceable>.
Settings are in format: <parameter>version</parameter>, <parameter>name</parameter>, <parameter>description</parameter>, array of <parameter>destinations</parameter>.
</para>
<para>
<variablelist>
<varlistentry><term><parameter>version (s)</parameter>: see <literal>version</literal> attribute of <literal>icmptype</literal> tag in <citerefentry><refentrytitle>firewalld.icmptype</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>name (s)</parameter>: see <literal>short</literal> tag in <citerefentry><refentrytitle>firewalld.icmptype</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>description (s)</parameter>: see <literal>description</literal> tag in <citerefentry><refentrytitle>firewalld.icmptype</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
<varlistentry><term><parameter>destinations (as)</parameter>: array, either empty or containing strings 'ipv4' and/or 'ipv6', see destination tag in <citerefentry><refentrytitle>firewalld.icmptype</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</term></varlistentry>
</variablelist>
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect3>
<refsect3 id="FirewallD1.config.icmptype.Signals">
<title>Signals</title>
<variablelist>
<varlistentry id="FirewallD1.config.icmptype.Signals.Removed">
<term>Removed(s: name)</term>
<listitem>
<para>
Emitted when icmp type with <replaceable>name</replaceable> has been removed.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.icmptype.Signals.Renamed">
<term>Renamed(s: name)</term>
<listitem>
<para>
Emitted when icmp type has been renamed to <replaceable>name</replaceable>.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.icmptype.Signals.Updated">
<term>Updated(s: name)</term>
<listitem>
<para>
Emitted when icmp type with <replaceable>name</replaceable> has been updated.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect3>
<refsect3 id="FirewallD1.config.icmptype.Properties">
<title>Properties</title>
<variablelist>
<varlistentry id="FirewallD1.config.icmptype.Properties.builtin">
<term>builtin - b - (ro)</term>
<listitem>
<para>
True if icmptype is build-in, false else.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.icmptype.Properties.default">
<term>default - b - (ro)</term>
<listitem>
<para>
True if build-in icmp type has default settings. False if it has been modified. Always False for not build-in zones.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.icmptype.Properties.filename">
<term>filename - s - (ro)</term>
<listitem>
<para>
Name (including .xml extension) of file where the configuration is stored.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.icmptype.Properties.name">
<term>name - s - (ro)</term>
<listitem>
<para>
Name of icmp type.
</para>
</listitem>
</varlistentry>
<varlistentry id="FirewallD1.config.icmptype.Properties.path">
<term>path - s - (ro)</term>
<listitem>
<para>
Path to directory where the icmp type configuration is stored. Should be either /usr/lib/firewalld/icmptypes or /etc/firewalld/icmptypes.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect3>
</refsect2>
</refsect1>
&seealso;
¬es;
</refentry>