X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=pvecm.1-synopsis.adoc;h=daa616367b8b23253aebc29d59eb2d5629ec0b48;hp=91da77a7d852e86ed9a241be75354e859bb6fc03;hb=5dfeeece548c9304fc6cbd51b17679bafeff2bee;hpb=d8742b0c9cbfbc0a2bac4b342657dc94db079a81 diff --git a/pvecm.1-synopsis.adoc b/pvecm.1-synopsis.adoc index 91da77a..daa6163 100644 --- a/pvecm.1-synopsis.adoc +++ b/pvecm.1-synopsis.adoc @@ -4,181 +4,172 @@ 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 +`--link[n]` `[address=] [,priority=]` :: - Hostname (or IP) of the corosync ring0 address of this node. - Defaults to nodes hostname. +Address and priority information of a single corosync link. - -ring1_addr string +`--nodeid` ` (1 - N)` :: - Hostname (or IP) of the corosync ring1 address, this needs an - valid configured ring 1 interface in the cluster. +Node id for this node. - -votes integer (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. - string +``: `` :: - The cluster node name. +The cluster node name. - -force boolean +`--force` `` :: - Do not throw error if node already exists. +Do not throw error if node already exists. - -nodeid integer (1 - N) +`--link[n]` `[address=] [,priority=]` :: - Node id for this node. +Address and priority information of a single corosync link. - -ring0_addr string +`--nodeid` ` (1 - N)` :: - Hostname (or IP) of the corosync ring0 address of this node. - Defaults to nodes hostname. - - -ring1_addr string - - Hostname (or IP) of the corosync ring1 address, this needs an - valid bindnet1_addr. - - -votes integer (0 - N) - - Number of votes for this node +Node id for this node. +`--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 +`--link[n]` `[address=] [,priority=]` :: - This specifies the network address the corosync ring 0 - executive should bind to and defaults to the local IP address - of the node. +Address and priority information of a single corosync link. - -bindnet1_addr string +`--nodeid` ` (1 - N)` :: - This specifies the network address the corosync ring 1 - executive should bind to and is optional. +Node id for this node. - -nodeid integer (1 - N) +`--votes` ` (1 - N)` :: - Node id for this node. +Number of votes for this node. - -ring0_addr string - - Hostname (or IP) of the corosync ring0 address of this node. - Defaults to the hostname of the node. - - -ring1_addr string +*pvecm delnode* `` - Hostname (or IP) of the corosync ring1 address, this needs an - valid bindnet1_addr. +Removes a node from the cluster configuration. - -rrp_mode (active | none | passive) (default=none) +``: `` :: - This specifies the mode of redundant ring, which may be none, - active or passive. Using multiple interfaces only allows - 'active' or 'passive'. +The cluster node name. - -votes integer (1 - N) +*pvecm expected* `` - Number of votes for this node. +Tells corosync a new value of expected votes. +``: ` (1 - N)` :: +Expected votes -*pvecm delnode* `` +*pvecm help* `[OPTIONS]` -Removes a node to the cluster configuration. +Get help about specified command. - string +`--extra-args` `` :: - The cluster node name. +Shows help for a specific command +`--verbose` `` :: +Verbose output format. -*pvecm expected* `` +*pvecm keygen* `` -Tells corosync a new value of expected votes. +Generate new cryptographic key for corosync. - integer (1 - N) +``: `` :: - Expected votes +Output file name +*pvecm mtunnel* `[]` `[OPTIONS]` +Used by VM/CT migration - do not use manually. +``: `` :: -*pvecm help* `[]` `[OPTIONS]` +Extra arguments as array -Get help about specified command. +`--get_migration_ip` `` ('default =' `0`):: - string +return the migration IP, if configured - Command name +`--migration_network` `` :: - -verbose boolean +the migration network used to detect the local migration IP - Verbose output format. +`--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 keygen* `` +*pvecm qdevice remove* -Generate new cryptographic key for corosync. +Remove a configured QDevice - string +*pvecm qdevice setup* `
` `[OPTIONS]` - Output file name +Setup the use of a QDevice +`
`: `` :: +Specifies the network address of an external corosync QDevice -*pvecm nodes* +`--force` `` :: -Displays the local view of the cluster nodes. +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 boolean - - Force generation of new SSL certifate. - - -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).