docs 📝: Fix typo and update bridge layout
Some checks failed
ansible-lint / Ansible Lint (push) Successful in 10s
Gitleaks Scan / gitleaks (push) Successful in 5s
Markdown Lint / markdown-lint (push) Failing after 1m8s

Corrected a minor typo in the README.md file and improved the visual clarity of the bridge layout.
This commit is contained in:
2026-01-25 11:19:52 +01:00
parent b9358eb043
commit 8be72bc931

View File

@@ -83,7 +83,7 @@ If a bridge is built on a bond (e.g., `bond0`), every slave is treated as a cand
- If `wol_mode` is `'d'`, the role ensures WOL is disabled.
7. **Deploy systemd template** Copies `templates/wol@.service.j2` to `/etc/systemd/system/wol@.service`.
The template contains `ExecStart=/usr/sbin/ethtool -s %I wol {{ wol_mode }}`.
8. **Enable service per interface** For every interface, the role starts the unit
8. **Enable service per interface** For every interface, the role starts the unit
`wol@<iface>.service` and enables it to run on boot.
9. **Report** A final summary is printed, optionally listing MAC addresses if `wol_report_mac`
is `true`.
@@ -117,7 +117,8 @@ is `true`.
- vmbr2
```
> **Result** All three bridges are processed; the physical NICs that belong to each bridge receive the configured WOL mode.
> **Result** All three bridges are processed; the physical NICs that belong to each bridge
> receive the configured WOL mode.
### Disable WOL
@@ -151,10 +152,12 @@ is `true`.
## Common Proxmox Scenarios
| Scenario | Bridge / NIC Layout | What the role does |
|----------|---------------------|--------------------|
|----------|-------------------|------------------|
| **Standard vmbr0** | `eno1``vmbr0` | Enables WOL on `eno1`. |
| **Bonded NICs** | `eno1`, `eno2``bond0``vmbr0` | Detects `bond0` and sets WOL on *both* slaves. |
| **Multiple Bridges** | `eno1``vmbr0` <br> `eno2``vmbr1` <br> `eno3`, `eno4``bond0``vmbr2` | One role run configures all three bridges automatically. |
| **Multiple Bridges** | `eno1``vmbr0` \
`eno2``vmbr1` \
`eno3`, `eno4``bond0``vmbr2` | One role run configures all three bridges automatically. |
---
@@ -162,7 +165,7 @@ is `true`.
| Problem | Likely Cause | Fix |
|---------|--------------|-----|
| **No interfaces found that support WOL** | BIOS WOL disabled, NIC driver doesnt expose the feature, or interface isnt a physical NIC. | Enable WOL in BIOS, run `ethtool <iface>` manually, verify `ansible -m setup <host> | grep ansible_interfaces`. |
| **No interfaces found that support WOL** | BIOS WOL disabled, NIC driver doesnt expose the feature, or interface isnt a physical NIC. | Enable WOL in BIOS, run `ansible -m setup <host> \| grep ansible_interfaces`. |
| **Unable to detect bridge backing NIC(s)** | Bridge doesnt exist or the NIC isnt a member of it. | Verify with `bridge link show` / `brctl show`. |
| **WOL not persisting after reboot** | `wol@.service` isnt enabled, or `ethtool` isnt installed. | Ensure the role ran successfully, check `/etc/systemd/system/wol@.service` and `systemctl status wol@<iface>.service`. |
| **Bond0 not detected** | Bond configuration file missing or wrong. | Check `/proc/net/bonding/bond0`. |