Scroll to navigation

FIREWALLD.DBUS(5) firewalld.dbus FIREWALLD.DBUS(5)

NAME

firewalld.dbus - firewalld D-Bus interface description

OBJECT PATHS

This is the basic firewalld object path structure. The used interfaces are explained below in the section called “INTERFACES”.
/org/fedoraproject/FirewallD1
  Interfaces
    org.fedoraproject.FirewallD1
    org.fedoraproject.FirewallD1.direct
    org.fedoraproject.FirewallD1.policies
    org.fedoraproject.FirewallD1.zone
    org.freedesktop.DBus.Introspectable
    org.freedesktop.DBus.Properties
/org/fedoraproject/FirewallD1/config Interfaces org.fedoraproject.FirewallD1.config org.fedoraproject.FirewallD1.config.direct org.fedoraproject.FirewallD1.config.policies org.freedesktop.DBus.Introspectable org.freedesktop.DBus.Properties
/org/fedoraproject/FirewallD1/config/zone/i Interfaces org.fedoraproject.FirewallD1.config.zone org.freedesktop.DBus.Introspectable org.freedesktop.DBus.Properties
/org/fedoraproject/FirewallD1/config/service/i Interfaces: org.fedoraproject.FirewallD1.config.service org.freedesktop.DBus.Introspectable org.freedesktop.DBus.Properties
/org/fedoraproject/FirewallD1/config/icmptype/i Interfaces org.fedoraproject.FirewallD1.config.icmptype org.freedesktop.DBus.Introspectable org.freedesktop.DBus.Properties

INTERFACES

org.fedoraproject.FirewallD1

This interface contains general runtime operations, like: reloading, panic mode, default zone handling, getting services and icmp types and their settings.
 
Methods
 
completeReload() → Nothing
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.
enablePanicMode() → Nothing
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.
Possible errors: ALREADY_ENABLED, COMMAND_FAILED
disablePanicMode() → Nothing
Disable panic mode. After disabling panic mode established connections might work again, if panic mode was enabled for a short period of time.
Possible errors: NOT_ENABLED, COMMAND_FAILED
getDefaultZone() → s
Return default zone.
getIcmpTypeSettings(s: icmptype) → (sssas)
Return runtime settings of given icmptype. For getting permanent settings see org.fedoraproject.FirewallD1.config.icmptype.Methods.getSettings. Settings are in format: version, name, description, array of destinations.
version (s): see version attribute of icmptype tag in firewalld.icmptype(5).
name (s): see short tag in firewalld.icmptype(5).
description (s): see description tag in firewalld.icmptype(5).
destinations (as): array, either empty or containing strings 'ipv4' or 'ipv6', see destination tag in firewalld.icmptype(5).
Possible errors: INVALID_ICMPTYPE
getServiceSettings(s: service) → (sssa(ss)asa{ss})
Return runtime settings of given service. For getting permanent settings see org.fedoraproject.FirewallD1.config.service.Methods.getSettings. Settings are in format: version, name, description, array of ports (port, protocol), array of module names, dictionary of destinations.
version (s): see version attribute of service tag in firewalld.service(5).
name (s): see short tag in firewalld.service(5).
description (s): see description tag in firewalld.service(5).
ports (a(ss)): array of port and protocol pairs. See port tag in firewalld.service(5).
module names (as): array of kernel netfilter helpers, see module tag in firewalld.service(5).
destinations (a{ss}): dictionary of {IP family : IP address} where 'IP family' key can be either 'ipv4' or 'ipv6'. See destination tag in firewalld.service(5).
Possible errors: INVALID_SERVICE
getZoneSettings(s: zone) → (sssbsasa(ss)asba(ssss)asasas)
Return runtime settings of given zone. For getting permanent settings see org.fedoraproject.FirewallD1.config.zone.Methods.getSettings. Settings are in format: version, name, description, UNUSED, target, array of services, array of ports (port, protocol), array of icmp-blocks, masquerade, array of forward-ports (port, protocol, to-port, to-addr), array of interfaces, array of sources, array of rich rules
version (s): see version attribute of zone tag in firewalld.zone(5).
name (s): see short tag in firewalld.zone(5).
description (s): see description tag in firewalld.zone(5).
UNUSED (b): this boolean value is no longer used for anything.
target (s): see target attribute of zone tag in firewalld.zone(5).
services (as): array of service names, see service tag in firewalld.zone(5).
ports (a(ss)): array of port and protocol pairs. See port tag in firewalld.zone(5).
icmp-blocks (as): array of icmp-blocks. See icmp-block tag in firewalld.zone(5).
masquerade (b): see masquerade tag in firewalld.zone(5).
forward-ports (a(ssss)): array of (port, protocol, to-port, to-addr). See forward-port tag in firewalld.zone(5).
interfaces (as): array of interfaces. See interface tag in firewalld.zone(5).
source addresses (as): array of source addresses. See source tag in firewalld.zone(5).
rich rules (as): array of rich-language rules. See rule tag in firewalld.zone(5).
Possible errors: INVALID_ZONE
listIcmpTypes() → as
Return array of names (s) of icmp types in runtime configuration. For permanent configuration see org.fedoraproject.FirewallD1.config.Methods.listIcmpTypes.
listServices() → as
Return array of service names (s) in runtime configuration. For permanent configuration see org.fedoraproject.FirewallD1.config.Methods.listServices.
queryPanicMode() → b
Return true if panic mode is enabled, false otherwise. In panic mode all incoming and outgoing packets are dropped.
reload() → Nothing
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.
setDefaultZone(s: zone) → Nothing
Set default zone for connections and interfaces where no zone has been selected to zone. 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.
Possible errors: ZONE_ALREADY_SET, COMMAND_FAILED
runtimeToPermanent() → Nothing
Make runtime settings permanent. Replaces permanent settings with runtime settings for zones, services, icmptypes, direct and policies (lockdown whitelist).
Possible errors: RT_TO_PERM_FAILED
 
Signals
 
DefaultZoneChanged(s: zone)
Emitted when default zone has been changed to zone.
PanicModeDisabled()
Emitted when panic mode has been deactivated.
PanicModeEnabled()
Emitted when panic mode has been activated.
Reloaded()
Emitted when firewalld has been reloaded. Also emitted for a complete reload.
 
Properties
 
BRIDGE - b - (ro)
Indicates whether the firewall has ethernet bridge support.
IPv4 - b - (ro)
Indicates whether the firewall has IPv4 support.
IPv6 - b - (ro)
Indicates whether the firewall has IPv6 support.
interface_version - s - (ro)
firewalld D-Bus interface version string.
state - s - (ro)
firewalld state. This can be either INIT or RUNNING. In INIT state, firewalld is starting up and initializing.
version - s - (ro)
firewalld version string.

org.fedoraproject.FirewallD1.direct

This interface enables more direct access to the firewall. It enables runtime manipulation with chains and rules. For permanent configuration see org.fedoraproject.FirewallD1.config.direct interface.
 
Methods
 
