SYNOPSIS

firewallctl [OPTIONS...]

DESCRIPTION

OPTIONS

The following options are supported:

General Options

-h, --help

Prints a short help text and exits.

-v, --verbose

Be more verbose while printing.

-q, --quiet

Do not print status messages.

Version Option

version

Print the version string of firewalld. This option is not combinable with other options.

State Option

state

Check whether the firewalld daemon is active (i.e. running). Returns an exit code 0 if it is active, NOT_RUNNING otherwise (see the section called "EXIT CODES"). This will also print the state to STDOUT.

Reload Options

reload [ -c | --complete ]

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.

With the -c | --complete option, 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.

Runtime To Permanent Option

runtime-to-permanent

Save active runtime configuration and overwrite permanent configuration with it.

The way this is supposed to work is that when configuring firewalld you do runtime changes only and once you're happy with the configuration and you tested that it works the way you want, you save the configuration to disk.

List Options

list zones [ -a | --active | -p | --permanent ]

Print predefined zones as a space separated list.

With the -a | --active option, only zones are listed, that are active. That means that the zones have interface or source bindings.

With the -p | --permanent option, zones in the permanent environment are listed.

list services [ -p | --permanent ]

Print predefined services as a space separated list.

With the -p | --permanent option, services in the permanent environment are listed.

list ipsets [ -p | --permanent ]

Print predefined ipsets as a space separated list.

With the -p | --permanent option, ipsets in the permanent environment are listed.

list icmptypes [ -p | --permanent ]

Print predefined icmptypes as a space separated list.

With the -p | --permanent option, icmptypes in the permanent environment are listed.

Info Options

info zone zone [ -p | --permanent ]

Print information about the zone zone. The output format is:

zone
  interfaces: interface1 ..
  sources: source1 ..
  services: service1 ..
  ports: port1 ..
  protocols: protocol1 ..
  forward-ports:
        forward-port1
        ..
  source-ports: source-port1 ..
  icmp-blocks: icmp-type1 ..
  rich rules:
        rich-rule1
        ..
              

With the -p | --permanent option, zones in the permanent environment are listed.

info zones [ -a | --active | -p | --permanent ]

Print information about the zones. The output format is:

zone
  interfaces: interface1 ..
  sources: source1 ..
  services: service1 ..
  ports: port1 ..
  protocols: protocol1 ..
  forward-ports:
        forward-port1
        ..
  source-ports: source-port1 ..
  icmp-blocks: icmp-type1 ..
  rich rules:
        rich-rule1
        ..
              

With the -a | --active option, only zones are listed, that are active. That means that the zones have interface or source bindings.

With the -p | --permanent option, zones in the permanent environment are listed.

info service service [ -p | --permanent ]

Print information about the service service. The output format is:

service
  ports: port1 ..
  protocols: protocol1 ..
  source-ports: source-port1 ..
  modules: module1 ..
  destination: ipv1:address1 ..
              

With the -p | --permanent option, services in the permanent environment are listed.

info services [ -p | --permanent ]

Print information about the services. The output format is:

service
  ports: port1 ..
  protocols: protocol1 ..
  source-ports: source-port1 ..
  modules: module1 ..
  destination: ipv1:address1 ..
              

With the -p | --permanent option, services in the permanent environment are listed.

info ipset ipset [ -p | --permanent ]

Print information about the ipset ipset. The output format is:

ipset
  type: type
  options: option1[=value1] ..
  entries: entry1 ..
              

With the -p | --permanent option, ipsets in the permanent environment are listed.

info ipsets [ -p | --permanent ]

Print information about the ipsets. The output format is:

ipset
  type: type
  options: option1[=value1] ..
  entries: entry1 ..
              

With the -p | --permanent option, ipsets in the permanent environment are listed.

info icmptype icmptype [ -p | --permanent ]

Print information about the icmptype icmptype. The output format is:

