docs 📝: Reformatted README.md for better readability and added table of contents.
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 1m20s

Improved the structure and accessibility of the README file by reformatting it and adding a table of contents to make it easier for users to navigate.
This commit is contained in:
2026-01-25 10:44:26 +01:00
parent 9d35c16d2c
commit 9a6ac67e20

View File

@@ -1,8 +1,9 @@
# ansible_proxmox_WOL # ansible_proxmox_WOL
An Ansible role that configures **persistent WakeonLAN (WOL)** on Proxmox VE hosts. An Ansible role that configures **persistent WakeonLAN (WOL)** on Proxmox VE hosts.
It discovers all physical Ethernet interfaces, validates WOL support, and then enables or disables WOL on the interfaces that back the bridges you specify. It discovers all physical Ethernet interfaces, validates WOL support, and then enables or disables
Unlike many WOL setups that rely on *udev* rules, this role uses a lightweight **systemd template unit** (`wol@.service`) so the setting is applied automatically each time an interface comes up, and it survives reboots without any extra steps. WOL on the interfaces that back the bridges you specify. Unlike many WOL setups that rely on *udev* rules,
this role uses a lightweight **systemd template unit** (`wol@.service`) so the setting is applied automatically each time an interface comes up, and it survives reboots without any extra steps.
--- ---
@@ -53,7 +54,7 @@ Unlike many WOL setups that rely on *udev* rules, this role uses a lightweight *
wol_bridges: vmbr0 # string or list bridges that should have WOL enabled wol_bridges: vmbr0 # string or list bridges that should have WOL enabled
wol_mode: "g" # "g"=magic packet (recommended), "d"=disable, "p"/"u"/"m"/"b" for other modes wol_mode: "g" # "g"=magic packet (recommended), "d"=disable, "p"/"u"/"m"/"b" for other modes
wol_verify: true # Verify the interface state after changes wol_verify: true # Verify the interface state after changes
wol_report_mac: true # Include MAC addresses of WOLcapable senders in the report wol_report_mac: true # Include MAC addresses of WOL-capable senders in the report
``` ```
| Variable | Default | Type | Description | | Variable | Default | Type | Description |