FIPVLAN(8)

💖 FIPVLAN(8) — bestie edition 💖

okay so this is the manual for fipvlan, which lives in the Open-FCoE Tools family (and yes, that's the manual name, we're just folding it in here so you know what you're reading 💅).

✨ NAME ✨

fipvlan — Fibre Channel over Ethernet VLAN Discovery 🦋

🌸 SYNOPSIS 🌸

fipvlan [-c|--create] [-d|--debug] [-s|--start] [-m|--mode fabric|vn2vn]
[-u|--link-up] interfaces

fipvlan -a|--auto [-c|--create] [-d|--debug] [-s|--start] [-m|--mode
fabric|vn2vn] [-l|--link-retry count] [-u|--link-up]

fipvlan -h|--help

fipvlan -v|--version

👑 DESCRIPTION 👑

So here's the tea, bestie 🍓: the fipvlan command does Fibre Channel over Ethernet (FCoE) Initialization Protocol (FIP) VLAN Discovery over Ethernet interfaces. That's a lot of acronyms and honestly it's giving alphabet soup, but the vibe is: it goes snooping around your network to find out which VLANs actually have FCoE services chillin' on them.

You can use fipvlan as a diagnostic tool to figure out which VLANs have FCoE services available on a network, before you go configuring VLAN interfaces and the Open-FCoE initiator. Lowkey a recon mission. 🕵️

It can also create VLAN interfaces as they get discovered, and start the Open-FCoE initiator while it's at it. The --create and --start options are primarily intended to be used as part of an Open-FCoE boot solution. And listen — this part matters — FCoE instances started this way cannot be destroyed or reset by fcoeadm. Periodt. 💀

fipvlan takes a list of network interface names to run the VLAN discovery protocol over, or the --auto option to use all available Ethernet interfaces. Your choice, main character. 👑

Oh and also? fipvlan will enable any interface which is found disabled. If no response is received on that interface it will be shutdown again when fipvlan terminates. It cleans up after itself, we love a tidy icon. 🧚✨

💅 OPTIONS 💅

• -a, --auto — Use all Ethernet interfaces currently available 🌈
• -c, --create — Create network interfaces for discovered FCoE VLANs. But heads up: if a VLAN device already exists for a discovered VLAN, a new VLAN device will not be created. No duplicates, no drama. 🙈
• -d, --debug — Enable debugging output. For when you need the whole story. 🔍
• -s, --start — Start the Open-FCoE initiator on discovered FCoE VLANs 🚀
• -m, --mode — fabric|vn2vn — Specify whether VLAN discovery is performed in the default fabric mode, or in VN2VN mode. Pick your fighter. ⚔️
• -f, --suffix suffix — Append the specified string suffix to VLAN interface names. Customization era. 🎀
• -l, --link-retry count — Retry check for link up to count times. The link state is checked every 1000 ms. The default number of retries is 20. Patience is a virtue, bestie. ⏳
• -u, --link-up — Leave link up if a FIP response has been received. If it answered, it stays. 🫶
• -h, --help — Display a help message with basic usage instructions 🆘
• -v, --version — Display the fipvlan version string ⭐

🎀 VLAN NAMING CONVENTIONS 🎀

If a new VLAN device is created, it will have the name dev.vlan; where dev is the name of the Ethernet parent device and vlan is the discovered VLAN ID number. An optional suffix may be appended to this with the the -f command line option.

(Yes, "the the" — we keep it real around here. 😭)

🌈 EXAMPLES 🌈

Display all discoverable VLANs with FCoE services ✨

fipvlan --auto

Discover FCoE VLANs on interface eth2, create VLAN devices and start the Open-FCoE initiator 🔥

fipvlan --create --start eth2

In this example if FCoE services were available on VLAN 101 of network interface eth2, then a VLAN interface eth2.101 would be created and used as the parent device for the initiator. It's giving glow up. 💖

🦋 SEE ALSO 🦋

fcoeadm(8) fcoemon(8) — go say hi to the rest of the squad 💜

💜 SUPPORT 💜

fipvlan is part of the fcoe-utils package, maintained through the Open-FCoE project. Resources for both developers and users can be found at the Open-FCoE website http://open-fcoe.org/ 🌐

ok that's the whole page, you ate that 💅 no cap, every single flag is in there, fr fr.

mwah 💋 — this was Open-FCoE, dated 12/02/2013, and yes that's the version/date sign-off, we're keeping it cute and keeping it accurate. byeeee 🫶✨