Update TFA documentation

[pve-docs.git] / pvenode.adoc

diff --git a/pvenode.adoc b/pvenode.adoc
index 073a30180a25e6a1df4a40a0f8e0c613c9268832..38d1c4e17b7411c4665c6d9e46e86ddf234f02bd 100644 (file)
--- a/pvenode.adoc
+++ b/pvenode.adoc
@@ -6,7 +6,7 @@ pvenode(1)
 NAME
 ----
 
-pvenode - {PVE} Node Management
+pvenode - Proxmox VE Node Management
 
 SYNOPSIS
 --------
@@ -23,12 +23,16 @@ Proxmox Node Management
 :pve-toplevel:
 endif::manvolnum[]
 
-The {PVE} node management tools (`pvenode`) allows to control node specific
+The {PVE} node management tool (`pvenode`) allows to control node specific
 settings and resources.
 
 Currently `pvenode` allows to set a node's description and to manage
 the node's SSL certificates used for the API and the web GUI through `pveproxy`.
 
+ifdef::manvolnum[]
+include::output-format.adoc[]
+endif::manvolnum[]
+
 EXAMPLES
 --------
 `pvenode cert set certificate.crt certificate.key -force`
@@ -44,7 +48,36 @@ pvenode acme cert order
 systemctl restart pveproxy
 -----
 
-Configure acme to get certificates.
+Setup ACME account and order a certificate for local node.
+
+Wake-on-LAN
+-----------
+Wake-on-LAN (WoL) allows to switch on a sleeping computer in the network by
+sending a magic packet. At least one NIC must support this feature and the
+respective option needs to be enabled in the computers firmware (BIOS/UEFI)
+configuration. The option name can vary from 'Enable Wake-on-Lan' to
+'Power On By PCIE Device', check your motherboards vendor manual, if unsure.
+`ethtool` can be used to check the WoL configuration of `<interface>` by
+running:
+
+----
+ethtool <interface> | grep Wake-on
+----
+
+`pvenode` allows to wake sleeping members of a cluster via WoL using the
+command:
+
+----
+pvenode wakeonlan <node>
+----
+
+This broadcasts the WoL magic packet on UDP port 9, containing the MAC address
+of `<node>` obtained from the `wakeonlan` property. The node specific
+`wakeonlan` property can be set by the following command:
+
+----
+pvenode config set -wakeonlan XX:XX:XX:XX:XX:XX
+----
 
 // TODO: extend and improve chapter!