X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=pvecm.1-synopsis.adoc;h=e0bdec2a3abc882ddf9f3c477bd5650d09a8da62;hp=49d3cdf3d1bedaaab6d9b778bce887cd449ebb6e;hb=6bc5d54db736ab9362e92b234fc5c9129e4b77e7;hpb=2489d6df4ac5e916ae18401310bfd1e69c993e55 diff --git a/pvecm.1-synopsis.adoc b/pvecm.1-synopsis.adoc index 49d3cdf..e0bdec2 100644 --- a/pvecm.1-synopsis.adoc +++ b/pvecm.1-synopsis.adoc @@ -8,101 +8,94 @@ 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` `` :: Do not throw error if node already exists. -`--nodeid` ` (1 - N)` :: +`--link[n]` `[address=] [,priority=]` :: -Node id for this node. +Address and priority information of a single corosync link. (up to 8 links supported; link0..link7) -`--ring0_addr` `` :: +`--nodeid` ` (1 - N)` :: -Hostname (or IP) of the corosync ring0 address of this node. Defaults to nodes hostname. +Node id for this node. -`--ring1_addr` `` :: +`--use_ssh` `` :: -Hostname (or IP) of the corosync ring1 address, this needs an valid configured ring 1 interface in the cluster. +Always use SSH to join, even if peer may do it over API. `--votes` ` (0 - N)` :: Number of votes for this node - - *pvecm addnode* `` `[OPTIONS]` -Adds a node to the cluster configuration. +Adds a node to the cluster configuration. This call is for internal use. ``: `` :: The cluster node name. +`--apiversion` `` :: + +The JOIN_API_VERSION of the new node. + `--force` `` :: Do not throw error if node already exists. -`--nodeid` ` (1 - N)` :: +`--link[n]` `[address=] [,priority=]` :: -Node id for this node. +Address and priority information of a single corosync link. (up to 8 links supported; link0..link7) -`--ring0_addr` `` :: +`--new_node_ip` `` :: -Hostname (or IP) of the corosync ring0 address of this node. Defaults to nodes hostname. +IP Address of node to add. Used as fallback if no links are given. -`--ring1_addr` `` :: +`--nodeid` ` (1 - N)` :: -Hostname (or IP) of the corosync ring1 address, this needs an valid bindnet1_addr. +Node id for this node. `--votes` ` (0 - N)` :: Number of votes for this node +*pvecm apiver* +Return the version of the cluster join API available on this node. *pvecm create* `` `[OPTIONS]` -Generate new cluster configuration. +Generate new cluster configuration. If no links given, default to local IP +address as link0. ``: `` :: The name of the cluster. -`--bindnet0_addr` `` :: - -This specifies the network address the corosync ring 0 executive should bind to and defaults to the local IP address of the node. +`--link[n]` `[address=] [,priority=]` :: -`--bindnet1_addr` `` :: - -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` ` (1 - N)` :: Node id for this node. -`--ring0_addr` `` :: - -Hostname (or IP) of the corosync ring0 address of this node. Defaults to the hostname of the node. - -`--ring1_addr` `` :: - -Hostname (or IP) of the corosync ring1 address, this needs an valid bindnet1_addr. - `--votes` ` (1 - N)` :: Number of votes for this node. - - *pvecm delnode* `` -Removes a node to the cluster configuration. +Removes a node from the cluster configuration. ``: `` :: -Hostname or IP of the corosync ring0 address of this node. - - +The cluster node name. *pvecm expected* `` @@ -112,24 +105,18 @@ Tells corosync a new value of expected votes. Expected votes - - - -*pvecm help* `[]` `[OPTIONS]` +*pvecm help* `[OPTIONS]` Get help about specified command. -``: `` :: +`--extra-args` `` :: -Command name +Shows help for a specific command `--verbose` `` :: Verbose output format. - - - *pvecm keygen* `` Generate new cryptographic key for corosync. @@ -138,8 +125,6 @@ Generate new cryptographic key for corosync. Output file name - - *pvecm mtunnel* `[]` `[OPTIONS]` Used by VM/CT migration - do not use manually. @@ -160,19 +145,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* `
` `[OPTIONS]` -Displays the local view of the cluster status. +Setup the use of a QDevice + +`
`: `` :: + +Specifies the network address of an external corosync QDevice + +`--force` `` :: + +Do not throw error on possible dangerous operations. +`--network` `` :: +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]` @@ -180,12 +179,10 @@ Update node certificates (and generate all needed files/directories). `--force` `` :: -Force generation of new SSL certifate. +Force generation of new SSL certificate. `--silent` `` :: Ignore errors (i.e. when cluster has no quorum). - -