icmptype
  destination: ipv1 ..
              

With the -p | --permanent option, icmptypes in the permanent environment are listed.

info icmptypes [ -p | --permanent ]

Print information about the icmptypes. The output format is:

icmptype
  destination: ipv1 ..
              

With the -p | --permanent option, icmptypes in the permanent environment are listed.

Zone Options

zone zone [ -p | --permanent ] add element.. [ --timeout=timeval ]

Add an element or several elements of the same type to a zone with an optional timeout. If a timeout is supplied, the element will be active for the specified amount of time and will be removed automatically afterwards.

If zone is the empty string "", the default zone will be used.

For possible zone elements see further down.

With the -p or --permanent option, elements are added in the permanent environment.

The --timeout option is not combinable with the --permanent option.

zone zone [ -p | --permanent ] remove element..

Remove an element or several elements of the same type from the zone.

If zone is the empty string "", the default zone will be used.

For possible zone elements see further down.

With the -p or --permanent option, elements are added in the permanent environment.

zone zone [ -p | --permanent ] query element..

Return whether the element or several elements of the same type are enabled in the zone.

If zone is the empty string "", the default zone will be used.

For possible zone elements see further down.

With the -p or --permanent option, elements are added in the permanent environment.

zone zone [ -p | --permanent ] get { short | description }

Return short or long description from zone.

If zone is the empty string "", the default zone will be used.

With the -p or --permanent option, elements are added in the permanent environment.

zone zone [ -p | --permanent ] set { short | description } text

Set short or long description for a zone to text.

If zone is the empty string "", the default zone will be used.

With the -p or --permanent option, elements are added in the permanent environment.

zone zone [ -p | --permanent ] list { interfaces | sources | services | ports | protocols | source-ports | rich-rules | forward-ports | icmp-blocks }

Return list of elements added for zone.

If zone is the empty string "", the default zone will be used.

With the -p or --permanent option, elements are added in the permanent environment.

zone zone { -p | --permanent } load-defaults

Load zone default settings or report NO_DEFAULTS error.

Zone Elements

A zone element can be one of:

interface interface

An interface name is a string up to 16 characters long, that may not contain ' ', '/', '!' and '*'.

If the interface is under control of NetworkManager, it is at first connected to change the zone for the connection that is using the interface for new or changed interface bindings. If the setting in NetworkManager fails, the zone binding is created or changed in firewalld and the limitations below apply. For interfaces that are not under control of NetworkManager, firewalld tries to change the ZONE setting in the ifcfg file, if the file exists.

As a end user you don't need to create or change zone bindings of interfaces in most cases, because NetworkManager (or legacy network service) adds interfaces into zones automatically (according to ZONE= option from ifcfg-interface file) if NM_CONTROLLED=no is not set. You should do it only if there's no /etc/sysconfig/network-scripts/ifcfg-interface file. If there is such file and you add interface to zone with this --add-interface option, make sure the zone is the same in both cases, otherwise the behaviour would be undefined. Please also have a look at the firewalld(1) man page in the Concepts section. For permanent association of interface with a zone, see also 'How to set or change a zone for a connection?' in firewalld.zones(5).

source { address[/mask] | ipset:ipset }

A source address or address range is either an IP address or a network IP address with a mask for IPv4 or IPv6 or a MAC address (no mask) or also an ipset. For IPv4, the mask can be a network mask or a plain number. For IPv6 the mask is a plain number. The use of host names is not supported.

service service

A service is a firewalld provided or user created service. To get a list of the supported services, use firewallctl list services [ -p | --permanent ].

port portid[-portid]/protocol

A port can either be a single port number or a port range portid-portid. The protocol can either be tcp or udp.

protocol protocol

A protocol can be any protocol supported by the system. Please have a look at /etc/protocols for supported protocols.

source-port portid[-portid]/protocol

A source port can either be a single port number or a port range portid-portid. The protocol can either be tcp or udp.

