Feature request: a way to handle USB Ethernet adapters shared between many hosts
-
Hi all, and thanks for FOG.
We run it in a school (about 280 hosts, FOG 1.6.0.14) and we have a problem that I think many schools with laptops share. A lot of our laptops have no Ethernet port, so for imaging we plug in a USB Ethernet adapter and PXE boot from it. The same few adapters get moved from laptop to laptop, and since FOG identifies a host by the MAC it boots with, it always sees the adapter’s MAC and therefore always the same host.
What we do today is move that MAC by hand: delete it from the previous host, add it to the laptop we are about to image, and mark it as primary. It works, but it is easy to forget a step. If the MAC stays on two hosts,
getHostByMacAddressesfalls back on the primary flag, and if that does not settle it, the log shows multiple hosts.The ignore flags don’t help either. From what I read in
parseMacList(I might be wrong), IMI / IMC are looked up across all the rows with that MAC, not per host, so marking the adapter as ignored for imaging on one host hides it for everybody, including the laptop you actually want to image.What would make this much easier is some way to tell FOG that a MAC belongs to a shared or removable adapter. When a MAC flagged like that PXE boots, FOG would not bind it to a fixed host, but let you choose the host at boot (a list of hosts that have a task queued, or typing a hostname), or pick the one that has a pending task. Another option would be to let a task carry the MAC it should be matched with, only for that task, so you could schedule the deploy for the laptop with the adapter’s MAC and nothing else would need to change in the host.
Another way to look at it, which might be simpler to build: let us define a MAC as an installation MAC (or “multi-host” MAC), one that is allowed to be linked to a host only for the duration of a task. You would attach it to the laptop you are about to image, run the deploy or capture, and when the task finishes FOG would detach it automatically, so it is free for the next machine and never ends up on two hosts at once. That would also remove the need for the ignore flags in this case, since the MAC would only live on a host while a task is running.
I’m happy to test anything on our side. And if there is already a recommended way to handle shared USB adapters that I have missed, I’d be glad to hear it.
-
@lperoma 1.6.0 can already identify a host by its firmware instead of its MAC. That is the case a shared USB adapter breaks.
At boot, iPXE sends the SMBIOS UUID, the system serial, the board serial and the asset tag. The server matches them against the inventory of every host. The setting FOG Configuration > FOG Settings > FOG_HOST_IDENTIFY_SMBIOS controls what happens with the result:
- off: the MAC decides, as before.
- log (the default): the MAC still decides. Each disagreement goes to the web server error log as a
FOG host identityline. - enforce: when the firmware points at exactly one host, that host wins over the MAC.
Set it to enforce. Then a laptop that FOG already knows by its firmware boots as itself, even with the adapter’s MAC. No MAC moves by hand, and the adapter MAC on another host no longer matters for that boot. A tie (for example two VMs with one UUID) is never trusted. FOG falls back to the MAC in that case.
The precondition: each laptop needs its firmware identity in its host’s inventory. A full FOS inventory or a full registration stores it.
One gap we know about: registering a brand-new laptop through an adapter whose MAC is already on another host. The MAC finds the other host first, so registration says “already registered”. We are looking at that case now. If you can test enforce on a few laptops that are already registered, the
FOG host identitylines in the Apache/PHP error log show what FOG decided for each boot. -
@lperoma A follow-up. While I checked this case, I found a bug that affects shared adapters. It is now fixed.
The bug: at each boot, FOG records the firmware identity onto the host it resolved. With a shared adapter, the MAC resolves to the host the adapter is registered on. So the laptop that booted wrote its UUID onto that other host. In the default
logmode this happened on every boot through the adapter. Over time, it corrupts the identity data thatenforcemode matches on.The fix: FOG now compares the serial numbers first. When the stored system serial and the reported one differ, it is a different machine. FOG writes nothing to that host and logs one
FOG host identityline that says “another machine, nothing recorded”. A motherboard swap that keeps the service tag still updates the UUID as before.To get it: the fix is on the patches channel (dev-branch, PR #2100). Run the updater on that channel, or wait for the next release.
After you update: run a full inventory on any host that a shared adapter booted as. That puts its own serials and UUID back. Then
enforcematches each laptop reliably. -
@Tom-Elliott Thanks so much!
-
@Tom-Elliott Thanks a lot, Tom. I tested it today on 1.6.0.14, with the two files from PR #2100 applied by hand (
SmbiosIdentity.phpandIpxeBootMenu.php) andFOG_HOST_IDENTIFY_SMBIOSset toenforce.I used two Proxmox VMs, both already registered, each with its own UUID. I gave one of them the MAC of the other and booted it by PXE. The menu said
Host is registered as bios-test!, which is the right one, and the log shows what happened:FOG host identity (enforce): MAC resolved "uefi-test" (id 658); SMBIOS resolved "bios-test" (id 659) on sysuuid=795efc04-...; SMBIOS winsBoth inventories were left alone and the MAC stayed on the first host. Without the patch the same thing overwrote the UUID of the host that owned the MAC, as you described.
I also hit the gap you mentioned, with a machine FOG did not know yet. Before registering the second VM I gave it the MAC of the first, and FOG took it for the first host. The agent did the same: the enrollment request of the second VM got attached to the first host (reason
known-host-no-agent). I don’t know if that last part is worth a look on your side.I have only tested VMs so far. The real case is a few laptops that share one USB adapter,
-
@lperoma Thank you for testing this so thoroughly. The
SMBIOS winsline and the untouched inventories are exactly the expected result.The agent part is worth a look, yes. Agent enrollment falls back to the MAC when the firmware matches no host. So an unregistered machine with a known MAC lands on that MAC’s host. Within the deploy window after an image (
FOG_AGENT_ENROLL_DEPLOY_WINDOW, 24 hours by default), that request can be approved without an admin click. I am fixing that so a machine whose serial contradicts the host is never bound to it by MAC.Until the fix is out, set
FOG_AGENT_ENROLL_DEPLOY_WINDOWto 0 if you image through shared adapters. Every enrollment then waits for an approval or a token.Your last post looks cut off after “a few laptops that share one USB adapter,”. Did you mean to add more?
-
@lperoma The agent fix is done (PR #2104).
What changes: suppose the firmware of an enrolling machine matches no host, and only its MAC finds one. If the machine’s serial contradicts the serial stored for that host, FOG no longer binds it as that host’s first agent. The request is recorded as an identity conflict. The deploy window never approves a conflict, so it waits for an admin. An admin can still approve it on purpose, for example after a real motherboard swap. The directory identity check treats the same case as a conflict too.
What does not change:
- An enroll token still approves the request. A token is an admin’s explicit vouch.
- A host with no inventory row has no stored serial to compare, so its MAC still binds as before. Run a full inventory on hosts that share an adapter.
- A request that was already pending before you update keeps its old reason. Deny any such request that you do not recognize.
To get it: it reaches the patches channel when the PR merges. After you update, you can set
FOG_AGENT_ENROLL_DEPLOY_WINDOWback to its default (24) if you set it to 0. -
@Tom-Elliott Thanks a lot Tom, that was fast.
I’m still on 1.6.0.14, and I couldn’t apply #2104 by hand like I did with #2100: it patches
MachineIdentity.php, which doesn’t exist in my version, and the change inEnrollment.phpcalls it. So I’ll wait for the update instead. Do you know which stable release is expected to include it?I’ll also run a full inventory on the hosts that share an adapter, as you suggest, so they have a serial stored. And I’ll report back once I’ve tried it with real laptops.
-
@lperoma The next stable will be auto promoted from dev-branch -> stable on December 11th at some point in the day.
11th of every month is when dev-branch fixes get pulled into stable.
As to the “Version” it will be, it’s however many commits since.
Right now .14 means there were 14 commits after master containing 1.6.0, 158 is the current stable branch meaning 158 total commits since it’s original release.
Some months will be less, some will be much more.
If you wanted you can install dev-branch but I understand the feeling of “well it’s not stable”.