buildsys: switch upload dist over to buster

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

diff --git a/pvecm.1-synopsis.adoc b/pvecm.1-synopsis.adoc
index 49d3cdf3d1bedaaab6d9b778bce887cd449ebb6e..3b58a9d87bfccf98a68ad20bbdd9b3fd1cc918f7 100644 (file)
--- a/pvecm.1-synopsis.adoc
+++ b/pvecm.1-synopsis.adoc
@@ -8,6 +8,10 @@ Adds the current node to an existing cluster.
 
 Hostname (or IP) of an existing cluster member.
 
+`--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` ::
+
+Certificate SHA 256 fingerprint.
+
 `--force` `<boolean>` ::
 
 Do not throw error if node already exists.
@@ -16,23 +20,25 @@ Do not throw error if node already exists.
 
 Node id for this node.
 
-`--ring0_addr` `<string>` ::
+`--ring0_addr` `<string>` ('default =' `Hostname of the node`)::
 
-Hostname (or IP) of the corosync ring0 address of this node. Defaults to nodes hostname.
+Hostname (or IP) of the corosync ring0 address of this node.
 
 `--ring1_addr` `<string>` ::
 
-Hostname (or IP) of the corosync ring1 address, this needs an valid configured ring 1 interface in the cluster.
+Hostname (or IP) of the corosync ring1 address of this node. Requires a valid configured ring 1 (bindnet1_addr) in the cluster.
 
-`--votes` `<integer> (0 - N)` ::
+`--use_ssh` `<boolean>` ::
 
-Number of votes for this node
+Always use SSH to join, even if peer may do it over API.
 
+`--votes` `<integer> (0 - N)` ::
 
+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>` ::
 
@@ -46,20 +52,18 @@ Do not throw error if node already exists.
 
 Node id for this node.
 
-`--ring0_addr` `<string>` ::
+`--ring0_addr` `<string>` ('default =' `Hostname of the node`)::
 
-Hostname (or IP) of the corosync ring0 address of this node. Defaults to nodes hostname.
+Hostname (or IP) of the corosync ring0 address of this node.
 
 `--ring1_addr` `<string>` ::
 
-Hostname (or IP) of the corosync ring1 address, this needs an valid bindnet1_addr.
+Hostname (or IP) of the corosync ring1 address of this node. Requires a valid configured ring 1 (bindnet1_addr) in the cluster.
 
 `--votes` `<integer> (0 - N)` ::
 
 Number of votes for this node
 
-
-
 *pvecm create* `<clustername>` `[OPTIONS]`
 
 Generate new cluster configuration.
@@ -80,29 +84,25 @@ This specifies the network address the corosync ring 1 executive should bind to
 
 Node id for this node.
 
-`--ring0_addr` `<string>` ::
+`--ring0_addr` `<string>` ('default =' `Hostname of the node`)::
 
-Hostname (or IP) of the corosync ring0 address of this node. Defaults to the 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, this needs an valid bindnet1_addr.
+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.
 
-
-
 *pvecm delnode* `<node>`
 
-Removes a node to the cluster configuration.
+Removes a node from the cluster configuration.
 
 `<node>`: `<string>` ::
 
-Hostname or IP of the corosync ring0 address of this node.
-
-
+The cluster node name.
 
 *pvecm expected* `<expected>`
 
@@ -112,24 +112,18 @@ Tells corosync a new value of expected votes.
 
 Expected votes
 
-
-
-
-*pvecm help* `[<cmd>]` `[OPTIONS]`
+*pvecm help* `[OPTIONS]`
 
 Get help about specified command.
 
-`<cmd>`: `<string>` ::
+`--extra-args` `<array>` ::
 
-Command name
+Shows help for a specific command
 
 `--verbose` `<boolean>` ::
 
 Verbose output format.
 
-
-
-
 *pvecm keygen* `<filename>`
 
 Generate new cryptographic key for corosync.
@@ -138,8 +132,6 @@ Generate new cryptographic key for corosync.
 
 Output file name
 
-
-
 *pvecm mtunnel* `[<extra-args>]` `[OPTIONS]`
 
 Used by VM/CT migration - do not use manually.
@@ -160,19 +152,33 @@ the migration network used to detect the local migration IP
 
 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.
 
+*pvecm qdevice remove*
 
+Remove a configured QDevice
 
-*pvecm status*
+*pvecm qdevice setup* `<address>` `[OPTIONS]`
 
-Displays the local view of the cluster status.
+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.
 
 *pvecm updatecerts* `[OPTIONS]`
 
@@ -187,5 +193,3 @@ Force generation of new SSL certifate.
 Ignore errors (i.e. when cluster has no quorum).
 
 
-
-