fireqos-interface(5)

💖 fireqos-interface — the manual page, but make it make sense

okay bestie, welcome to fireqos-interface(5) from the FireQOS Reference (that's version 3.1.8, iykyk) 🎀

This page is all about creating an interface definition — like, the moment where you tell FireQOS "hey, this is the thing I want to shape traffic on". Let's get into it. 🦋

---

✨ SYNOPSIS ✨

{ interface | interface4 } device name direction [optional-class-params]
{ rate | commit | min } speed

interface46 ...

interface6 ...

---

🌸 DESCRIPTION 🌸

So here's the tea on which keyword you pick, because they are not all the same:

• Write interface or interface4 and you're applying traffic shaping rules only to IPv4 traffic. v4 only, no v6 invited. 💅
• Write interface6 and you're applying traffic shaping rules only to IPv6 traffic. v6 only, v4 stay home. ✨
• Write interface46 and you're applying traffic shaping rules to both IPv4 and IPv6 traffic. the bothies. the whole squad. 👑

And the actual traffic shaping behaviour of a class? That's defined by adding classes. Go read fireqos-class(5) for that part, bestie. 📚

Note — okay this one is IMPORTANT, no cap. To get the best results with incoming traffic shaping, you should not use 100% of the available bandwidth at the interface level. Why? Because if you use all there is, at 100% utilisation of the link, the neighbour routers will start queuing packets. And that will destroy prioritisation. 💀 Like, completely ruin it. Try 85% or 90% instead. Trust. 🫶

---

🎀 PARAMETERS 🎀

• device — this is the interface name as shown by ip link show (so like eth0, ppp1, etc.). basically the name of the actual network thing. 🧚
• name — this is a single-word name for this interface, and it's used for retrieving status information later. pick something cute and memorable, bestie, you'll be seeing it again. 🍓
• direction — okay so this one has options:
  • If set to input, traffic coming in to the interface is shaped. ⬅️
  • If set to output, traffic going out via the interface is shaped. ➡️
  • If set to bidirectional, traffic for both input and output can be shaped. 🔄 And if you need to differentiate input and output parameters per statements within the interface, you can prefix them with input or output like this:

interface eth0 lan bidirectional ...
    class voip input commit 1Mbit output commit 2Mbit ...

• optional-class-params — for a list of optional class parameters which can be applied to an interface, go check out fireqos-params-class(5). 👀
• speed — for an interface, the committed speed must be specified with the rate option. The speed can be expressed in any of the units described in fireqos.conf(5). 📏

---

🌈 EXAMPLES 🌈

Wanna create an input policy on eth0, capable of delivering up to 1Gbit of traffic? Say less:

interface eth0 lan-in input rate 1Gbit

slay. that's it. that's the whole thing. 💅✨

---

👑 SEE ALSO 👑

• fireqos.conf(5) — FireQOS configuration file
• fireqos-class(5) — QOS class definition
• fireqos-params-class(5) — QOS class parameters
• FireHOL Website
• FireQOS Online PDF Manual
• FireQOS Online Documentation

---

💜 AUTHORS 💜

FireHOL Team. (the icons, fr fr 🫶)

---

FireQOS Reference · Built 13 Apr 2025 · that's the version 3.1.8 energy, periodt. go shape some traffic bestie, and remember: 85–90%, not 100%. 😭💖