FIREWALLD.HELPER(5)

📦
version 2.5.2 · 14 versions
, in arch rolling, ubuntu stonking

✨ NAME ✨

firewalld.helper — the firewalld helper config files, bestie 💖

🦋 SYNOPSIS 🦋

/etc/firewalld/helpers/helper.xml
/usr/lib/firewalld/helpers/helper.xml

🌸 DESCRIPTION 🌸

okay so a firewalld helper config file is literally just the file that hands firewalld all the deets about one helper entry. The stuff you actually care about the most here? That's ports, family and module. those three are the moment, fr fr 👑

here's an example config file so you can see the whole structure and vibe check it:

<?xml version="1.0" encoding="utf-8"?>
<helper module="nf_conntrack_module" [family="ipv4|ipv6"]>
  <short>short</short>
  <description>description</description>
  <port port="portid[-portid]" protocol="tcp|udp|sctp|dccp"/>
</helper>

💅 OPTIONS 💅

your config can hold these tags and attributes. some of them are mandatory (no skipping, they're the main character), the rest are optional (they're just here for the vibes).

🎀 helper

the mandatory helper start and end tag — this is the tag that defines the helper. and heads up bestie, you can only use it once in a helper configuration file. periodt. it's got one mandatory attribute and also optional ones:

  • module="string" — the mandatory module of the helper. this is one of the netfilter conntrack helper modules, and the name starts with nf_conntrack_. 👑
  • family="ipv4|ipv6" — the optional family of the helper. it can be one of these ipv types: ipv4 or ipv6. and if you don't specify the family at all, then the helper is usable for IPv4 and IPv6, both of them, she's flexible 💖
  • version="string" — to give the helper a version. cute lil label, that's it.

🧚 short

an optional start and end tag, and it's used to give a helper a more readable name. like a nickname but for your config ✨

🍓 description

an optional start and end tag so you can have a description for a helper. spill the lore, girl.

🌈 port

a mandatory empty-element tag, and you can use it several times to have more than one port entry — stack 'em, no cap. all the attributes of a port entry are mandatory, so don't be leaving any out 🙈

  • port="string" — the port string can be a single port number, or a port range written as portid-portid, or also empty to match a protocol only.
  • protocol="string" — the protocol value can either be tcp, udp, sctp or dccp.

🔥 SEE ALSO 🔥

firewall-applet(1), firewalld(1), firewall-cmd(1), firewall-config(1), firewalld.conf(5), firewalld.direct(5), firewalld.dbus(5), firewalld.icmptype(5), firewall-offline-cmd(1), firewalld.richlanguage(5), firewalld.service(5), firewalld.zone(5), firewalld.zones(5), firewalld.policy(5), firewalld.policies(5), firewalld.ipset(5), firewalld.helper(5)

the whole friend group, going out together 🫶

⭐ NOTES ⭐

the mothership, literally 🌐

👑 AUTHORS 👑

  • Thomas Woerner <twoerner@redhat.com> — Developer
  • Jiri Popelka <jpopelka@redhat.com> — Developer
  • Eric Garver <eric@garver.life> — Developer

the devs who made this happen, absolute icons 🫡

and that's the whole page bestie, ty for coming to my ted talk 💖 this was the FIREWALLD.HELPER(5) manual page from firewalld 2.5.2 — slay, go configure something iconic ✨💅

📦 where this page comes from