FCOEADM(8)

💖 FCOEADM(8) — the Open-FCoE Administration Tool 💖

okay bestie, welcome to fcoeadm, straight out of the Open-FCoE Tools lineup, and she is that girl when it comes to wrangling Fibre Channel over Ethernet. this is the section 8 admin page, so grab a snack, we're going in 🫶

---

✨ NAME ✨

fcoeadm — the Open-FCoE Administration Tool. yeah. that's her. 👑

---

🌸 SYNOPSIS 🌸

fcoeadm [-m|--mode fabric|vn2vn] -c|--create ethX

fcoeadm -d|--destroy ethX

fcoeadm -r|--reset ethX

fcoeadm -S|--Scan [ethX]

fcoeadm -i|--interface [ethX]

fcoeadm -f|--fcf [ethX]

fcoeadm -t|--target [ethX]

fcoeadm -l|--lun [ethX]

fcoeadm -s|--stats ethX [interval]

fcoeadm -b|--lesb ethX [interval]

fcoeadm -h|--help

fcoeadm -v|--version

---

🦋 DESCRIPTION 🦋

so fcoeadm is the Fibre Channel over Ethernet (FCoE) management tool for the Open-FCoE project, and she's got range: you can use her to create, destroy, and reset an FCoE instance on any given network interface. and how does she pull that off? for these operations, fcoeadm sends a command to a running fcoemon process, through a socket interface, and then fcoemon goes ahead and performs the operation you asked for. teamwork, no cap. 🤝

she also does the informational side of things — querying stuff about FCoE instances, like interface info, target info, LUN info, and port statistics. for a whole lot of that info, fcoeadm leans on the libhbalinux implementation of the HBA API. and listen: only one operation may be given on a command. one. just one. she is not a multitasker, she is a specialist. 💅

---

🎀 OPTIONS 🎀

• -m, --mode fabric|vn2vn — this one rides along with the create option to control the FCoE mode of operation. the mode defaults to fabric, but with this option you can pick vn2vn mode instead. little mode switch, big energy. ✨

---

👑 OPERATIONS 👑

• -c, --create ethX — creates an FCoE instance based on the network interface you specify. heads up though: if there is not an fcoemon configuration file for that interface (/etc/fcoe/cfg-ethX, see fcoemon), then the created FCoE instance won't require DCB. noted 📝
• -d, --destroy ethX — destroys the FCoE instance on the network interface you specify. important: this will not destroy FCoE instances created by fipvlan. she doesn't touch other people's work 💀
• -r, --reset ethX — resets the FCoE instance on the network interface you specify. and same deal: this will not reset FCoE instances created by fipvlan.
• -S, --Scan ethX — rescans for new targets and LUNs on the instance you provide. two things she won't do here: this command will not rescan any NPIV instances created on the same port, and it will not rescan any FCoE instance created by fipvlan. read the fine print bestie 📖
• -i, --interface [ethX] — shows info about the FCoE instance on the network interface you specify — or, if you don't specify a network interface, about all FCoE instances. no interface? no problem 💖
• -f, --fcf [ethX] — shows info about the discovered Fibre Channel Forwarders (FCFs) on the network interface you specify — or all discovered FCFs if you leave the network interface out.
• -t, --target [ethX] — shows info about the discovered targets associated with the FCoE instance on the network interface you specify. if no network interface is given, you get info about discovered targets from all FCoE instances. the more the merrier 🌈
• -l, --lun [ethX] — shows detailed info about the discovered SCSI LUNs associated with the FCoE instance on the network interface you specify. if no network interface is given, you get SCSI LUN info from all FCoE instances.
• -s, --stats ethX [interval] — shows the statistics (including FC4 statistics 🎀) of the FCoE connection on the network interface you specify. the info will be displayed repeatedly until the user cancels the command. the statistics get printed every specified interval (in seconds). interval should be specified as a whole number greater than 0. if interval isn't specified, the default interval is one second. forever and ever until you say stop, basically 😭
• -b, --lesb ethX [interval] — shows the Link Error Statistics Block (LESB) of the FCoE connection on the network interface you specify. same vibe: the info is displayed repeatedly until the user cancels the command, and the LESB statistics get printed every specified interval (in seconds). interval should be specified in whole integers greater than 0. if the interval isn't specified, the default interval is one second.
• -h, --help — displays the usage message of the fcoeadm command. your friendly lil cheat sheet 🫶
• -v, --version — displays the version of the fcoeadm command.

---

🧚 INTERFACE NAMES 🧚

the actual name for ethX depends on the AUTO_VLAN setting in the fcoemon interface configuration (/etc/fcoe/cfg-ethX, see fcoemon).

• if AUTO_VLAN is set to yes, the interface name ethX references the network device itself.
• if AUTO_VLAN is set to no, the interface name ethX references the VLAN device.

that's the whole tea. ☕

---

🔥 EXAMPLES 🔥

creates an FCoE instance on eth2.101

fcoeadm -c eth2.101

creates an FCoE VN2VN instance on eth2.101

fcoeadm -m vn2vn -c eth2.101

destroys the FCoE instance on eth2.101

fcoeadm -d eth2.101

resets the FCoE instance on eth2.101

fcoeadm -r eth2.101

show the information of all the adapters and their ports having FCoE instances created

fcoeadm -i

show the information of all FCoE instances on interface eth3.

fcoeadm -i eth3

show the information of all the discovered targets from all the ports having FCoE instances created (they may be on different adapter cards). a brief listing of discovered LUNs are listed after the target they are associated with, if any

fcoeadm -t

show the information of all the discovered targets from a given port (eth3) having FCoE instance created. a brief listing of discovered LUNs are listed after each target they are associated with, if any

fcoeadm -t eth3

show the detailed information of all the LUNs discovered on all FCoE connections

fcoeadm -l

show the detailed information of all the LUNs associated with a specific interface

fcoeadm -l eth3.101

show the statistics information of a specific port eth3 having FCoE instances created. the statistics are displayed one line per time interval. the default interval is one second if an interval is not specified

fcoeadm -s eth3

fcoeadm -s eth3 3

---

💜 SEE ALSO 💜

fcoemon(8) — go say hi to her sister, they're a package deal 💫

---

🌈 SUPPORT 🌈

fcoeadm 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/

---

okay and that's the whole page, bestie!! 🎀 this one's brought to you by the Open-FCoE girlies, dated 10/14/2013 — yeah she's an elder but she still ate, fr fr. now go create some instances, slay responsibly, and remember: only one operation per command. mwah 💅💖✨