docs 📝: Refactor README.md with detailed features, role variables, and usage examples.

Updated the README to provide comprehensive information on the Ansible Proxmox WOL role's features, variables, and usage examples.
This commit is contained in:
2025-12-23 22:06:51 +01:00
parent 7a388c1d55
commit 6cd75b5b8d
3 changed files with 397 additions and 76 deletions

View File

@@ -1,13 +1,27 @@
# defaults/main.yml
# Bridge interface to enable Wake-on-LAN on
wol_bridge: vmbr0
---
# ============================================================
# Bridge interfaces to enable Wake-on-LAN on
# Can be a string (single bridge) or list (multiple bridges)
# Supports detection of physical NICs backing bridges
# ============================================================
wol_bridges: vmbr0
# WOL mode:
# g = magic packet (most common)
# ============================================================
# WOL mode options:
# g = magic packet (most common, highly recommended)
# d = disable Wake-on-LAN
# p = physical activity
# u = unicast frames
# m = multicast frames
# b = broadcast frames
# ============================================================
wol_mode: "g"
# Enable verification task
# ============================================================
# Verification settings
# ============================================================
# Enable WOL status verification after configuration
wol_verify: true
# Report MAC address for WOL senders
# Report MAC addresses for WOL packet senders
wol_report_mac: true