X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=pvecm.1-synopsis.adoc;h=3b58a9d87bfccf98a68ad20bbdd9b3fd1cc918f7;hp=9ff6232a1f9ffcd2e93aa15ac2352cd2c5bfcb90;hb=856993e4166495537f42e0b9c3a51c966227feab;hpb=5d9c884c7b3f4980abbd4cbe91ea588a03266485 diff --git a/pvecm.1-synopsis.adoc b/pvecm.1-synopsis.adoc index 9ff6232..3b58a9d 100644 --- a/pvecm.1-synopsis.adoc +++ b/pvecm.1-synopsis.adoc @@ -8,58 +8,62 @@ Adds the current node to an existing cluster. Hostname (or IP) of an existing cluster member. -`-force` `` :: +`--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)` :: +`--nodeid` ` (1 - N)` :: Node id for this node. -`-ring0_addr` `` :: +`--ring0_addr` `` ('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` `` :: +`--ring1_addr` `` :: -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` ` (0 - N)` :: +`--use_ssh` `` :: -Number of votes for this node +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. -`-force` `` :: +`--force` `` :: Do not throw error if node already exists. -`-nodeid` ` (1 - N)` :: +`--nodeid` ` (1 - N)` :: Node id for this node. -`-ring0_addr` `` :: +`--ring0_addr` `` ('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` `` :: +`--ring1_addr` `` :: -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` ` (0 - N)` :: +`--votes` ` (0 - N)` :: Number of votes for this node - - *pvecm create* `` `[OPTIONS]` Generate new cluster configuration. @@ -68,41 +72,37 @@ Generate new cluster configuration. The name of the cluster. -`-bindnet0_addr` `` :: +`--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. -`-bindnet1_addr` `` :: +`--bindnet1_addr` `` :: This specifies the network address the corosync ring 1 executive should bind to and is optional. -`-nodeid` ` (1 - N)` :: +`--nodeid` ` (1 - N)` :: Node id for this node. -`-ring0_addr` `` :: +`--ring0_addr` `` ('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` `` :: +`--ring1_addr` `` :: -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` ` (1 - N)` :: +`--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 +112,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` `` :: Verbose output format. - - - *pvecm keygen* `` Generate new cryptographic key for corosync. @@ -138,8 +132,6 @@ Generate new cryptographic key for corosync. Output file name - - *pvecm mtunnel* `[]` `[OPTIONS]` Used by VM/CT migration - do not use manually. @@ -148,44 +140,56 @@ Used by VM/CT migration - do not use manually. Extra arguments as array -`-get_migration_ip` `` ('default =' `0`):: +`--get_migration_ip` `` ('default =' `0`):: return the migration IP, if configured -`-migration_network` `` :: +`--migration_network` `` :: the migration network used to detect the local migration IP -`-run-command` `` :: +`--run-command` `` :: 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]` Update node certificates (and generate all needed files/directories). -`-force` `` :: +`--force` `` :: Force generation of new SSL certifate. -`-silent` `` :: +`--silent` `` :: Ignore errors (i.e. when cluster has no quorum). - -