rich-rule 'rule'

A rich language rule. For the rich language rule syntax, please have a look at firewalld.richlanguage(5).

masquerade

IPv4 masquerading.

Masquerading is useful if the machine is a router and machines connected over an interface in another zone should be able to use the first connection.

forward-port port=portid[-portid]:proto=protocol[:toport=portid[-portid]][:toaddr=address[/mask]]

An IPv4 forward port.

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.

For IPv6 forward ports, please use the rich language.

icmp-block icmptype

An ICMP type block.

The icmptype is the one of the ICMP types firewalld supports. To get a listing of supported icmp types: firewallctl list icmptypes [ -p | --permanent ]

icmp-block-inversion

Invert ICMP type blocks. The ICMP types marked to be blocked are allowed and all others are blocked.

Service Options

service service [ -p | --permanent ] add element..

Add an element or several elements of the same type to a service.

For possible service elements see further down.

With the -p or --permanent option, elements are added in the permanent environment.

service service [ -p | --permanent ] remove element..

Remove an element or several elements of the same type from the service.

For possible service elements see further down.

With the -p or --permanent option, elements are added in the permanent environment.

service service [ -p | --permanent ] query element..

Return whether the element or several elements of the same type are enabled in the service.

For possible service elements see further down.

With the -p or --permanent option, elements are added in the permanent environment.

service service [ -p | --permanent ] get { short | description }

Return short or long description from service.

With the -p or --permanent option, elements are added in the permanent environment.

service service [ -p | --permanent ] set { short | description } text

Set short or long description for a service to text.

With the -p or --permanent option, elements are added in the permanent environment.

service service [ -p | --permanent ] list { ports | protocols | source-ports | modules | destinations }

Return list of elements added for service.

With the -p or --permanent option, elements are added in the permanent environment.

service service { -p | --permanent } load-defaults

Load service default settings or report NO_DEFAULTS error.

Service Elements

A service element can be one of:

port portid[-portid]/protocol

A port can either be a single port number or a port range portid-portid. The protocol can either be tcp or udp.

protocol protocol

A protocol can be any protocol supported by the system. Please have a look at /etc/protocols for supported protocols.

source-port portid[-portid]/protocol

A source port can either be a single port number or a port range portid-portid. The protocol can either be tcp or udp.

module module

A netfilter helper module.

destination ipv:address[/mask]

A destination address with optional mask for ipv. ipv is one of ipv4 or ipv6.

Ipset Options

ipset ipset [ -p | --permanent ] add { entry entry | entries-from-file filename }..

Add an entry or several entries to the ipset. Or add entries from one or more files to the ipset.

For possible ipset entries see further down.

With the -p or --permanent option, elements are added in the permanent environment.

ipset ipset [ -p | --permanent ] remove { entry entry | entries-from-file filename | all }..

Remove an entry or several entries the ipset. Or remove entries from one or more files from the ipset. Or remove all entries from the ipset.

For possible ipset entries see further down.

With the -p or --permanent option, elements are added in the permanent environment.

ipset ipset [ -p | --permanent ] query { entry entry | entries-from-file filename }..

Return whether the entry or the several entries are part of the ipset. Or return whether the entries from one or more files are part of the ipset.

For possible ipset entries see further down.

With the -p or --permanent option, elements are added in the permanent environment.

ipset ipset [ -p | --permanent ] get { short | description }

Return short or long description from ipset.

With the -p or --permanent option, elements are added in the permanent environment.

ipset ipset [ -p | --permanent ] set { short | description } text

Set short or long description for a ipset to text.

With the -p or --permanent option, elements are added in the permanent environment.

ipset ipset [ -p | --permanent ] list entries

Return list of entries added for ipset.

With the -p or --permanent option, elements are added in the permanent environment.

ipset ipset { -p | --permanent } load-defaults

Load ipset default settings or report NO_DEFAULTS error.

