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 cbf32fa2069dfcd59411d580cf71aa6d88ad0ca1..e0bdec2a3abc882ddf9f3c477bd5650d09a8da62 100644 (file)
--- a/pvecm.1-synopsis.adoc
+++ b/pvecm.1-synopsis.adoc
@@ -16,17 +16,13 @@ Certificate SHA 256 fingerprint.
 
 Do not throw error if node already exists.
 
-`--nodeid` `<integer> (1 - N)` ::
-
-Node id for this node.
-
-`--ring0_addr` `<string>` ('default =' `Hostname of the node`)::
+`--link[n]` `[address=]<IP> [,priority=<integer>]` ::
 
-Hostname (or IP) of the corosync ring0 address of this node.
+Address and priority information of a single corosync link. (up to 8 links supported; link0..link7)
 
-`--ring1_addr` `<string>` ::
+`--nodeid` `<integer> (1 - N)` ::
 
-Hostname (or IP) of the corosync ring1 address of this node. Requires a valid configured ring 1 (bindnet1_addr) in the cluster.
+Node id for this node.
 
 `--use_ssh` `<boolean>` ::
 
@@ -38,60 +34,57 @@ Number of votes for this node
 
 *pvecm addnode* `<node>` `[OPTIONS]`
 
-Adds a node to the cluster configuration.
+Adds a node to the cluster configuration. This call is for internal use.
 
 `<node>`: `<string>` ::
 
 The cluster node name.
 
+`--apiversion` `<integer>` ::
+
+The JOIN_API_VERSION of the new node.
+
 `--force` `<boolean>` ::
 
 Do not throw error if node already exists.
 
-`--nodeid` `<integer> (1 - N)` ::
+`--link[n]` `[address=]<IP> [,priority=<integer>]` ::
 
-Node id for this node.
+Address and priority information of a single corosync link. (up to 8 links supported; link0..link7)
 
-`--ring0_addr` `<string>` ('default =' `Hostname of the node`)::
+`--new_node_ip` `<string>` ::
 
-Hostname (or IP) of the corosync ring0 address of this node.
+IP Address of node to add. Used as fallback if no links are given.
 
-`--ring1_addr` `<string>` ::
+`--nodeid` `<integer> (1 - N)` ::
 
-Hostname (or IP) of the corosync ring1 address of this node. Requires a valid configured ring 1 (bindnet1_addr) in the cluster.
+Node id for this node.
 
 `--votes` `<integer> (0 - N)` ::
 
 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>` ::
 
 The name of the cluster.
 
-`--bindnet0_addr` `<string>` ::
-
-This specifies the network address the corosync ring 0 executive should bind to and defaults to the local IP address of the node.
-
-`--bindnet1_addr` `<string>` ::
+`--link[n]` `[address=]<IP> [,priority=<integer>]` ::
 
-This specifies the network address the corosync ring 1 executive should bind to and is optional.
+Address and priority information of a single corosync link. (up to 8 links supported; link0..link7)
 
 `--nodeid` `<integer> (1 - N)` ::
 
 Node id for this node.
 
-`--ring0_addr` `<string>` ('default =' `Hostname of the node`)::
-
-Hostname (or IP) of the corosync ring0 address of this node.
-
-`--ring1_addr` `<string>` ::
-
-Hostname (or IP) of the corosync ring1 address of this node. Requires a valid configured ring 1 (bindnet1_addr) in the cluster.
-
 `--votes` `<integer> (1 - N)` ::
 
 Number of votes for this node.
@@ -156,6 +149,26 @@ Run a command with a tcp socket as standard input. The IP address and port are p
 
 Displays the local view of the cluster nodes.
 
+*pvecm qdevice remove*
+
+Remove a configured QDevice
+
+*pvecm qdevice setup* `<address>` `[OPTIONS]`
+
+Setup the use of a QDevice
+
+`<address>`: `<string>` ::
+
+Specifies the network address of an external corosync QDevice
+
+`--force` `<boolean>` ::
+
+Do not throw error on possible dangerous operations.
+
+`--network` `<string>` ::
+
+The network which should be used to connect to the external qdevice
+
 *pvecm status*
 
 Displays the local view of the cluster status.
@@ -166,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>` ::