5
0
mirror of git://git.proxmox.com/git/pve-docs.git synced 2025-01-07 17:17:48 +03:00
pve-docs/pvenode.adoc
Thomas Lamprecht 31bba0a913 avoid own chapter for meager pvenode, move to sysadmin
As else we have a big promising heading for "PVE Node Management"
with just two acme examples and a bit of Wake-On-LAN support.

Move the latter into sysadmin, the former goes only in man-page
environment, as the ACME docs are much more telling.

Ideally we move some stuff inside pvenode and see if it merits it's
own chapter, separating the more basic "Linux-y" sysadmin stuff from
PVE node, but not today.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-05-06 10:30:37 +02:00

91 lines
2.1 KiB
Plaintext

ifdef::manvolnum[]
pvenode(1)
==========
:pve-toplevel:
NAME
----
pvenode - Proxmox VE Node Management
SYNOPSIS
--------
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 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[]
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 `<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!
ifdef::manvolnum[]
include::pve-copyright.adoc[]
endif::manvolnum[]