9 pvenode - Proxmox VE Node Management
14 include::pvenode.1-synopsis.adoc[]
21 [[proxmox_node_management]]
22 Proxmox Node Management
23 -----------------------
29 The {PVE} node management tool (`pvenode`) allows you to control node specific
30 settings and resources.
32 Currently `pvenode` allows you to set a node's description, run various
33 bulk operations on the node's guests, view the node's task history, and
34 manage the node's SSL certificates, which are used for the API and the web GUI
38 include::output-format.adoc[]
43 .Install an externally provided certificate
45 `pvenode cert set certificate.crt certificate.key -force`
47 Both files need to be PEM encoded. `certificate.key` contains the private key
48 and `certificate.crt` contains the whole certificate chain.
50 .Setup ACME account and order a certificate for the local node.
53 pvenode acme account register default mail@example.invalid
54 pvenode config set --acme domains=example.invalid
55 pvenode acme cert order
56 systemctl restart pveproxy
63 Wake-on-LAN (WoL) allows you to switch on a sleeping computer in the network, by
64 sending a magic packet. At least one NIC must support this feature, and the
65 respective option needs to be enabled in the computer's firmware (BIOS/UEFI)
66 configuration. The option name can vary from 'Enable Wake-on-Lan' to
67 'Power On By PCIE Device'; check your motherboard's vendor manual, if you're
68 unsure. `ethtool` can be used to check the WoL configuration of `<interface>`
72 ethtool <interface> | grep Wake-on
75 `pvenode` allows you to wake sleeping members of a cluster via WoL, using the
79 pvenode wakeonlan <node>
82 This broadcasts the WoL magic packet on UDP port 9, containing the MAC address
83 of `<node>` obtained from the `wakeonlan` property. The node-specific
84 `wakeonlan` property can be set using the following command:
87 pvenode config set -wakeonlan XX:XX:XX:XX:XX:XX
93 When troubleshooting server issues, for example, failed backup jobs, it can
94 often be helpful to have a log of the previously run tasks. With {pve}, you can
95 access the nodes's task history through the `pvenode task` command.
97 You can get a filtered list of a node's finished tasks with the `list`
98 subcommand. For example, to get a list of tasks related to VM '100'
99 that ended with an error, the command would be:
102 pvenode task list --errors --vmid 100
105 The log of a task can then be printed using its UPID:
108 pvenode task log UPID:pve1:00010D94:001CA6EA:6124E1B9:vzdump:100:root@pam:
112 Bulk Guest Power Management
113 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
115 In case you have many VMs/containers, starting and stopping guests can be
116 carried out in bulk operations with the `startall` and `stopall` subcommands of
117 `pvenode`. By default, `pvenode startall` will only start VMs/containers which
118 have been set to automatically start on boot (see
119 xref:qm_startup_and_shutdown[Automatic Start and Shutdown of Virtual Machines]),
120 however, you can override this behavior with the `--force` flag. Both commands
121 also have a `--vms` option, which limits the stopped/started guests to the
124 For example, to start VMs '100', '101', and '102', regardless of whether they
125 have `onboot` set, you can use:
128 pvenode startall --vms 100,101,102 --force
131 To stop these guests (and any other guests that may be running), use the
139 [[first_guest_boot_delay]]
140 First Guest Boot Delay
141 ~~~~~~~~~~~~~~~~~~~~~~
143 In case your VMs/containers rely on slow-to-start external resources, for
144 example an NFS server, you can also set a per-node delay between the time {pve}
145 boots and the time the first VM/container that is configured to autostart boots
146 (see xref:qm_startup_and_shutdown[Automatic Start and Shutdown of Virtual Machines]).
148 You can achieve this by setting the following (where `10` represents the delay
152 pvenode config set --startall-onboot-delay 10
159 In case an upgrade situation requires you to migrate all of your guests from one
160 node to another, `pvenode` also offers the `migrateall` subcommand for bulk
161 migration. By default, this command will migrate every guest on the system to
162 the target node. It can however be set to only migrate a set of guests.
164 For example, to migrate VMs '100', '101', and '102', to the node 'pve2', with
165 live-migration for local disks enabled, you can run:
168 pvenode migrateall pve2 --vms 100,101,102 --with-local-disks
173 include::pve-copyright.adoc[]