[pve-devel] [PATCH pve-docs] pvenode: add WOL section to doc

[Christian Ebner]

Adds a section containing information about the wake on LAN feature to the
pvenode documentation.

Signed-off-by: Christian Ebner <c.ebner at proxmox.com>
---
 pvenode.adoc | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/pvenode.adoc b/pvenode.adoc
index a41085f..df17f93 100644
--- a/pvenode.adoc
+++ b/pvenode.adoc
@@ -50,6 +50,17 @@ systemctl restart pveproxy
 
 Setup ACME account and order a certificate for local node.
 
+Wake-on-LAN
+-----------
+`pvenode` allows to wake sleeping nodes in a cluster via a Wake-on-LAN (WOL)
+packet. For this to work, the network interface of the node to wake must support
+WOL as well as have it enabled.
+
+`pvenode wakeonlan <node>` is used to wake the sleeping `<node>`.
+It sends the WOL magic packet via an UDP broadcast to `255.255.255.255` on
+port 9. The MAC address of `<node>` is obtained from the `wakeonlan` property
+specified in the per node configuration `/etc/pve/nodes/{node}/config`.
+
 // TODO: extend and improve chapter!
 
 ifdef::manvolnum[]
-- 
2.11.0