-----------
endif::manvolnum[]
ifndef::manvolnum[]
+
+[[proxmox_node_management]]
Proxmox Node Management
-----------------------
ifdef::wiki[]
endif::wiki[]
endif::manvolnum[]
-The {PVE} node management tool (`pvenode`) allows to control node specific
+The {PVE} node management tool (`pvenode`) allows you 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`.
+Currently `pvenode` allows you to set a node's description, run various
+bulk operations on the node's guests, view the node's task history, and
+manage the node's SSL certificates, which are used for the API and the web GUI
+through `pveproxy`.
ifdef::manvolnum[]
include::output-format.adoc[]
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.
+.Setup ACME account and order a certificate for the local node.
-----
pvenode acme account register default mail@example.invalid
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)
+Wake-on-LAN (WoL) allows you 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 computer's 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:
+'Power On By PCIE Device'; check your motherboard's vendor manual, if you're
+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
+`pvenode` allows you to wake sleeping members of a cluster via WoL, using the
command:
----
----
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:
+of `<node>` obtained from the `wakeonlan` property. The node-specific
+`wakeonlan` property can be set using the following command:
----
pvenode config set -wakeonlan XX:XX:XX:XX:XX:XX
----
+The interface via which to send the WoL packet is determined from the default
+route. It can be overwritten by setting the `bind-interface` via the following
+command:
+
+----
+pvenode config set -wakeonlan XX:XX:XX:XX:XX:XX,bind-interface=<iface-name>
+----
+
+The broadcast address (default `255.255.255.255`) used when sending the WoL
+packet can further be changed by setting the `broadcast-address` explicitly
+using the following command:
+
+----
+pvenode config set -wakeonlan XX:XX:XX:XX:XX:XX,broadcast-address=<broadcast-address>
+----
+
Task History
~~~~~~~~~~~~
The log of a task can then be printed using its UPID:
----
-pvenode task log UPID:pve1:00010D94:001CA6EA:6124E1B9:vzdump:100:root@pam:
+pvenode task log UPID:pve1:00010D94:001CA6EA:6124E1B9:vzdump:100:root@pam:
----
pvenode stopall
----
+NOTE: The stopall command first attempts to perform a clean shutdown and then
+waits until either all guests have successfully shut down or an overridable
+timeout (3 minutes by default) has expired. Once that happens and the
+force-stop parameter is not explicitly set to 0 (false), all virtual guests
+that are still running are hard stopped.
+
[[first_guest_boot_delay]]
First Guest Boot Delay
pvenode migrateall pve2 --vms 100,101,102 --with-local-disks
----
+// TODO: explain node shutdown (stopall is used there) and maintenance options
ifdef::manvolnum[]
include::pve-copyright.adoc[]
projects / pve-docs.git / blobdiff