X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=pvenode.adoc;h=bace13c3d038544814303c1e22ffe8a07e4c12d7;hb=65eb814d78cec073414907b17f300197ffd75c15;hp=dce428ffbfb051e39a13cbf918f5e0154303042b;hpb=9cbe129fb2975a3a2a3f1a6d474ed113f56357bf;p=pve-docs.git diff --git a/pvenode.adoc b/pvenode.adoc index dce428f..bace13c 100644 --- a/pvenode.adoc +++ b/pvenode.adoc @@ -16,21 +16,72 @@ include::pvenode.1-synopsis.adoc[] DESCRIPTION ----------- endif::manvolnum[] - ifndef::manvolnum[] Proxmox Node Management -======================= +----------------------- +ifdef::wiki[] :pve-toplevel: +endif::wiki[] 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 the `pvenode` tool allows to manage the node's SSL certificates used -for API and the web GUI. It includes an implementation of the **A**utomatic -**C**ertificate **M**anagement **E**nvironment (ACME) protocol, allowing {pve} -admins to interface with Let's Encrypt, with which trusted certificates can be -generated and setup easily. +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[] + +Examples +~~~~~~~~ + +.Install an externally provided certificate + +`pvenode cert set certificate.crt certificate.key -force` + +Both files need to be PEM encoded. `certificate.key` contains the private key +and `certificate.crt` contains the whole certificate chain. + +.Setup ACME account and order a certificate for local node. + +----- +pvenode acme account register default mail@example.invalid +pvenode config set --acme domains=example.invalid +pvenode acme cert order +systemctl restart pveproxy +----- + +endif::manvolnum[] + +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 `` by +running: + +---- +ethtool | grep Wake-on +---- + +`pvenode` allows to wake sleeping members of a cluster via WoL using the +command: + +---- +pvenode wakeonlan +---- + +This broadcasts the WoL magic packet on UDP port 9, containing the MAC address +of `` 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!