projects / pve-docs.git / blame
| Commit | Line | Data |
|---|---|---|
| a99bdc62 FG |
1 | ifdef::manvolnum[] |
| 2 | pvenode(1) | |
| 3 | ========== | |
| 4 | :pve-toplevel: | |
| 5 | ||
| 6 | NAME | |
| 7 | ---- | |
| 8 | ||
| 0e9c6c13 | 9 | pvenode - Proxmox VE Node Management |
| a99bdc62 FG |
10 | |
| 11 | SYNOPSIS | |
| 12 | -------- | |
| 13 | ||
| 14 | include::pvenode.1-synopsis.adoc[] | |
| 15 | ||
| 16 | DESCRIPTION | |
| 17 | ----------- | |
| 18 | endif::manvolnum[] | |
| a99bdc62 FG |
19 | ifndef::manvolnum[] |
| 20 | Proxmox Node Management | |
| 31bba0a9 TL |
21 | ----------------------- |
| 22 | ifdef::wiki[] | |
| a99bdc62 | 23 | :pve-toplevel: |
| 31bba0a9 | 24 | endif::wiki[] |
| a99bdc62 FG |
25 | endif::manvolnum[] |
| 26 | ||
| 0e9c6c13 | 27 | The {PVE} node management tool (`pvenode`) allows to control node specific |
| 9cbe129f TL |
28 | settings and resources. |
| 29 | ||
| aeecd9ea SI |
30 | Currently `pvenode` allows to set a node's description and to manage |
| 31 | the node's SSL certificates used for the API and the web GUI through `pveproxy`. | |
| 32 | ||
| ed53a3e6 | 33 | ifdef::manvolnum[] |
| a5d27935 DM |
34 | include::output-format.adoc[] |
| 35 | ||
| 67c9747f | 36 | Examples |
| 31bba0a9 TL |
37 | ~~~~~~~~ |
| 38 | ||
| 39 | .Install an externally provided certificate | |
| 40 | ||
| aeecd9ea SI |
41 | `pvenode cert set certificate.crt certificate.key -force` |
| 42 | ||
| 31bba0a9 TL |
43 | Both files need to be PEM encoded. `certificate.key` contains the private key |
| 44 | and `certificate.crt` contains the whole certificate chain. | |
| 45 | ||
| 46 | .Setup ACME account and order a certificate for local node. | |
| aeecd9ea SI |
47 | |
| 48 | ----- | |
| 49 | pvenode acme account register default mail@example.invalid | |
| 50 | pvenode config set --acme domains=example.invalid | |
| 51 | pvenode acme cert order | |
| 52 | systemctl restart pveproxy | |
| 53 | ----- | |
| 54 | ||
| 31bba0a9 | 55 | endif::manvolnum[] |
| 9cbe129f | 56 | |
| 42a16720 | 57 | Wake-on-LAN |
| 31bba0a9 | 58 | ~~~~~~~~~~~ |
| 42a16720 | 59 | Wake-on-LAN (WoL) allows to switch on a sleeping computer in the network by |
| 8d926cbe | 60 | sending a magic packet. At least one NIC must support this feature and the |
| 42a16720 CE |
61 | respective option needs to be enabled in the computers firmware (BIOS/UEFI) |
| 62 | configuration. The option name can vary from 'Enable Wake-on-Lan' to | |
| 63 | 'Power On By PCIE Device', check your motherboards vendor manual, if unsure. | |
| 64 | `ethtool` can be used to check the WoL configuration of `<interface>` by | |
| 65 | running: | |
| 66 | ||
| 67 | ---- | |
| 68 | ethtool <interface> | grep Wake-on | |
| 69 | ---- | |
| 70 | ||
| 71 | `pvenode` allows to wake sleeping members of a cluster via WoL using the | |
| 72 | command: | |
| 73 | ||
| 74 | ---- | |
| 75 | pvenode wakeonlan <node> | |
| 76 | ---- | |
| 77 | ||
| 78 | This broadcasts the WoL magic packet on UDP port 9, containing the MAC address | |
| 79 | of `<node>` obtained from the `wakeonlan` property. The node specific | |
| 80 | `wakeonlan` property can be set by the following command: | |
| 81 | ||
| 82 | ---- | |
| 83 | pvenode config set -wakeonlan XX:XX:XX:XX:XX:XX | |
| 84 | ---- | |
| 85 | ||
| 9cbe129f | 86 | // TODO: extend and improve chapter! |
| a99bdc62 FG |
87 | |
| 88 | ifdef::manvolnum[] | |
| 89 | include::pve-copyright.adoc[] | |
| 90 | endif::manvolnum[] |