addChain(s: ipv, s: table, s: chain) → Nothing
Add a new chain to table for ipv being either ipv4 (iptables) or ipv6 (ip6tables) or eb (ebtables). Make sure there's no other chain with this name already. There already exist basic chains to use with direct methods, for example INPUT_direct chain. These chains are jumped into before chains for zones, i.e. every rule put into INPUT_direct will be checked before rules in zones. For permanent operation see org.fedoraproject.FirewallD1.config.direct.Methods.addChain.
Possible errors: INVALID_IPV, INVALID_TABLE, ALREADY_ENABLED, COMMAND_FAILED
addPassthrough(s: ipv, as: args) → Nothing
Add a tracked passthrough rule with the arguments args for ipv being either ipv4 (iptables) or ipv6 (ip6tables) or eb (ebtables). For permanent operation see org.fedoraproject.FirewallD1.config.direct.Methods.addPassthrough.
Possible errors: INVALID_IPV, ALREADY_ENABLED, COMMAND_FAILED
addRule(s: ipv, s: table, s: chain, i: priority, as: args) → Nothing
Add a rule with the arguments args to chain in table with priority for ipv being either ipv4 (iptables) or ipv6 (ip6tables) or eb (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 org.fedoraproject.FirewallD1.config.direct.Methods.addRule.
Possible errors: INVALID_IPV, INVALID_TABLE, ALREADY_ENABLED, COMMAND_FAILED
getAllChains() → a(sss)
Get all chains added to all tables in format: ipv, table, chain. This concerns only chains previously added with addChain. Return value is a array of ( ipv, table, chain). For permanent operation see org.fedoraproject.FirewallD1.config.direct.Methods.getAllChains.
ipv (s): either ipv4 (iptables) or ipv6 (ip6tables) or eb (ebtables).
table (s): one of filter, mangle, nat, raw, security
chain (s): name of a chain.
getAllPassthroughs() → a(sas)
Get all tracked passthrough rules added in all ipv types in format: ipv, rule. This concerns only rules previously added with addPassthrough. Return value is a array of ( ipv, array of arguments). For permanent operation see org.fedoraproject.FirewallD1.config.direct.Methods.getAllPassthroughs.
ipv (s): either ipv4 (iptables) or ipv6 (ip6tables) or eb (ebtables).
arguments (as): array of commands, parameters and other iptables/ip6tables/ebtables command line options.
getAllRules() → a(sssias)
Get all rules added to all chains in all tables in format: ipv, table, chain, priority, rule. This concerns only rules previously added with addRule. Return value is a array of ( ipv, table, chain, priority, array of arguments). For permanent operation see org.fedoraproject.FirewallD1.config.direct.Methods.getAllRules.
ipv (s): either ipv4 (iptables) or ipv6 (ip6tables) or eb (ebtables).
table (s): one of filter, mangle, nat, raw, security
chain (s): name of a chain.
priority (i): used to order rules.
arguments (as): array of commands, parameters and other iptables/ip6tables/ebtables command line options.
getChains(s: ipv, s: table) → as
Return an array of chains (s) added to table for ipv being either ipv4 (iptables) or ipv6 (ip6tables) or eb (ebtables). This concerns only chains previously added with addChain. For permanent operation see org.fedoraproject.FirewallD1.config.direct.Methods.getChains.
Possible errors: INVALID_IPV, INVALID_TABLE
getRules(s: ipv, s: table, s: chain) → a(ias)
Get all rules added to chain in table for ipv being either ipv4 (iptables) or ipv6 (ip6tables) or eb (ebtables). This concerns only rules previously added with addRule. Return value is a array of ( priority, array of arguments). For permanent operation see org.fedoraproject.FirewallD1.config.direct.Methods.getRules.
priority (i): used to order rules.
arguments (as): array of commands, parameters and other iptables/ip6tables/ebtables command line options.
Possible errors: INVALID_IPV, INVALID_TABLE
queryChain(s: ipv, s: table, s: chain) → b
Return whether a chain exists in table for ipv being either ipv4 (iptables) or ipv6 (ip6tables) or eb (ebtables). This concerns only chains previously added with addChain. For permanent operation see org.fedoraproject.FirewallD1.config.direct.Methods.queryChain.
Possible errors: INVALID_IPV, INVALID_TABLE
queryPassthrough(s: ipv, as: args) → b
Return whether a tracked passthrough rule with the arguments args exists for ipv being either ipv4 (iptables) or ipv6 (ip6tables) or eb (ebtables). This concerns only rules previously added with addPassthrough. For permanent operation see org.fedoraproject.FirewallD1.config.direct.Methods.queryPassthrough.
Possible errors: INVALID_IPV
queryRule(s: ipv, s: table, s: chain, i: priority, as: args) → b
Return whether a rule with priority and the arguments args exists in chain in table for ipv being either ipv4 (iptables) or ipv6 (ip6tables) or eb (ebtables). This concerns only rules previously added with addRule. For permanent operation see org.fedoraproject.FirewallD1.config.direct.Methods.queryRule.
Possible errors: INVALID_IPV, INVALID_TABLE
removeChain(s: ipv, s: table, s: chain) → Nothing
Remove a chain from table for ipv being either ipv4 (iptables) or ipv6 (ip6tables) or eb (ebtables). Only chains previously added with addChain can be removed this way. For permanent operation see org.fedoraproject.FirewallD1.config.direct.Methods.removeChain.
Possible errors: INVALID_IPV, INVALID_TABLE, NOT_ENABLED, COMMAND_FAILED
removeRule(s: ipv, s: table, s: chain, i: priority, as: args) → Nothing
Remove a rule with priority and arguments args from chain in table for ipv being either ipv4 (iptables) or ipv6 (ip6tables) or eb (ebtables). Only rules previously added with addRule can be removed this way. For permanent operation see org.fedoraproject.FirewallD1.config.direct.Methods.removeRule.
Possible errors: INVALID_IPV, INVALID_TABLE, NOT_ENABLED, COMMAND_FAILED
removePassthrough(s: ipv, as: args) → Nothing
Remove a tracked passthrough rule with arguments args for ipv being either ipv4 (iptables) or ipv6 (ip6tables) or eb (ebtables). Only rules previously added with addPassthrough can be removed this way. For permanent operation see org.fedoraproject.FirewallD1.config.direct.Methods.removePassthrough.
Possible errors: INVALID_IPV, NOT_ENABLED, COMMAND_FAILED
removeRules(s: ipv, s: table, s: chain) → Nothing
Remove all rules from chain in table for ipv being either ipv4 (iptables) or ipv6 (ip6tables) or eb (ebtables). This concerns only rules previously added with addRule.
Possible errors: INVALID_IPV, INVALID_TABLE
passthrough(s: ipv, as: args) → s
Pass a command through to the firewall. ipv can be either ipv4 (iptables) or ipv6 (ip6tables) or eb (ebtables). args can be all iptables, ip6tables and ebtables command line arguments. args 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.
Possible errors: COMMAND_FAILED
 
Signals
 
ChainAdded(s: ipv, s: table, s: chain)
Emitted when chain has been added into table for ipv being either ipv4 (iptables) or ipv6 (ip6tables) or eb (ebtables).
ChainRemoved(s: ipv, s: table, s: chain)
Emitted when chain has been removed from table for ipv being either ipv4 (iptables) or ipv6 (ip6tables) or eb (ebtables).
PassthroughAdded(s: ipv, as: args)
Emitted when a tracked passthruogh rule with args has been added for ipv being either ipv4 (iptables) or ipv6 (ip6tables) or eb (ebtables).
PassthroughRemoved(s: ipv, as: args)
Emitted when a tracked passthrough rule with args has been removed for ipv being either ipv4 (iptables) or ipv6 (ip6tables) or eb (ebtables).
RuleAdded(s: ipv, s: table, s: chain, i: priority, as: args)
Emitted when a rule with args has been added to chain in table with priority for ipv being either ipv4 (iptables) or ipv6 (ip6tables) or eb (ebtables).
RuleRemoved(s: ipv, s: table, s: chain, i: priority, as: args)
Emitted when a rule with args has been removed from chain in table with priority for ipv being either ipv4 (iptables) or ipv6 (ip6tables) or eb (ebtables).

org.fedoraproject.FirewallD1.policies

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 org.fedoraproject.FirewallD1.config.policies interface.
 
Methods
 
addLockdownWhitelistCommand(s: command) → Nothing
Add command to whitelist. See command option in firewalld.lockdown-whitelist(5). For permanent operation see org.fedoraproject.FirewallD1.config.policies.Methods.addLockdownWhitelistCommand.
Possible errors: ALREADY_ENABLED, INVALID_COMMAND
addLockdownWhitelistContext(s: context) → Nothing
Add context to whitelist. See selinux option in firewalld.lockdown-whitelist(5). For permanent operation see org.fedoraproject.FirewallD1.config.policies.Methods.addLockdownWhitelistContext.
Possible errors: ALREADY_ENABLED, INVALID_COMMAND
addLockdownWhitelistUid(i: uid) → Nothing
Add user id uid to whitelist. See user option in firewalld.lockdown-whitelist(5). For permanent operation see org.fedoraproject.FirewallD1.config.policies.Methods.addLockdownWhitelistUid.
Possible errors: ALREADY_ENABLED, INVALID_COMMAND
addLockdownWhitelistUser(s: user) → Nothing
Add user name to whitelist. See user option in firewalld.lockdown-whitelist(5). For permanent operation see org.fedoraproject.FirewallD1.config.policies.Methods.addLockdownWhitelistUser.
Possible errors: ALREADY_ENABLED, INVALID_COMMAND
disableLockdown() → Nothing
Disable lockdown. This is a runtime and permanent change.
Possible errors: NOT_ENABLED
enableLockdown() → Nothing
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.
Possible errors: ALREADY_ENABLED
getLockdownWhitelistCommands() → as
List all command lines (s) that are on whitelist. For permanent operation see org.fedoraproject.FirewallD1.config.policies.Methods.getLockdownWhitelistCommands.
getLockdownWhitelistContexts() → as
List all contexts (s) that are on whitelist. For permanent operation see org.fedoraproject.FirewallD1.config.policies.Methods.getLockdownWhitelistContexts.
getLockdownWhitelistUids() → ai
List all user ids (i) that are on whitelist. For permanent operation see org.fedoraproject.FirewallD1.config.policies.Methods.getLockdownWhitelistUids.
getLockdownWhitelistUsers() → as
List all users (s) that are on whitelist. For permanent operation see org.fedoraproject.FirewallD1.config.policies.Methods.getLockdownWhitelistUsers.
queryLockdown() → b
Query whether lockdown is enabled.
queryLockdownWhitelistCommand(s: command) → b
Query whether command is on whitelist. For permanent operation see org.fedoraproject.FirewallD1.config.policies.Methods.queryLockdownWhitelistCommand.
queryLockdownWhitelistContext(s: context) → b
Query whether context is on whitelist. For permanent operation see org.fedoraproject.FirewallD1.config.policies.Methods.queryLockdownWhitelistContext.
queryLockdownWhitelistUid(i: uid) → b
Query whether user id uid is on whitelist. For permanent operation see org.fedoraproject.FirewallD1.config.policies.Methods.queryLockdownWhitelistUid.
queryLockdownWhitelistUser(s: user) → b
Query whether user is on whitelist. For permanent operation see org.fedoraproject.FirewallD1.config.policies.Methods.queryLockdownWhitelistUser.
removeLockdownWhitelistCommand(s: command) → Nothing
Remove command from whitelist. For permanent operation see org.fedoraproject.FirewallD1.config.policies.Methods.removeLockdownWhitelistCommand.
Possible errors: NOT_ENABLED
removeLockdownWhitelistContext(s: context) → Nothing
Remove context from whitelist. For permanent operation see org.fedoraproject.FirewallD1.config.policies.Methods.removeLockdownWhitelistContext.
Possible errors: NOT_ENABLED
removeLockdownWhitelistUid(i: uid) → Nothing
Remove user id uid from whitelist. For permanent operation see org.fedoraproject.FirewallD1.config.policies.Methods.removeLockdownWhitelistUid.
Possible errors: NOT_ENABLED
removeLockdownWhitelistUser(s: user) → Nothing
Remove user from whitelist. For permanent operation see org.fedoraproject.FirewallD1.config.policies.Methods.removeLockdownWhitelistUser.
Possible errors: NOT_ENABLED
 
Signals
 
LockdownDisabled()
Emitted when lockdown has been disabled.
LockdownEnabled()
Emitted when lockdown has been enabled.
LockdownWhitelistCommandAdded(s: command)
Emitted when command has been added to whitelist.
LockdownWhitelistCommandRemoved(s: command)
Emitted when command has been removed from whitelist.
LockdownWhitelistContextAdded(s: context)
Emitted when context has been added to whitelist.
LockdownWhitelistContextRemoved(s: context)
Emitted when context has been removed from whitelist.
LockdownWhitelistUidAdded(i: uid)
Emitted when user id uid has been added to whitelist.
LockdownWhitelistUidRemoved(i: uid)
Emitted when user id uid has been removed from whitelist.
LockdownWhitelistUserAdded(s: user)
Emitted when user has been added to whitelist.
LockdownWhitelistUserRemoved(s: user)
Emitted when user has been removed from whitelist.

org.fedoraproject.FirewallD1.zone

Operations in this interface allows to get, add, remove and query runtime zone's settings. For permanent settings see org.fedoraproject.FirewallD1.config.zone interface.
 
Methods
 
addForwardPort(s: zone, s: port, s: protocol, s: toport, s: toaddr, i: timeout) → s
Add the IPv4 forward port into zone. If zone is empty, use default zone. The port can either be a single port number portid or a port range portid-portid. The protocol can either be tcp or udp. The destination address is a simple IP address. If timeout is non-zero, the operation will be active only for the amount of seconds. For permanent settings see org.fedoraproject.FirewallD1.config.zone.Methods.addForwardPort.
Returns name of zone to which the forward port was added.
Possible errors: INVALID_ZONE, INVALID_PORT, MISSING_PROTOCOL, INVALID_PROTOCOL, INVALID_ADDR, INVALID_FORWARD, ALREADY_ENABLED, INVALID_COMMAND
addIcmpBlock(s: zone, s: icmp, i: timeout) → s
Add an ICMP block icmp into zone. The icmp is the one of the icmp types firewalld supports. To get a listing of supported icmp types use org.fedoraproject.FirewallD1.Methods.listIcmpTypes If zone is empty, use default zone. If timeout is non-zero, the operation will be active only for the amount of seconds. For permanent settings see org.fedoraproject.FirewallD1.config.zone.Methods.addIcmpBlock.
Returns name of zone to which the ICMP block was added.
Possible errors: INVALID_ZONE, INVALID_ICMPTYPE, ALREADY_ENABLED, INVALID_COMMAND
addInterface(s: zone, s: interface) → s
Bind interface with zone. From now on all traffic going through the interface will respect the zone's settings. If zone is empty, use default zone. For permanent settings see org.fedoraproject.FirewallD1.config.zone.Methods.addInterface.
Returns name of zone to which the interface was bound.
Possible errors: INVALID_ZONE, INVALID_INTERFACE, ALREADY_ENABLED, INVALID_COMMAND
addMasquerade(s: zone, i: timeout) → s
Enable IPv4 masquerade in zone. If zone is empty, use default zone. If timeout is non-zero, masquerading will be active for the amount of seconds. For permanent settings see org.fedoraproject.FirewallD1.config.zone.Methods.addMasquerade.
Returns name of zone in which the masquerade was enabled.
Possible errors: INVALID_ZONE, ALREADY_ENABLED, INVALID_COMMAND
addPort(s: zone, s: port, s: protocol, i: timeout) → s
Add port into zone. If zone is empty, use default zone. The port can either be a single port number or a port range portid- portid. The protocol can either be tcp or udp. If timeout is non-zero, the operation will be active only for the amount of seconds. For permanent settings see org.fedoraproject.FirewallD1.config.zone.Methods.addPort.
Returns name of zone to which the port was added.
Possible errors: INVALID_ZONE, INVALID_PORT, MISSING_PROTOCOL, INVALID_PROTOCOL, ALREADY_ENABLED, INVALID_COMMAND
addRichRule(s: zone, s: rule, i: timeout) → s
Add rich language rule into zone. For the rich language rule syntax, please have a look at firewalld.direct(5). If zone is empty, use default zone. If timeout is non-zero, the operation will be active only for the amount of seconds. For permanent settings see org.fedoraproject.FirewallD1.config.zone.Methods.addRichRule.
Returns name of zone to which the rich language rule was added.
Possible errors: INVALID_ZONE, INVALID_RULE, ALREADY_ENABLED, INVALID_COMMAND
addService(s: zone, s: service, i: timeout) → s
Add service into zone. If zone is empty, use default zone. If timeout is non-zero, the operation will be active only for the amount of seconds. To get a list of supported services, use org.fedoraproject.FirewallD1.Methods.listServices. For permanent settings see org.fedoraproject.FirewallD1.config.zone.Methods.addService.
Returns name of zone to which the service was added.
Possible errors: INVALID_ZONE, INVALID_SERVICE, ALREADY_ENABLED, INVALID_COMMAND
addSource(s: zone, s: source) → s
Bind source with zone. From now on all traffic going from this source will respect the zone'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 zone is empty, use default zone. For permanent settings see org.fedoraproject.FirewallD1.config.zone.Methods.addSource.
Returns name of zone to which the source was bound.
Possible errors: INVALID_ZONE, INVALID_ADDR, ALREADY_ENABLED, INVALID_COMMAND
changeZone(s: zone, s: interface) → s
This function is deprecated, use org.fedoraproject.FirewallD1.zone.Methods.changeZoneOfInterface instead.
changeZoneOfInterface(s: zone, s: interface) → s
Change a zone an interface is bound to to zone. It's basically removeInterface( interface) followed by addInterface( zone, interface). If interface has not been bound to a zone before, it behaves like addInterface. If zone is empty, use default zone.
Returns name of zone to which the interface was bound.
Possible errors: INVALID_ZONE, ZONE_ALREADY_SET, ZONE_CONFLICT
changeZoneOfSource(s: zone, s: source) → s
Change a zone an source is bound to to zone. It's basically removeSource( source) followed by addSource( zone, source). If source has not been bound to a zone before, it behaves like addSource. If zone is empty, use default zone.
Returns name of zone to which the source was bound.
Possible errors: INVALID_ZONE, ZONE_ALREADY_SET, ZONE_CONFLICT
getActiveZones() → a{sa{sas}}
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.
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).
getForwardPorts(s: zone) → aas
Return array of IPv4 forward ports previously added into zone. If zone is empty, use default zone. For getting permanent settings see org.fedoraproject.FirewallD1.config.zone.Methods.getForwardPorts.
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.
Possible errors: INVALID_ZONE
getIcmpBlocks(s: zone) → as
Return array of ICMP type (s) blocks previously added into zone. If zone is empty, use default zone. For getting permanent settings see org.fedoraproject.FirewallD1.config.zone.Methods.getIcmpBlocks.
Possible errors: INVALID_ZONE
getInterfaces(s: zone) → as
Return array of interfaces (s) previously bound with zone. If zone is empty, use default zone. For getting permanent settings see org.fedoraproject.FirewallD1.config.zone.Methods.getInterfaces.
Possible errors: INVALID_ZONE
getPorts(s: zone) → aas
Return array of ports (2-tuple of port and protocol) previously enabled in zone. If zone is empty, use default zone. For getting permanent settings see org.fedoraproject.FirewallD1.config.zone.Methods.getPorts.
Possible errors: INVALID_ZONE
getRichRules(s: zone) → as
Return array of rich language rules (s) previously added into zone. If zone is empty, use default zone. For getting permanent settings see org.fedoraproject.FirewallD1.config.zone.Methods.getRichRules.
Possible errors: INVALID_ZONE
getServices(s: zone) → as
Return array of services (s) previously enabled in zone. If zone is empty, use default zone. For getting permanent settings see org.fedoraproject.FirewallD1.config.zone.Methods.getServices.
Possible errors: INVALID_ZONE
getSources(s: zone) → as
Return array of sources (s) previously bound with zone. If zone is empty, use default zone. For getting permanent settings see org.fedoraproject.FirewallD1.config.zone.Methods.getSources.
Possible errors: INVALID_ZONE
getZoneOfInterface(s: interface) → s
Return name (s) of zone the interface is bound to or empty string.
getZoneOfSource(s: source) → s
Return name (s) of zone the source is bound to or empty string.
getZones() → as
Return array of names (s) of predefined zones known to current runtime environment. For list of zones known to permanent environment see org.fedoraproject.FirewallD1.config.Methods.listZones. The lists (of zones known to runtime and permanent environment) will contain same zones in most cases, but might differ for example if org.fedoraproject.FirewallD1.config.Methods.addZone has been called recently, but firewalld has not been reloaded since then.
isImmutable(s: zone) → b
Deprecated.
queryForwardPort(s: zone, s: port, s: protocol, s: toport, s: toaddr) → b
Return whether the IPv4 forward port (port, protocol, toport, toaddr) has been added into zone. If zone is empty, use default zone. For permanent operation see org.fedoraproject.FirewallD1.config.zone.Methods.queryForwardPort.
Possible errors: INVALID_ZONE, INVALID_PORT, MISSING_PROTOCOL, INVALID_PROTOCOL, INVALID_ADDR, INVALID_FORWARD
queryIcmpBlock(s: zone, s: icmp) → b
Return whether an ICMP block for icmp has been added into zone. If zone is empty, use default zone. For permanent operation see org.fedoraproject.FirewallD1.config.zone.Methods.queryIcmpBlock.
Possible errors: INVALID_ZONE, INVALID_ICMPTYPE
queryInterface(s: zone, s: interface) → b
Query whether interface has been bound to zone. If zone is empty, use default zone. For permanent operation see org.fedoraproject.FirewallD1.config.zone.Methods.queryInterface.
Possible errors: INVALID_ZONE, INVALID_INTERFACE
queryMasquerade(s: zone) → b
Return whether IPv4 masquerading has been enabled in zone If zone is empty, use default zone. For permanent operation see org.fedoraproject.FirewallD1.config.zone.Methods.queryMasquerade.
Possible errors: INVALID_ZONE
queryPort(s: zone, s: port, s: protocol) → b
Return whether port/protocol has been added in zone. If zone is empty, use default zone. For permanent operation see org.fedoraproject.FirewallD1.config.zone.Methods.queryPort.
Possible errors: INVALID_ZONE, INVALID_PORT, MISSING_PROTOCOL, INVALID_PROTOCOL
queryRichRule(s: zone, s: rule) → b
Return whether rich rule rule has been added in zone. If zone is empty, use default zone. For permanent operation see org.fedoraproject.FirewallD1.config.zone.Methods.queryRichRule.
Possible errors: INVALID_ZONE, INVALID_RULE
queryService(s: zone, s: service) → b
Return whether service has been added for zone. If zone is empty, use default zone. For permanent operation see org.fedoraproject.FirewallD1.config.zone.Methods.queryService.
Possible errors: INVALID_ZONE, INVALID_SERVICE
querySource(s: zone, s: source) → b
Query whether sourcehas been bound to zone. If zone is empty, use default zone. For permanent operation see org.fedoraproject.FirewallD1.config.zone.Methods.querySource.
Possible errors: INVALID_ZONE, INVALID_ADDR
removeForwardPort(s: zone, s: port, s: protocol, s: toport, s: toaddr) → s
Remove IPv4 forward port ((port, protocol, toport, toaddr)) from zone. If zone is empty, use default zone. For permanent operation see org.fedoraproject.FirewallD1.config.zone.Methods.removeForwardPort.
Returns name of zone from which the forward port was removed.
Possible errors: INVALID_ZONE, INVALID_PORT, MISSING_PROTOCOL, INVALID_PROTOCOL, INVALID_ADDR, INVALID_FORWARD, NOT_ENABLED, INVALID_COMMAND
removeIcmpBlock(s: zone, s: icmp) → s
Remove ICMP block icmp from zone. If zone is empty, use default zone. For permanent operation see org.fedoraproject.FirewallD1.config.zone.Methods.removeIcmpBlock.
Returns name of zone from which the ICMP block was removed.
Possible errors: INVALID_ZONE, INVALID_ICMPTYPE, NOT_ENABLED, INVALID_COMMAND
removeInterface(s: zone, s: interface) → s
Remove binding of interface from zone. If zone is empty, the interface will be removed from zone it belongs to. For permanent operation see org.fedoraproject.FirewallD1.config.zone.Methods.removeInterface.
Returns name of zone from which the interface was removed.
Possible errors: INVALID_ZONE, INVALID_INTERFACE, NOT_ENABLED, INVALID_COMMAND
removeMasquerade(s: zone) → s
Disable IPv4 masquerade for zone. If zone is empty, use default zone. For permanent operation see org.fedoraproject.FirewallD1.config.zone.Methods.removeMasquerade.
Returns name of zone for which the masquerade was disabled.
Possible errors: INVALID_ZONE, NOT_ENABLED, INVALID_COMMAND
removePort(s: zone, s: port, s: protocol) → s
Remove port/protocol from zone. If zone is empty, use default zone. For permanent operation see org.fedoraproject.FirewallD1.config.zone.Methods.removePort.
Returns name of zone from which the port was removed.
Possible errors: INVALID_ZONE, INVALID_PORT, MISSING_PROTOCOL, INVALID_PROTOCOL, NOT_ENABLED, INVALID_COMMAND
removeRichRule(s: zone, s: rule) → s
Remove rich language rule from zone. If zone is empty, use default zone. For permanent operation see org.fedoraproject.FirewallD1.config.zone.Methods.removeRichRule.
Returns name of zone from which the rich language rule was removed.
Possible errors: INVALID_ZONE, INVALID_RULE, NOT_ENABLED, INVALID_COMMAND
removeService(s: zone, s: service) → s
Remove service from zone. If zone is empty, use default zone. For permanent operation see org.fedoraproject.FirewallD1.config.zone.Methods.removeService.
Returns name of zone from which the service was removed.
Possible errors: INVALID_ZONE, INVALID_SERVICE, NOT_ENABLED, INVALID_COMMAND
removeSource(s: zone, s: source) → s
Remove binding of source from zone. If zone is empty, the source will be removed from zone it belongs to. For permanent operation see org.fedoraproject.FirewallD1.config.zone.Methods.removeSource.
Returns name of zone from which the source was removed.
Possible errors: INVALID_ZONE, INVALID_ADDR, NOT_ENABLED, INVALID_COMMAND
 
