backup: clarify that CLI means FS-level and highlight retention-note

[pve-docs.git] / pvecm.1-synopsis.adoc

diff --git a/pvecm.1-synopsis.adoc b/pvecm.1-synopsis.adoc
index adb92f69d94583859f9ebb3571ac1becda7b7cbe..e0bdec2a3abc882ddf9f3c477bd5650d09a8da62 100644 (file)
--- a/pvecm.1-synopsis.adoc
+++ b/pvecm.1-synopsis.adoc
@@ -18,7 +18,7 @@ Do not throw error if node already exists.
 
 `--link[n]` `[address=]<IP> [,priority=<integer>]` ::
 
-Address and priority information of a single corosync link.
+Address and priority information of a single corosync link. (up to 8 links supported; link0..link7)
 
 `--nodeid` `<integer> (1 - N)` ::
 
@@ -40,13 +40,21 @@ Adds a node to the cluster configuration. This call is for internal use.
 
 The cluster node name.
 
+`--apiversion` `<integer>` ::
+
+The JOIN_API_VERSION of the new node.
+
 `--force` `<boolean>` ::
 
 Do not throw error if node already exists.
 
 `--link[n]` `[address=]<IP> [,priority=<integer>]` ::
 
-Address and priority information of a single corosync link.
+Address and priority information of a single corosync link. (up to 8 links supported; link0..link7)
+
+`--new_node_ip` `<string>` ::
+
+IP Address of node to add. Used as fallback if no links are given.
 
 `--nodeid` `<integer> (1 - N)` ::
 
@@ -56,9 +64,14 @@ Node id for this node.
 
 Number of votes for this node
 
+*pvecm apiver*
+
+Return the version of the cluster join API available on this node.
+
 *pvecm create* `<clustername>` `[OPTIONS]`
 
-Generate new cluster configuration.
+Generate new cluster configuration. If no links given, default to local IP
+address as link0.
 
 `<clustername>`: `<string>` ::
 
@@ -66,7 +79,7 @@ The name of the cluster.
 
 `--link[n]` `[address=]<IP> [,priority=<integer>]` ::
 
-Address and priority information of a single corosync link.
+Address and priority information of a single corosync link. (up to 8 links supported; link0..link7)
 
 `--nodeid` `<integer> (1 - N)` ::
 
@@ -112,6 +125,26 @@ Generate new cryptographic key for corosync.
 
 Output file name
 
+*pvecm mtunnel* `[<extra-args>]` `[OPTIONS]`
+
+Used by VM/CT migration - do not use manually.
+
+`<extra-args>`: `<array>` ::
+
+Extra arguments as array
+
+`--get_migration_ip` `<boolean>` ('default =' `0`)::
+
+return the migration IP, if configured
+
+`--migration_network` `<string>` ::
+
+the migration network used to detect the local migration IP
+
+`--run-command` `<boolean>` ::
+
+Run a command with a tcp socket as standard input. The IP address and port are printed via this command's stdandard output first, each on a separate line.
+
 *pvecm nodes*
 
 Displays the local view of the cluster nodes.
@@ -146,7 +179,7 @@ Update node certificates (and generate all needed files/directories).
 
 `--force` `<boolean>` ::
 
-Force generation of new SSL certifate.
+Force generation of new SSL certificate.
 
 `--silent` `<boolean>` ::