docs 📝: Reformatted README.md for better readability and added table of contents.
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:
25
README.md
25
README.md
@@ -1,22 +1,23 @@
|
||||
# ansible_proxmox_WOL
|
||||
|
||||
An Ansible role that configures **persistent Wake‑on‑LAN (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.
|
||||
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.
|
||||
It discovers all physical Ethernet interfaces, validates WOL support, and then enables or disables
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Features](#features)
|
||||
- [Prerequisites](#prerequisites)
|
||||
- [Role Variables](#role-variables)
|
||||
- [How It Works](#how-it-works)
|
||||
- [Usage](#usage)
|
||||
- [Common Proxmox Scenarios](#common-proxmox-scenarios)
|
||||
- [Troubleshooting](#troubleshooting)
|
||||
- [License](#license)
|
||||
- [Author](#author)
|
||||
- [Features](#features)
|
||||
- [Prerequisites](#prerequisites)
|
||||
- [Role Variables](#role-variables)
|
||||
- [How It Works](#how-it-works)
|
||||
- [Usage](#usage)
|
||||
- [Common Proxmox Scenarios](#common-proxmox-scenarios)
|
||||
- [Troubleshooting](#troubleshooting)
|
||||
- [License](#license)
|
||||
- [Author](#author)
|
||||
|
||||
---
|
||||
|
||||
@@ -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_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_report_mac: true # Include MAC addresses of WOL‑capable senders in the report
|
||||
wol_report_mac: true # Include MAC addresses of WOL-capable senders in the report
|
||||
```
|
||||
|
||||
| Variable | Default | Type | Description |
|
||||
|
||||
Reference in New Issue
Block a user