Ipset Entries

An ipset entry depends on the ipset type and family setting.

For ipset type hash:net:

ip[/cidr]

An entry can be a single ip address with an optional cidr netmask or an ip range. The cidr value must be between 1-32 for IPv4 and between 1-128 for IPv6.

The address can be an IPv4 address if the family is set to inet or not set or an IPv6 address if the family is set to inet6.

For ipset type hash:ip:

ip[/cidr] | fromaddr-toaddr

An entry can either be a single ip address with an optional cidr netmask or an ip range. The cidr value must be between 1-32 for IPv4 and between 1-128 for IPv6.

The address can be an IPv4 address if the family is set to inet or not set or an IPv6 address if the family is set to inet6.

For ipset type hash:mac (not supported with older ipset and kernel versions):

mac

An entry is a mac address.

Icmptype Options

icmptype icmptype [ -p | --permanent ] { add | remove } destination { ipv4 | ipv6 }

Add the destination to the icmptype or remove the destination from the icmptype.

With the -p or --permanent option, elements are added in the permanent environment.

icmptype icmptype [ -p | --permanent ] query destination { ipv4 | ipv6 }

Return whether the destination is set in the icmptype.

With the -p or --permanent option, elements are added in the permanent environment.

icmptype icmptype [ -p | --permanent ] get { short | description }

Return short or long description from icmptype.

With the -p or --permanent option, elements are added in the permanent environment.

icmptype icmptype [ -p | --permanent ] set { short | description } text

Set short or long description for a icmptype to text.

With the -p or --permanent option, elements are added in the permanent environment.

icmptype icmptype [ -p | --permanent ] list destinations

Return list of destinations added for icmptype.

With the -p or --permanent option, elements are added in the permanent environment.

icmptype icmptype { -p | --permanent } load-defaults

Load icmptype default settings or report NO_DEFAULTS error.

New Options

new { -p | --permanent } zone { { -n | --name } name | { -f | --filename} filename [ { -n | --name } name } ] }

Add a new permanent zone. Either empty with specified name or from an existing zone file with optional name override.

The zone will only be usable in the runtime environment after a reload.

new { -p | --permanent } service { { -n | --name } name | { -f | --filename} filename [ { -n | --name } name } ] }

Add a new permanent service. Either empty with specified name or from an existing service file with optional name override.

The service will only be usable in the runtime environment after a reload.

new { -p | --permanent } ipset { { -n | --name } name { -t | --type } ipsettype [ { -o | --option } option[=value] ] | { -f | --filename} filename [ { -n | --name } name } ] }

Add a new permanent ipset. Either empty with specified name, type and optional option or from an existing ipset file with optional name override.

For valid ipset options please have a look at firewalld.ipset(5).

The ipset will only be usable in the runtime environment after a reload.

new { -p | --permanent } icmptype { { -n | --name } name | { -f | --filename} filename [ { -n | --name } name } ] }

Add a new permanent icmptype. Either empty with specified name or from an existing icmptype file with optional name override.

The icmptype will only be usable in the runtime environment after a reload.

Delete Options

delete { -p | --permanent } zone zone

Delete a permanent zone.

The zone will be part of the runtime environment until a reload.

delete { -p | --permanent } service service

Delete a permanent service.

The service will be part of the runtime environment until a reload.

delete { -p | --permanent } ipset ipset

Delete a permanent ipset.

The ipset will be part of the runtime environment until a reload.

delete { -p | --permanent } icmptype icmptype

Delete a permanent icmptype.

The icmptype will be part of the runtime environment until a reload.

Direct Options

direct [ -p | --permanent ] { add | remove } chain { ipv4 | ipv6 | eb } table chain

Add a new chain with name chain to table table. Make sure there's no other chain with this name already.

There already exist basic chains to use with direct options, for example INPUT_direct chain (see iptables-save | grep direct output for all of them). These chains are jumped into before chains for zones, i.e. every rule put into INPUT_direct will be checked before rules in zones.

