You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

87 lines
2.1KB

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