Signals
 
ForwardPortAdded(s: zone, s: port, s: protocol, s: toport, s: toaddr, i: timeout)
Emitted when forward port has been added to zone with timeout.
ForwardPortRemoved(s: zone, s: port, s: protocol, s: toport, s: toaddr)
Emitted when forward port has been removed from zone.
IcmpBlockAdded(s: zone, s: icmp, i: timeout)
Emitted when ICMP block for icmp has been added to zone with timeout.
IcmpBlockRemoved(s: zone, s: icmp)
Emitted when ICMP block for icmp has been removed from zone.
InterfaceAdded(s: zone, s: interface)
Emitted when interface has been added to zone.
InterfaceRemoved(s: zone, s: interface)
Emitted when interface has been removed from zone.
MasqueradeAdded(s: zone, i: timeout)
Emitted when IPv4 masquerade has been enabled for zone.
MasqueradeRemoved(s: zone)
Emitted when IPv4 masquerade has been disabled for zone.
PortAdded(s: zone, s: port, s: protocol, i: timeout)
Emitted when port/protocol has been added to zone with timeout.
PortRemoved(s: zone, s: port, s: protocol)
Emitted when port/protocol has been removed from zone.
RichRuleAdded(s: zone, s: rule, i: timeout)
Emitted when rich language rule has been added to zone with timeout.
RichRuleRemoved(s: zone, s: rule)
Emitted when rich language rule has been removed from zone.
ServiceAdded(s: zone, s: service, i: timeout)
Emitted when service has been added to zone with timeout.
ServiceRemoved(s: zone, s: service)
Emitted when service has been removed from zone.
SourceAdded(s: zone, s: source)
Emitted when source has been added to zone.
SourceRemoved(s: zone, s: source)
Emitted when source has been removed from zone.
ZoneChanged(s: zone, s: interface)
Deprecated
ZoneOfInterfaceChanged(s: zone, s: interface)
Emitted when a zone an interface is part of has been changed to zone.
ZoneOfSourceChanged(s: zone, s: source)
Emitted when a zone an source is part of has been changed to zone.