direct [ -p | --permanent ] query chain { ipv4 | ipv6 | eb } table chain

Return whether a chain with name chain exists in table table. Returns 0 if true, 1 otherwise. This option concerns only chains previously added with direct add chain.

direct [ -p | --permanent ] get chains { ipv4 | ipv6 | eb } table

Get all chains added to table table as a space separated list. This option concerns only chains previously added with direct add chain.

direct [ -p | --permanent ] get all-chains

Get all chains added to all tables. This option concerns only chains previously added with direct add chain.

direct [ -p | --permanent ] { add | remove } rule { ipv4 | ipv6 | eb } table chain priority args

Add or remove a rule with the arguments args to chain chain in table table with priority priority.

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.

direct [ -p | --permanent ] query rule { ipv4 | ipv6 | eb } table chain priority args

Return whether a rule with priority and the arguments args exists in chain chain in table table. Returns 0 if true, 1 otherwise. This option concerns only rules previously added with direct add rule.

direct [ -p | --permanent ] get all-rules

Get all rules added to all chains in all tables as a newline separated list of the priority and arguments. This option concerns only rules previously added with direct add rule.

direct [ -p | --permanent ] get rules { ipv4 | ipv6 | eb } table chain

Get all rules added to chain chain in table table as a newline separated list of the priority and arguments. This option concerns only rules previously added with direct add rule.

direct [ -p | --permanent ] { add | remove } passthrough { ipv4 | ipv6 | eb } args

Add a passthrough rule with the arguments args for the ipv value.

direct [ -p | --permanent ] query passthrough { ipv4 | ipv6 | eb } args

Return whether a passthrough rule with the arguments args exists for the ipv value. Returns 0 if true, 1 otherwise.

direct [ -p | --permanent ] get all-passthroughs

Get all passthrough rules as a newline separated list of the ipv value and arguments.

direct [ -p | --permanent ] get passthroughs { ipv4 | ipv6 | eb }

Get passthrough rules for the ipv value as a newline separated list of the priority and arguments.

direct passthrough { ipv4 | ipv6 | eb } args

Pass a command through to the firewall. 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, also not a listing of the untracked passthoughs.

Lockdown Whitelist Options

Local applications or services are able to change the firewall configuration if they are running as root (example: libvirt) or are authenticated using PolicyKit. With this feature administrators can lock the firewall configuration so that only applications on lockdown whitelist are able to request firewall changes.

The lockdown access check limits D-Bus methods that are changing firewall rules. Query, list and get methods are not limited.

The lockdown feature is a very light version of user and application policies for firewalld and is turned off by default.

lockdown-whitelist [ -p | --permanent ] { add | remove } element..

Add an element or several elements of the same type to the lockdown whitelist.

For possible lockdown whitelist elements see further down.

With the -p or --permanent option, elements are added in the permanent environment.

lockdown-whitelist [ -p | --permanent ] query element..

Return whether the element or several elements of the same type are enabled in the lockdown whitelist.

For possible lockdown whitelist elements see further down.

With the -p or --permanent option, elements are added in the permanent environment.

lockdown-whitelist [ -p | --permanent ] list { commands | contexts | uids | users }

Return list of elements added for the lockdown whitelist.

With the -p or --permanent option, elements are added in the permanent environment.

Lockdown Whitelist Elements

The lockdown whitelist can contain commands, contexts, users and user ids.

If a command entry on the whitelist ends with an asterisk '*', then all command lines starting with the command will match. If the '*' is not there the absolute command inclusive arguments must match.

Commands for user root and others is not always the same. Example: As root /bin/firewall-cmd is used, as a normal user /usr/bin/firewall-cmd is be used on Fedora.

The context is the security (SELinux) context of a running application or service. To get the context of a running application use ps -e --context.

