X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=pvecm.1-synopsis.adoc;h=3b58a9d87bfccf98a68ad20bbdd9b3fd1cc918f7;hp=91da77a7d852e86ed9a241be75354e859bb6fc03;hb=856993e4166495537f42e0b9c3a51c966227feab;hpb=d8742b0c9cbfbc0a2bac4b342657dc94db079a81 diff --git a/pvecm.1-synopsis.adoc b/pvecm.1-synopsis.adoc index 91da77a..3b58a9d 100644 --- a/pvecm.1-synopsis.adoc +++ b/pvecm.1-synopsis.adoc @@ -4,181 +4,192 @@ Adds the current node to an existing cluster. - string +``: `` :: - Hostname (or IP) of an existing cluster member. +Hostname (or IP) of an existing cluster member. - -force boolean +`--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` :: - Do not throw error if node already exists. +Certificate SHA 256 fingerprint. - -nodeid integer (1 - N) +`--force` `` :: - Node id for this node. +Do not throw error if node already exists. - -ring0_addr string +`--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 string +`--ring0_addr` `` ('default =' `Hostname of the node`):: - 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 ring0 address of this node. - -votes integer (0 - N) +`--ring1_addr` `` :: - Number of votes for this node +Hostname (or IP) of the corosync ring1 address of this node. Requires a valid configured ring 1 (bindnet1_addr) in the cluster. +`--use_ssh` `` :: +Always use SSH to join, even if peer may do it over API. -*pvecm addnode* `` `[OPTIONS]` +`--votes` ` (0 - N)` :: -Adds a node to the cluster configuration. +Number of votes for this node - string +*pvecm addnode* `` `[OPTIONS]` - The cluster node name. +Adds a node to the cluster configuration. This call is for internal use. - -force boolean +``: `` :: - Do not throw error if node already exists. +The cluster node name. - -nodeid integer (1 - N) +`--force` `` :: - Node id for this node. +Do not throw error if node already exists. - -ring0_addr string +`--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 string +`--ring0_addr` `` ('default =' `Hostname of the node`):: - Hostname (or IP) of the corosync ring1 address, this needs an - valid bindnet1_addr. +Hostname (or IP) of the corosync ring0 address of this node. - -votes integer (0 - N) +`--ring1_addr` `` :: - Number of votes for this node +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)` :: +Number of votes for this node *pvecm create* `` `[OPTIONS]` Generate new cluster configuration. - string +``: `` :: - The name of the cluster. +The name of the cluster. - -bindnet0_addr string +`--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. +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 +`--bindnet1_addr` `` :: - This specifies the network address the corosync ring 1 - executive should bind to and is optional. +This specifies the network address the corosync ring 1 executive should bind to and is optional. - -nodeid integer (1 - N) +`--nodeid` ` (1 - N)` :: - Node id for this node. +Node id for this node. - -ring0_addr string +`--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 string +`--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. - -rrp_mode (active | none | passive) (default=none) +`--votes` ` (1 - N)` :: - This specifies the mode of redundant ring, which may be none, - active or passive. Using multiple interfaces only allows - 'active' or 'passive'. +Number of votes for this node. - -votes integer (1 - N) +*pvecm delnode* `` - Number of votes for this node. +Removes a node from the cluster configuration. +``: `` :: +The cluster node name. -*pvecm delnode* `` +*pvecm expected* `` -Removes a node to the cluster configuration. +Tells corosync a new value of expected votes. - string +``: ` (1 - N)` :: - The cluster node name. +Expected votes +*pvecm help* `[OPTIONS]` +Get help about specified command. -*pvecm expected* `` +`--extra-args` `` :: -Tells corosync a new value of expected votes. +Shows help for a specific command - integer (1 - N) +`--verbose` `` :: - Expected votes +Verbose output format. +*pvecm keygen* `` +Generate new cryptographic key for corosync. +``: `` :: -*pvecm help* `[]` `[OPTIONS]` +Output file name -Get help about specified command. +*pvecm mtunnel* `[]` `[OPTIONS]` - string +Used by VM/CT migration - do not use manually. - Command name +``: `` :: - -verbose boolean +Extra arguments as array - Verbose output format. +`--get_migration_ip` `` ('default =' `0`):: +return the migration IP, if configured +`--migration_network` `` :: +the migration network used to detect the local migration IP -*pvecm keygen* `` +`--run-command` `` :: -Generate new cryptographic key for corosync. +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. - string +*pvecm nodes* - Output file name +Displays the local view of the cluster nodes. +*pvecm qdevice remove* +Remove a configured QDevice -*pvecm nodes* +*pvecm qdevice setup* `
` `[OPTIONS]` -Displays the local view of the cluster nodes. +Setup the use of a QDevice +`
`: `` :: +Specifies the network address of an external corosync QDevice -*pvecm status* +`--force` `` :: -Displays the local view of the cluster status. +Do not throw error on possible dangerous operations. +`--network` `` :: +The network which should be used to connect to the external qdevice -*pvecm updatecerts* `[OPTIONS]` +*pvecm status* -Update node certificates (and generate all needed files/directories). +Displays the local view of the cluster status. - -force boolean +*pvecm updatecerts* `[OPTIONS]` - Force generation of new SSL certifate. +Update node certificates (and generate all needed files/directories). - -silent boolean +`--force` `` :: - Ignore errors (i.e. when cluster has no quorum). +Force generation of new SSL certifate. +`--silent` `` :: +Ignore errors (i.e. when cluster has no quorum).