org.fedoraproject.FirewallD1.config

Allows to permanently add, remove and query zones, services and icmp types.
 
Methods
 
addIcmpType(s: icmptype, (sssas): settings) → o
Add icmptype with given settings into permanent configuration. Settings are in format: version, name, description, array of destinations. Returns object path of the new icmp type.
version (s): see version attribute of icmptype tag in firewalld.icmptype(5).
name (s): see short tag in firewalld.icmptype(5).
description (s): see description tag in firewalld.icmptype(5).
destinations (as): array, either empty or containing strings 'ipv4' or 'ipv6', see destination tag in firewalld.icmptype(5).
Possible errors: NAME_CONFLICT, INVALID_NAME, INVALID_TYPE
addService(s: service, (sssa(ss)asa{ss}): settings) → o
Add service with given settings into permanent configuration. Settings are in format: version, name, description, array of ports (port, protocol), array of module names, dictionary of destinations. Returns object path of the new icmp type.
version (s): see version attribute of service tag in firewalld.service(5).
name (s): see short tag in firewalld.service(5).
description (s): see description tag in firewalld.service(5).
ports (a(ss)): array of port and protocol pairs. See port tag in firewalld.service(5).
module names (as): array of kernel netfilter helpers, see module tag in firewalld.service(5).
destinations (a{ss}): dictionary of {IP family : IP address} where 'IP family' key can be either 'ipv4' or 'ipv6'. See destination tag in firewalld.service(5).
Possible errors: NAME_CONFLICT, INVALID_NAME, INVALID_TYPE
addZone(s: zone, (sssbsasa(ss)asba(ssss)asasas): settings) → o
Add zone with given settings into permanent configuration. Settings are in format: version, name, description, UNUSED, target, array of services, array of ports (port, protocol), array of icmp-blocks, masquerade, array of forward-ports (port, protocol, to-port, to-addr), array of interfaces, array of sources, array of rich rules
version (s): see version attribute of zone tag in firewalld.zone(5).
name (s): see short tag in firewalld.zone(5).
description (s): see description tag in firewalld.zone(5).
UNUSED (b): this boolean value is no longer used for anything.
target (s): see target attribute of zone tag in firewalld.zone(5).
services (as): array of service names, see service tag in firewalld.zone(5).
ports (a(ss)): array of port and protocol pairs. See port tag in firewalld.zone(5).
icmp-blocks (as): array of icmp-blocks. See icmp-block tag in firewalld.zone(5).
masquerade (b): see masquerade tag in firewalld.zone(5).
forward-ports (a(ssss)): array of (port, protocol, to-port, to-addr). See forward-port tag in firewalld.zone(5).
interfaces (as): array of interfaces. See interface tag in firewalld.zone(5).
source addresses (as): array of source addresses. See source tag in firewalld.zone(5).
rich rules (as): array of rich-language rules. See rule tag in firewalld.zone(5).
Possible errors: NAME_CONFLICT, INVALID_NAME, INVALID_TYPE
getIcmpTypeByName(s: icmptype) → o
Return object path (permanent configuration) of icmptype with given name.
Possible errors: INVALID_ICMPTYPE
getServiceByName(s: service) → o
Return object path (permanent configuration) of service with given name.
Possible errors: INVALID_SERVICE
getZoneByName(s: zone) → o
Return object path (permanent configuration) of zone with given name.
Possible errors: INVALID_ZONE
getZoneOfInterface(s: iface) → s
Return name of zone the iface is bound to or empty string.
getZoneOfSource(s: source) → s
Return name of zone the source is bound to or empty string.
listIcmpTypes() → ao
Return array of object paths (o) of icmp types in permanent configuration. For runtime configuration see org.fedoraproject.FirewallD1.Methods.listIcmpTypes.
listServices() → ao
Return array of objects paths (o) of services in permanent configuration. For runtime configuration see org.fedoraproject.FirewallD1.Methods.listServices.
listZones() → ao
List object paths of zones known to permanent environment. For list of zones known to runtime environment see org.fedoraproject.FirewallD1.zone.Methods.getZones. The lists (of zones known to runtime and permanent environment) will contain same zones in most cases, but might differ for example if org.fedoraproject.FirewallD1.config.Methods.addZone has been called recently, but firewalld has not been reloaded since then.
 