Warning: If the context is unconfined, then this will open access for more than the desired application.

The lockdown whitelist entries are checked in the following order:

1. context

2. uid

3. user

4. command

A lockdown whitelist element can be one of:

command 'string'

The command string is a complete command line including path and also attributes.

If a command entry ends with an asterisk '*', then all command lines starting with the command will match. If the '*' is not there the absolute command inclusive arguments must match.

Commands for user root and others is not always the same, the used path depends on the use of the PATH environment variable.

context string

The context is the security (SELinux) context of a running application or service.

To get the context of a running application use ps -e --context and search for the application that should be white-listed.

Warning: If the context of an application is unconfined, then this will open access for more than the desired application.

user string

The user with the name string will be white-listed.

uid integer

The user with the id userid will be white-listed.

Config Options

config set { default-zone zone | lockdown { on | off } | log-denied value | panic { on | off } }

Set a firewalld config option.

The possible config options are:

default-zone zone

Set the default zone for connections and interfaces where no zone has been selected. Setting the default zone changes the zone for the connections or interfaces, that are using the default zone.

lockdown

Enable or disable lockdown. Be careful - if firewall-cmd is not on lockdown whitelist when you enable lockdown you won't be able to disable it again with firewall-cmd, you would need to edit firewalld.conf.

log-denied

If enabled, 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 for the configured link-layer packet type. The possible values are: all, unicast, broadcast, multicast and off. The default setting is off, which disables the logging.

panic

Enable or disable the panic mode. If enabled, all incoming and outgoing packets are dropped, active connections will expire. Enable this only if there are serious problems with your network environment. For example if the machine is getting hacked in.

After disabling panic mode established connections might work again, if panic mode was enabled for a short period of time.

config list

List firewalld config options like default-zone, lockdown, log-denied and panic flag.

config get { default-zone | lockdown | log-denied | panic }

Get a firewalld config option.

The possible config options are:

default-zone

Returns the default zone for connections and interfaces.

lockdown

Returns whether lockdown is enabled.

log-denied

Returns the log denied configuration.

panic

Returns 0 if panic mode is enabled, 1 otherwise.

Settings Options

settings list

List firewalld settings like BRIDGE, CleanupOnExit, IPSet, IPSetTypes, IPv4, IPv6, IPv6_rpfilter, IndividualCalls and MinimalMark.

settings get { BRIDGE | CleanupOnExit | IPSet | IPSetTypes | IPv4 | IPv6 | IPv6_rpfilter | IndividualCalls | MinimalMark }

Get a firewalld setting.

The supported settings are:

BRIDGE

Returns whether bridge support is available.

CleanupOnExit

Returns whether CleanupOnExit is enabled.

IPSet

Returns whether ipset support is available.

IPSetTypes

Returns the currently supported ipset types. This setting lists all ipset types that are supported to be used within firewalld. This means the ipset types need to be supported by kernel and the ipset command and firewalld at the same time.

IPv4

Returns whether ipv4 support is available.

IPv6

Returns whether IPv6 support is available.

IPv6_rpfilter

Returns whether IPv6 rpfilter is enabled.

The IPv6 rpfiler performs a reverse path filter test on a packet for IPv6. 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. The rp_filter for IPv4 is controlled using sysctl.

IndividualCalls

Returns the individual calls setting.

If disabled, combined -restore calls are not used, but individual calls. This increases the time that is needed to apply changes and to start the daemon, but is good for debugging.

MinimalMark

Returns the minimal mark setting.

Marks up to this minimum are free for use for example in the direct interface. If more free marks are needed, increase the minimum in the firewalld.conf file.

NOTES

firewalld home page:

m[blue]http://www.firewalld.orgm[]

More documentation with examples:

m[blue]http://fedoraproject.org/wiki/FirewallDm[]

AUTHORS

Thomas Woerner <[email protected]>

Developer

Jiri Popelka <[email protected]>

Developer