pvenode.adoc

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