Signals
 
IcmpTypeAdded(s: icmptype)
Emitted when icmptype has been added.
ServiceAdded(s: service)
Emitted when service has been added.
ZoneAdded(s: zone)
Emitted when zone has been added.
 
Properties
 
CleanupOnExit - s - (rw)
If firewalld stops, it cleans up all firewall rules. Setting this option to no or false leaves the current firewall rules untouched.
DefaultZone - s - (ro)
Default zone for connections or interfaces if the zone is not selected or specified by NetworkManager, initscripts or command line tool.
Lockdown - s - (rw)
If this property is enabled, firewall changes with the D-Bus interface will be limited to applications that are listed in the lockdown whitelist.
MinimalMark - i - (rw)
For some firewall settings several rules are needed in different tables to be able to handle packets in the correct way. To achieve that these packets are marked using the MARK target. With the MinimalMark property a block of marks can be reserved for private use; only marks over this value are used.

org.fedoraproject.FirewallD1.config.direct

Interface for permanent direct configuration, see also firewalld.direct(5). For runtime direct configuration see org.fedoraproject.FirewallD1.direct interface.
 
Methods
 
getSettings() → (a(sss)a(sssias)a(sas))
Get settings of permanent direct configuration in format: array of chains, array of rules, array of passthroughs.
chains (a(sss)): array of (ipv, table, chain), see 'chain' in firewalld.direct(5).
.
.PP rules (a(sssias)): array of (ipv, table, chain, priority, array of arguments), see 'rule' in firewalld.direct(5).
.
.PP passthroughs (a(sas)): array of (ipv, array of arguments), see passthrough in firewalld.direct(5).
.
.sp
update((a(sss)a(sssias)a(sas)): settings) → Nothing
Update permanent direct configuration with given settings. Settings are in format: array of chains, array of rules, array of passthroughs.
chains (a(sss)): array of (ipv, table, chain), see 'chain' in firewalld.direct(5).
.
.PP rules (a(sssias)): array of (ipv, table, chain, priority, array of arguments), see 'rule' in firewalld.direct(5).
.
.PP passthroughs (a(sas)): array of (ipv, array of arguments), see passthrough in firewalld.direct(5).
.
.sp Possible errors: INVALID_TYPE
addChain(s: ipv, s: table, s: chain) → Nothing
Add a new chain to table for ipv being either ipv4 (iptables) or ipv6 (ip6tables) or eb (ebtables). Make sure there's no other chain with this name already. There already exist basic chains to use with direct methods, for example INPUT_direct chain. These chains are jumped into before chains for zones, i.e. every rule put into INPUT_direct will be checked before rules in zones. For runtime operation see org.fedoraproject.FirewallD1.direct.Methods.addChain.
Possible errors: INVALID_IPV, INVALID_TABLE, ALREADY_ENABLED
addPassthrough(s: ipv, as: args) → Nothing
Add a passthrough rule with the arguments args for ipv being either ipv4 (iptables) or ipv6 (ip6tables) or eb (ebtables). For runtime operation see org.fedoraproject.FirewallD1.direct.Methods.addPassthrough.
Possible errors: INVALID_IPV, ALREADY_ENABLED
addRule(s: ipv, s: table, s: chain, i: priority, as: args) → Nothing
Add a rule with the arguments args to chain in table with priority for ipv being either ipv4 (iptables) or ipv6 (ip6tables) or eb (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 org.fedoraproject.FirewallD1.direct.Methods.addRule.
Possible errors: INVALID_IPV, INVALID_TABLE, ALREADY_ENABLED
getAllChains() → a(sss)
Get all chains added to all tables in format: ipv, table, chain. This concerns only chains previously added with addChain. Return value is a array of ( ipv, table, chain). For runtime operation see org.fedoraproject.FirewallD1.direct.Methods.getAllChains.
ipv (s): either ipv4 (iptables) or ipv6 (ip6tables) or eb (ebtables).
table (s): one of filter, mangle, nat, raw, security
chain (s): name of a chain.
getAllPassthroughs() → a(sas)
Get all passthrough rules added in all ipv types in format: ipv, rule. This concerns only rules previously added with addPassthrough. Return value is a array of ( ipv, array of arguments). For runtime operation see org.fedoraproject.FirewallD1.direct.Methods.getAllPassthroughs.
ipv (s): either ipv4 (iptables) or ipv6 (ip6tables) or eb (ebtables).
arguments (as): array of commands, parameters and other iptables/ip6tables/ebtables command line options.
getAllRules() → a(sssias)
Get all rules added to all chains in all tables in format: ipv, table, chain, priority, rule. This concerns only rules previously added with addRule. Return value is a array of ( ipv, table, chain, priority, array of arguments). For runtime operation see org.fedoraproject.FirewallD1.direct.Methods.getAllRules.
ipv (s): either ipv4 (iptables) or ipv6 (ip6tables) or eb (ebtables).
table (s): one of filter, mangle, nat, raw, security
chain (s): name of a chain.
priority (i): used to order rules.
arguments (as): array of commands, parameters and other iptables/ip6tables/ebtables command line options.
getChains(s: ipv, s: table) → as
Return an array of chains (s) added to table for ipv being either ipv4 (iptables) or ipv6 (ip6tables) or eb (ebtables). This concerns only chains previously added with addChain. For runtime operation see org.fedoraproject.FirewallD1.direct.Methods.getChains.
Possible errors: INVALID_IPV, INVALID_TABLE
getRules(s: ipv, s: table, s: chain) → a(ias)
Get all rules added to chain in table for ipv being either ipv4 (iptables) or ipv6 (ip6tables) or eb (ebtables). This concerns only rules previously added with addRule. Return value is a array of ( priority, array of arguments). For runtime operation see org.fedoraproject.FirewallD1.direct.Methods.getRules.
priority (i): used to order rules.
arguments (as): array of commands, parameters and other iptables/ip6tables/ebtables command line options.
Possible errors: INVALID_IPV, INVALID_TABLE
queryChain(s: ipv, s: table, s: chain) → b
Return whether a chain exists in table for ipv being either ipv4 (iptables) or ipv6 (ip6tables) or eb (ebtables). This concerns only chains previously added with addChain. For runtime operation see org.fedoraproject.FirewallD1.direct.Methods.queryChain.
Possible errors: INVALID_IPV, INVALID_TABLE
queryPassthrough(s: ipv, as: args) → b
Return whether a tracked passthrough rule with the arguments args exists for ipv being either ipv4 (iptables) or ipv6 (ip6tables) or eb (ebtables). This concerns only rules previously added with addPassthrough. For runtime operation see org.fedoraproject.FirewallD1.direct.Methods.queryPassthrough.
Possible errors: INVALID_IPV
queryRule(s: ipv, s: table, s: chain, i: priority, as: args) → b
Return whether a rule with priority and the arguments args exists in chain in table for ipv being either ipv4 (iptables) or ipv6 (ip6tables) or eb (ebtables). This concerns only rules previously added with addRule. For runtime operation see org.fedoraproject.FirewallD1.direct.Methods.queryRule.
Possible errors: INVALID_IPV, INVALID_TABLE
removeChain(s: ipv, s: table, s: chain) → Nothing
Remove a chain from table for ipv being either ipv4 (iptables) or ipv6 (ip6tables) or eb (ebtables). Only chains previously added with addChain can be removed this way. For runtime operation see org.fedoraproject.FirewallD1.direct.Methods.removeChain.
Possible errors: INVALID_IPV, INVALID_TABLE, NOT_ENABLED
removeRule(s: ipv, s: table, s: chain, i: priority, as: args) → Nothing
Remove a rule with priority and arguments args from chain in table for ipv being either ipv4 (iptables) or ipv6 (ip6tables) or eb (ebtables). Only rules previously added with addRule can be removed this way. For runtime operation see org.fedoraproject.FirewallD1.direct.Methods.removeRule.
Possible errors: INVALID_IPV, INVALID_TABLE, NOT_ENABLED
removePassthrough(s: ipv, as: args) → Nothing
Remove a passthrough rule with arguments args for ipv being either ipv4 (iptables) or ipv6 (ip6tables) or eb (ebtables). Only rules previously added with addPassthrough can be removed this way. For runtime operation see org.fedoraproject.FirewallD1.direct.Methods.removePassthrough.
Possible errors: INVALID_IPV, NOT_ENABLED
removeRules(s: ipv, s: table, s: chain) → Nothing
Remove all rules from chain in table for ipv being either ipv4 (iptables) or ipv6 (ip6tables) or eb (ebtables). This concerns only rules previously added with addRule. For runtime operation see org.fedoraproject.FirewallD1.direct.Methods.removeRules.
Possible errors: INVALID_IPV, INVALID_TABLE
 
Signals
 
Updated()
Emitted when configuration has been updated.

org.fedoraproject.FirewallD1.config.policies

Interface for permanent lockdown-whitelist configuration, see also firewalld.lockdown-whitelist(5). For runtime configuration see org.fedoraproject.FirewallD1.policies interface.
 
Methods
 
getLockdownWhitelist() → (asasasai)
Get settings of permanent lockdown-whitelist configuration in format: commands, selinux contexts, users, uids
commands (as): see command option in firewalld.lockdown-whitelist(5).
selinux contexts (as): see selinux option in firewalld.lockdown-whitelist(5).
users (as): see name attribute of user option in firewalld.lockdown-whitelist(5).
uids (ai): see id attribute of user option in firewalld.lockdown-whitelist(5).
setLockdownWhitelist((asasasai): settings) → Nothing
Set permanent lockdown-whitelist configuration to settings. Settings are in format: commands, selinux contexts, users, uids
commands (as): see command option in firewalld.lockdown-whitelist(5).
selinux contexts (as): see selinux option in firewalld.lockdown-whitelist(5).
users (as): see name attribute of user option in firewalld.lockdown-whitelist(5).
uids (ai): see id attribute of user option in firewalld.lockdown-whitelist(5).
Possible errors: INVALID_TYPE
addLockdownWhitelistCommand(s: command) → Nothing
Add command to whitelist. See command option in firewalld.lockdown-whitelist(5). For runtime operation see org.fedoraproject.FirewallD1.policies.Methods.addLockdownWhitelistCommand.
Possible errors: ALREADY_ENABLED, INVALID_TYPE
addLockdownWhitelistContext(s: context) → Nothing
Add context to whitelist. See selinux option in firewalld.lockdown-whitelist(5). For runtime operation see org.fedoraproject.FirewallD1.policies.Methods.addLockdownWhitelistContext.
Possible errors: ALREADY_ENABLED, INVALID_TYPE
addLockdownWhitelistUid(i: uid) → Nothing
Add user id uid to whitelist. See user option in firewalld.lockdown-whitelist(5). For runtime operation see org.fedoraproject.FirewallD1.policies.Methods.addLockdownWhitelistUid.
Possible errors: ALREADY_ENABLED, INVALID_TYPE
addLockdownWhitelistUser(s: user) → Nothing
Add user name to whitelist. See user option in firewalld.lockdown-whitelist(5). For runtime operation see org.fedoraproject.FirewallD1.policies.Methods.addLockdownWhitelistUser.
Possible errors: ALREADY_ENABLED, INVALID_TYPE
getLockdownWhitelistCommands() → as
List all command lines (s) that are on whitelist. For runtime operation see org.fedoraproject.FirewallD1.policies.Methods.getLockdownWhitelistCommands.
getLockdownWhitelistContexts() → as
List all contexts (s) that are on whitelist. For runtime operation see org.fedoraproject.FirewallD1.policies.Methods.getLockdownWhitelistContexts.
getLockdownWhitelistUids() → ai
List all user ids (i) that are on whitelist. For runtime operation see org.fedoraproject.FirewallD1.policies.Methods.getLockdownWhitelistUids.
getLockdownWhitelistUsers() → as
List all users (s) that are on whitelist. For runtime operation see org.fedoraproject.FirewallD1.policies.Methods.getLockdownWhitelistUsers.
queryLockdownWhitelistCommand(s: command) → b
Query whether command is on whitelist. For runtime operation see org.fedoraproject.FirewallD1.policies.Methods.queryLockdownWhitelistCommand.
queryLockdownWhitelistContext(s: context) → b
Query whether context is on whitelist. For runtime operation see org.fedoraproject.FirewallD1.policies.Methods.queryLockdownWhitelistContext.
queryLockdownWhitelistUid(i: uid) → b
Query whether user id uid is on whitelist. For runtime operation see org.fedoraproject.FirewallD1.policies.Methods.queryLockdownWhitelistUid.
queryLockdownWhitelistUser(s: user) → b
Query whether user is on whitelist. For runtime operation see org.fedoraproject.FirewallD1.policies.Methods.queryLockdownWhitelistUser.
removeLockdownWhitelistCommand(s: command) → Nothing
Remove command from whitelist. For runtime operation see org.fedoraproject.FirewallD1.policies.Methods.removeLockdownWhitelistCommand.
Possible errors: NOT_ENABLED
removeLockdownWhitelistContext(s: context) → Nothing
Remove context from whitelist. For runtime operation see org.fedoraproject.FirewallD1.policies.Methods.removeLockdownWhitelistContext.
Possible errors: NOT_ENABLED
removeLockdownWhitelistUid(i: uid) → Nothing
Remove user id uid from whitelist. For runtime operation see org.fedoraproject.FirewallD1.policies.Methods.removeLockdownWhitelistUid.
Possible errors: NOT_ENABLED
removeLockdownWhitelistUser(s: user) → Nothing
Remove user from whitelist. For runtime operation see org.fedoraproject.FirewallD1.policies.Methods.removeLockdownWhitelistUser.
Possible errors: NOT_ENABLED
 
Signals
 
LockdownWhitelistUpdated()
Emitted when permanent lockdown-whitelist configuration has been updated.

org.fedoraproject.FirewallD1.config.zone

Interface for permanent zone configuration, see also firewalld.zone(5).
 
Methods
 
getSettings() → (sssbsasa(ss)asba(ssss)asasas)
Return permanent settings of given zone. For getting runtime settings see org.fedoraproject.FirewallD1.Methods.getZoneSettings. Settings are in format: version, name, description, UNUSED, target, array of services, array of ports (port, protocol), array of icmp-blocks, masquerade, array of forward-ports (port, protocol, to-port, to-addr), array of interfaces, array of sources, array of rich rules
version (s): see version attribute of zone tag in firewalld.zone(5).
name (s): see short tag in firewalld.zone(5).
description (s): see description tag in firewalld.zone(5).
UNUSED (b): this boolean value is no longer used for anything.
target (s): see target attribute of zone tag in firewalld.zone(5).
services (as): array of service names, see service tag in firewalld.zone(5).
ports (a(ss)): array of port and protocol pairs. See port tag in firewalld.zone(5).
icmp-blocks (as): array of icmp-blocks. See icmp-block tag in firewalld.zone(5).
masquerade (b): see masquerade tag in firewalld.zone(5).
forward-ports (a(ssss)): array of (port, protocol, to-port, to-addr). See forward-port tag in firewalld.zone(5).
interfaces (as): array of interfaces. See interface tag in firewalld.zone(5).
source addresses (as): array of source addresses. See source tag in firewalld.zone(5).
rich rules (as): array of rich-language rules. See rule tag in firewalld.zone(5).
loadDefaults() → Nothing
Load default settings for built-in zone.
Possible errors: NO_DEFAULTS
remove() → Nothing
Remove not built-in zone.
Possible errors: BUILTIN_ZONE
rename(s: name) → Nothing
Rename not built-in zone to name.
Possible errors: BUILTIN_ZONE
update((sssbsasa(ss)asba(ssss)asasas): settings) → Nothing
Update settings of zone to settings. Settings are in format: version, name, description, UNUSED, target, array of services, array of ports (port, protocol), array of icmp-blocks, masquerade, array of forward-ports (port, protocol, to-port, to-addr), array of interfaces, array of sources, array of rich rules
version (s): see version attribute of zone tag in firewalld.zone(5).
name (s): see short tag in firewalld.zone(5).
description (s): see description tag in firewalld.zone(5).
UNUSED (b): this boolean value is no longer used for anything.
target (s): see target attribute of zone tag in firewalld.zone(5).
services (as): array of service names, see service tag in firewalld.zone(5).
ports (a(ss)): array of port and protocol pairs. See port tag in firewalld.zone(5).
icmp-blocks (as): array of icmp-blocks. See icmp-block tag in firewalld.zone(5).
masquerade (b): see masquerade tag in firewalld.zone(5).
forward-ports (a(ssss)): array of (port, protocol, to-port, to-addr). See forward-port tag in firewalld.zone(5).
interfaces (as): array of interfaces. See interface tag in firewalld.zone(5).
source addresses (as): array of source addresses. See source tag in firewalld.zone(5).
rich rules (as): array of rich-language rules. See rule tag in firewalld.zone(5).
Possible errors: INVALID_TYPE
getVersion() → s
Get version of zone. See version attribute of zone tag in firewalld.zone(5).
setVersion(s: version) → Nothing
Permanently set version of zone to version. See version attribute of zone tag in firewalld.zone(5).
getShort() → s
Get name of zone. See short tag in firewalld.zone(5).
setShort(s: short) → Nothing
Permanently set name of zone to short. See short tag in firewalld.zone(5).
getDescription() → s
Get description of zone. See description tag in firewalld.zone(5).
setDescription(s: description) → Nothing
Permanently set description of zone to description. See description tag in firewalld.zone(5).
getTarget() → s
Get target of zone. See target attribute of zone tag in firewalld.zone(5).
setTarget(s: target) → Nothing
Permanently set target of zone to target. See target attribute of zone tag in firewalld.zone(5).
getServices() → as
Get list of service names used in zone. See service tag in firewalld.zone(5). For runtime operation see org.fedoraproject.FirewallD1.zone.Methods.getServices.
setServices(as: services) → Nothing
Permanently set list of services used in zone to services. See service tag in firewalld.zone(5).
addService(s: service) → Nothing
Permanently add service to list of services used in zone. See service tag in firewalld.zone(5). For runtime operation see org.fedoraproject.FirewallD1.zone.Methods.addService.
Possible errors: ALREADY_ENABLED
removeService(s: service) → Nothing
Permanently remove service from list of services used in zone. See service tag in firewalld.zone(5). For runtime operation see org.fedoraproject.FirewallD1.zone.Methods.removeService.
Possible errors: NOT_ENABLED
queryService(s: service) → Nothing
Return whether service is in list of services used in zone. See service tag in firewalld.zone(5). For runtime operation see org.fedoraproject.FirewallD1.zone.Methods.queryService.
getPorts() → a(ss)
Get list of (port, protocol) defined in zone. See port tag in firewalld.zone(5). For runtime operation see org.fedoraproject.FirewallD1.zone.Methods.getPorts.
setPorts(a(ss): ports) → Nothing
Permanently set ports of zone to list of (port, protocol). See port tag in firewalld.zone(5).
addPort(s: port, s: protocol) → Nothing
Permanently add (port, protocol) to list of ports of zone. See port tag in firewalld.zone(5). For runtime operation see org.fedoraproject.FirewallD1.zone.Methods.addPort.
Possible errors: ALREADY_ENABLED
removePort(s: port, s: protocol) → Nothing
Permanently remove (port, protocol) from list of ports of zone. See port tag in firewalld.zone(5). For runtime operation see org.fedoraproject.FirewallD1.zone.Methods.removePort.
Possible errors: NOT_ENABLED
queryPort(s: port, s: protocol) → Nothing
Return whether (port, protocol) is in list of ports of zone. See port tag in firewalld.zone(5). For runtime operation see org.fedoraproject.FirewallD1.zone.Methods.queryPort.
getIcmpBlocks() → as
Get list of icmp type names blocked in zone. See icmp-block tag in firewalld.zone(5). For runtime operation see org.fedoraproject.FirewallD1.zone.Methods.getIcmpBlocks.
setIcmpBlocks(as: icmptypes) → Nothing
Permanently set list of icmp types blocked in zone to icmptypes. See icmp-block tag in firewalld.zone(5).
addIcmpBlock(s: icmptype) → Nothing
Permanently add icmptype to list of icmp types blocked in zone. See icmp-block tag in firewalld.zone(5). For runtime operation see org.fedoraproject.FirewallD1.zone.Methods.addIcmpBlock.
Possible errors: ALREADY_ENABLED
removeIcmpBlock(s: icmptype) → Nothing
Permanently remove icmptype from list of icmp types blocked in zone. See icmp-block tag in firewalld.zone(5). For runtime operation see org.fedoraproject.FirewallD1.zone.Methods.removeIcmpBlock.
Possible errors: NOT_ENABLED
queryIcmpBlock(s: icmptype) → Nothing
Return whether icmptype is in list of icmp types blocked in zone. See icmp-block tag in firewalld.zone(5). For runtime operation see org.fedoraproject.FirewallD1.zone.Methods.queryIcmpBlock.
getMasquerade() → b
Return whether masquerade is enabled in zone. This is the same as queryMasquerade() method. See masquerade tag in firewalld.zone(5).
setMasquerade(b: masquerade) → Nothing
Permanently set masquerading in zone to masquerade. See masquerade tag in firewalld.zone(5).
addMasquerade() → Nothing
Permanently enable masquerading in zone. See masquerade tag in firewalld.zone(5). For runtime operation see org.fedoraproject.FirewallD1.zone.Methods.addMasquerade.
Possible errors: ALREADY_ENABLED
removeMasquerade() → Nothing
Permanently disable masquerading in zone. See masquerade tag in firewalld.zone(5). For runtime operation see org.fedoraproject.FirewallD1.zone.Methods.removeMasquerade.
Possible errors: NOT_ENABLED
queryMasquerade() → b
Return whether masquerade is enabled in zone. This is the same as getMasquerade() method. See masquerade tag in firewalld.zone(5). For runtime operation see org.fedoraproject.FirewallD1.zone.Methods.queryMasquerade.
getForwardPorts() → a(ssss)
Get list of (port, protocol, toport, toaddr) defined in zone. See forward-port tag in firewalld.zone(5). For runtime operation see org.fedoraproject.FirewallD1.zone.Methods.getForwardPorts.
setForwardPorts(a(ssss): ports) → Nothing
Permanently set forward ports of zone to list of (port, protocol, toport, toaddr). See forward-port tag in firewalld.zone(5).
addForwardPort(s: port, s: protocol, s: toport, s: toaddr) → Nothing
Permanently add (port, protocol, toport, toaddr) to list of forward ports of zone. See forward-port tag in firewalld.zone(5). For runtime operation see org.fedoraproject.FirewallD1.zone.Methods.addForwardPort.
Possible errors: ALREADY_ENABLED
removeForwardPort(s: port, s: protocol, s: toport, s: toaddr) → Nothing
Permanently remove (port, protocol, toport, toaddr) from list of forward ports of zone. See forward-port tag in firewalld.zone(5). For runtime operation see org.fedoraproject.FirewallD1.zone.Methods.removeForwardPort.
Possible errors: NOT_ENABLED
queryForwardPort(s: port, s: protocol, s: toport, s: toaddr) → Nothing
Return whether (port, protocol, toport, toaddr) is in list of forward ports of zone. See forward-port tag in firewalld.zone(5). For runtime operation see org.fedoraproject.FirewallD1.zone.Methods.queryForwardPort.
getInterfaces() → as
Get list of interfaces bound to zone. See interface tag in firewalld.zone(5). For runtime operation see org.fedoraproject.FirewallD1.zone.Methods.getInterfaces.
setInterfaces(as: interfaces) → Nothing
Permanently set list of interfaces bound to zone to interfaces. See interface tag in firewalld.zone(5).
addInterface(s: interface) → Nothing
Permanently add interface to list of interfaces bound to zone. See interface tag in firewalld.zone(5). For runtime operation see org.fedoraproject.FirewallD1.zone.Methods.addInterface.
Possible errors: ALREADY_ENABLED
removeInterface(s: interface) → Nothing
Permanently remove interface from list of interfaces bound to zone. See interface tag in firewalld.zone(5). For runtime operation see org.fedoraproject.FirewallD1.zone.Methods.removeInterface.
Possible errors: NOT_ENABLED
queryInterface(s: interface) → Nothing
Return whether interface is in list of interfaces bound to zone. See interface tag in firewalld.zone(5). For runtime operation see org.fedoraproject.FirewallD1.zone.Methods.queryInterface.
getSources() → as
Get list of source addresses bound to zone. See source tag in firewalld.zone(5). For runtime operation see org.fedoraproject.FirewallD1.zone.Methods.getSources.
setSources(as: sources) → Nothing
Permanently set list of source addresses bound to zone to sources. See source tag in firewalld.zone(5).
addSource(s: source) → Nothing
Permanently add source to list of source addresses bound to zone. See source tag in firewalld.zone(5). For runtime operation see org.fedoraproject.FirewallD1.zone.Methods.addSource.
Possible errors: ALREADY_ENABLED
removeSource(s: source) → Nothing
Permanently remove source from list of source addresses bound to zone. See source tag in firewalld.zone(5). For runtime operation see org.fedoraproject.FirewallD1.zone.Methods.removeSource.
Possible errors: NOT_ENABLED
querySource(s: source) → Nothing
Return whether source is in list of source addresses bound to zone. See source tag in firewalld.zone(5). For runtime operation see org.fedoraproject.FirewallD1.zone.Methods.querySource.
getRichRules() → as
Get list of rich-language rules in zone. See rule tag in firewalld.zone(5). For runtime operation see org.fedoraproject.FirewallD1.zone.Methods.getRichRules.
setRichRules(as: rules) → Nothing
Permanently set list of rich-language rules to rules. See rule tag in firewalld.zone(5).
addRichRule(s: rule) → Nothing
Permanently add rule to list of rich-language rules in zone. See rule tag in firewalld.zone(5). For runtime operation see org.fedoraproject.FirewallD1.zone.Methods.addRichRule.
Possible errors: ALREADY_ENABLED
removeRichRule(s: rule) → Nothing
Permanently remove rule from list of rich-language rules in zone. See rule tag in firewalld.zone(5). For runtime operation see org.fedoraproject.FirewallD1.zone.Methods.removeRichRule.
Possible errors: NOT_ENABLED
queryRichRule(s: rule) → Nothing
Return whether rule is in list of rich-language rules in zone. See rule tag in firewalld.zone(5). For runtime operation see org.fedoraproject.FirewallD1.zone.Methods.queryRichRule.
 
Signals
 
Removed(s: name)
Emitted when zone with name has been removed.
Renamed(s: name)
Emitted when zone has been renamed to name.
Updated(s: name)
Emitted when zone with name has been updated.
 
Properties
 
default - b - (ro)
True if build-in zone has default settings. False if it has been modified. Always False for not build-in zones.
filename - s - (ro)
Name (including .xml extension) of file where the configuration is stored.
name - s - (ro)
Name of zone.
path - s - (ro)
Path to directory where the zone configuration is stored. Should be either /usr/lib/firewalld/zones or /etc/firewalld/zones.

org.fedoraproject.FirewallD1.config.service

Interface for permanent service configuration, see also firewalld.service(5).
 
Methods
 
getSettings() → (sssa(ss)asa{ss})
Return permanent settings of a service. For getting runtime settings see org.fedoraproject.FirewallD1.Methods.getServiceSettings. Settings are in format: version, name, description, array of ports (port, protocol), array of module names, dictionary of destinations.
version (s): see version attribute of service tag in firewalld.service(5).
name (s): see short tag in firewalld.service(5).
description (s): see description tag in firewalld.service(5).
ports (a(ss)): array of port and protocol pairs. See port tag in firewalld.service(5).
module names (as): array of kernel netfilter helpers, see module tag in firewalld.service(5).
destinations (a{ss}): dictionary of {IP family : IP address} where 'IP family' key can be either 'ipv4' or 'ipv6'. See destination tag in firewalld.service(5).
loadDefaults() → Nothing
Load default settings for built-in service.
Possible errors: NO_DEFAULTS
remove() → Nothing
Remove not built-in service.
Possible errors: BUILTIN_SERVICE
rename(s: name) → Nothing
Rename not built-in service to name.
Possible errors: BUILTIN_SERVICE
update((sssa(ss)asa{ss}): settings) → Nothing
Update settings of service to settings. Settings are in format: version, name, description, array of ports (port, protocol), array of module names, dictionary of destinations.
version (s): see version attribute of service tag in firewalld.service(5).
name (s): see short tag in firewalld.service(5).
description (s): see description tag in firewalld.service(5).
ports (a(ss)): array of port and protocol pairs. See port tag in firewalld.service(5).
module names (as): array of kernel netfilter helpers, see module tag in firewalld.service(5).
destinations (a{ss}): dictionary of {IP family : IP address} where 'IP family' key can be either 'ipv4' or 'ipv6'. See destination tag in firewalld.service(5).
Possible errors: INVALID_TYPE
getVersion() → s
Get version of service. See version attribute of service tag in firewalld.service(5).
setVersion(s: version) → Nothing
Permanently set version of service to version. See version attribute of service tag in firewalld.service(5).
getShort() → s
Get name of service. See short tag in firewalld.service(5).
setShort(s: short) → Nothing
Permanently set name of service to short. See short tag in firewalld.service(5).
getDescription() → s
Get description of service. See description tag in firewalld.service(5).
setDescription(s: description) → Nothing
Permanently set description of service to description. See description tag in firewalld.service(5).
getPorts() → a(ss)
Get list of (port, protocol) defined in service. See port tag in firewalld.service(5).
setPorts(a(ss): ports) → Nothing
Permanently set ports of service to list of (port, protocol). See port tag in firewalld.service(5).
addPort(s: port, s: protocol) → Nothing
Permanently add (port, protocol) to list of ports in service. See port tag in firewalld.service(5).
Possible errors: ALREADY_ENABLED
removePort(s: port, s: protocol) → Nothing
Permanently remove (port, protocol) from list of ports in service. See port tag in firewalld.service(5).
Possible errors: NOT_ENABLED
queryPort(s: port, s: protocol) → Nothing
Return whether (port, protocol) is in list of ports in service. See port tag in firewalld.service(5).
getModules() → as
Get list of modules (netfilter kernel helpers) used in service. See module tag in firewalld.service(5).
setModules(as: modules) → Nothing
Permanently set list of modules (netfilter kernel helpers) used in service to modules. See module tag in firewalld.service(5).
addModule(s: module) → Nothing
Permanently add module to list of modules (netfilter kernel helpers) used in service. See module tag in firewalld.service(5).
Possible errors: ALREADY_ENABLED
removeModule(s: module) → Nothing
Permanently remove module from list of modules (netfilter kernel helpers) used in service. See module tag in firewalld.service(5).
Possible errors: NOT_ENABLED
queryModule(s: module) → Nothing
Return whether module is in list of modules (netfilter kernel helpers) used in service. See module tag in firewalld.service(5).
getDestinations() → a{ss}
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 destination tag in firewalld.service(5).
setDestinations(a{ss}: destinations) → Nothing
Permanently set destinations of service to destinations, which is a dictionary of {IP family : IP address} where 'IP family' key can be either 'ipv4' or 'ipv6'. See destination tag in firewalld.service(5).
getDestination(s: family) → s
Permanently set a destination address. destination is in format: ( IP_family, IP_address) where IP_family can be either 'ipv4' or 'ipv6'. See destination tag in firewalld.service(5).
Possible errors: ALREADY_ENABLED
setDestination(ss: destination) → Nothing
Permanently set a destination address. destination is in format: ( IP_family, IP_address) where IP_family can be either 'ipv4' or 'ipv6'. See destination tag in firewalld.service(5).
Possible errors: ALREADY_ENABLED
removeDestination(s: family) → Nothing
Permanently remove a destination with family ('ipv4' or 'ipv6') from service. See destination tag in firewalld.service(5).
Possible errors: NOT_ENABLED
queryDestination(ss: destination) → b
Return whether a destination is in dictionary of destinations of this service. destination is in format: ( IP_family, IP_address) where IP_family can be either 'ipv4' or 'ipv6'. See destination tag in firewalld.service(5).
 
Signals
 
Removed(s: name)
Emitted when service with name has been removed.
Renamed(s: name)
Emitted when service has been renamed to name.
Updated(s: name)
Emitted when service with name has been updated.
 
Properties
 
default - b - (ro)
True if build-in service has default settings. False if it has been modified. Always False for not build-in services.
filename - s - (ro)
Name (including .xml extension) of file where the configuration is stored.
name - s - (ro)
Name of service.
path - s - (ro)
Path to directory where the configuration is stored. Should be either /usr/lib/firewalld/services or /etc/firewalld/services.

org.fedoraproject.FirewallD1.config.icmptype

Interface for permanent icmp type configuration, see also firewalld.icmptype(5).
 
Methods
 
getSettings() → (sssas)
Return permanent settings of icmp type. For getting runtime settings see org.fedoraproject.FirewallD1.Methods.getIcmpTypeSettings. Settings are in format: version, name, description, array of destinations.
version (s): see version attribute of icmptype tag in firewalld.icmptype(5).
name (s): see short tag in firewalld.icmptype(5).
description (s): see description tag in firewalld.icmptype(5).
destinations (as): array, either empty or containing strings 'ipv4' and/or 'ipv6', see destination tag in firewalld.icmptype(5).
loadDefaults() → Nothing
Load default settings for built-in icmp type.
Possible errors: NO_DEFAULTS
remove() → Nothing
Remove not built-in icmp type.
Possible errors: BUILTIN_ICMPTYPE
rename(s: name) → Nothing
Rename not built-in icmp type to name.
Possible errors: BUILTIN_ICMPTYPE
update((sssas): settings) → Nothing
Update permanent settings of icmp type to settings. Settings are in format: version, name, description, array of destinations.
version (s): see version attribute of icmptype tag in firewalld.icmptype(5).
name (s): see short tag in firewalld.icmptype(5).
description (s): see description tag in firewalld.icmptype(5).
destinations (as): array, either empty or containing strings 'ipv4' and/or 'ipv6', see destination tag in firewalld.icmptype(5).
getVersion() → s
Get version of icmp type. See version attribute of icmptype tag in firewalld.icmptype(5).
setVersion(s: version) → Nothing
Permanently set version of icmp type to version. See version attribute of icmptype tag in firewalld.icmptype(5).
getShort() → s
Get name of icmp type. See short tag in firewalld.icmptype(5).
setShort(s: short) → Nothing
Permanently set name of icmp type to short. See short tag in firewalld.icmptype(5).
getDescription() → s
Get description of icmp type. See description tag in firewalld.icmptype(5).
setDescription(s: description) → Nothing
Permanently set description of icmp type to description. See description tag in firewalld.icmptype(5).
getDestinations() → as
Get list of destinations. See destination tag in firewalld.icmptype(5).
setDestinations(as: destinations) → Nothing
Permanently set destinations of icmp type to destinations, which is array, either empty or containing strings 'ipv4' and/or 'ipv6'. See destination tag in firewalld.icmptype(5).
addDestination(s: destination) → Nothing
Permanently add a destination ('ipv4' or 'ipv6') to list of destinations of this icmp type. See destination tag in firewalld.icmptype(5).
Possible errors: ALREADY_ENABLED
removeDestination(s: destination) → Nothing
Permanently remove a destination ('ipv4' or 'ipv6') from list of destinations of this icmp type. See destination tag in firewalld.icmptype(5).
Possible errors: NOT_ENABLED
queryDestination(s: destination) → b
Return whether a destination ('ipv4' or 'ipv6') is in list of destinations of this icmp type. See destination tag in firewalld.icmptype(5).
 
Signals
 
Removed(s: name)
Emitted when icmp type with name has been removed.
Renamed(s: name)
Emitted when icmp type has been renamed to name.
Updated(s: name)
Emitted when icmp type with name has been updated.
 
Properties
 
default - b - (ro)
True if build-in icmp type has default settings. False if it has been modified. Always False for not build-in zones.
filename - s - (ro)
Name (including .xml extension) of file where the configuration is stored.
name - s - (ro)
Name of icmp type.
path - s - (ro)
Path to directory where the icmp type configuration is stored. Should be either /usr/lib/firewalld/icmptypes or /etc/firewalld/icmptypes.

SEE ALSO

firewall-applet(1), firewalld(1), firewall-cmd(1), firewall-config(1), firewalld.conf(5), firewalld.direct(5), firewalld.icmptype(5), firewalld.lockdown-whitelist(5), firewall-offline-cmd(1), firewalld.richlanguage(5), firewalld.service(5), firewalld.zone(5), firewalld.zones(5)

NOTES

firewalld home page:
More documentation with examples:

AUTHORS

Thomas Woerner <twoerner@redhat.com>
Developer
Jiri Popelka <jpopelka@redhat.com>
Developer
firewalld 0.3.12