[pve-devel] [PATCH docs 3/3] add migrate all chapter to pvecm.adoc

[Dominik Csapak]

this explains how to migrate all vms off a node, and what the options
are

Signed-off-by: Dominik Csapak <d.csapak at proxmox.com>
---
 pvecm.adoc | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/pvecm.adoc b/pvecm.adoc
index a8f017c..10cd7fe 100644
--- a/pvecm.adoc
+++ b/pvecm.adoc
@@ -991,6 +991,29 @@ migration: secure,network=10.1.2.0/24
 NOTE: The migration type must always be set when the migration network
 gets set in `/etc/pve/datacenter.cfg`.
 
+[[pvecm_migrate_all]]
+Migrate All
+~~~~~~~~~~~
+
+You can migrate all Containers and VMs from one node to another, with
+the api call /nodes/NODENAME/migrateall. This can be done either via
+the pvesh:
+
+ pvesh create /nodes/NODENAME/migrateall
+
+or via the webgui under the 'More' button.
+
+There are 3 Options with this 'Migrate All' Action:
+
+* maxworkers: defines the maximum simultaneous migrations which the node will
+  execute (e.g. maxworkers=3 will always migrate 3 VMs/Container at the same time)
+* onlineonly: if this is true, the node will only try to migrate the VMs
+  and Containers which are online
+* sharedonly: if this is true, the node will only try to migrate the VMs and
+  Containers which have only resources on shared storage
+
+CAUTION: Online Containers will be migrated in restart mode, so to avoid long
+Downtime of Containers with local storage, use the sharedonly flag.
 
 ifdef::manvolnum[]
 include::pve-copyright.adoc[]
-- 
2.1.4