X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=pvecm.1-synopsis.adoc;h=27f561f12aa8392ead46cbb3648e40201040f4b7;hp=72243662f57835987af2198e94d3d8a16348b110;hb=d562163644b7c01e5e7ad54cbb1e99a61c53fe1e;hpb=de0983cb5feb38143ada8d2f9fa99d4f7102d497 diff --git a/pvecm.1-synopsis.adoc b/pvecm.1-synopsis.adoc index 7224366..27f561f 100644 --- a/pvecm.1-synopsis.adoc +++ b/pvecm.1-synopsis.adoc @@ -4,184 +4,172 @@ Adds the current node to an existing cluster. -`` `string` :: +``: `` :: Hostname (or IP) of an existing cluster member. -`-force` `boolean` :: +`--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` `integer (1 - N)` :: +`--nodeid` ` (1 - N)` :: 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 nodes hostname. +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 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` `` :: -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. -`-force` `boolean` :: +`--force` `` :: Do not throw error if node already exists. -`-nodeid` `integer (1 - N)` :: +`--nodeid` ` (1 - N)` :: 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 nodes hostname. +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. -`-votes` `integer (0 - N)` :: +`--votes` ` (0 - N)` :: Number of votes for this node - - *pvecm create* `` `[OPTIONS]` Generate new cluster configuration. -`` `string` :: +``: `` :: 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. -`-bindnet1_addr` `string` :: +`--bindnet1_addr` `` :: 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. -`-ring0_addr` `string` :: - -Hostname (or IP) of the corosync ring0 address of this node. Defaults to the hostname of the node. +`--ring0_addr` `` ('default =' `Hostname of the node`):: -`-ring1_addr` `string` :: +Hostname (or IP) of the corosync ring0 address of this node. -Hostname (or IP) of the corosync ring1 address, this needs an valid bindnet1_addr. +`--ring1_addr` `` :: -`-rrp_mode` `(active | none | passive)` (default=`none`):: +Hostname (or IP) of the corosync ring1 address of this node. Requires a valid configured ring 1 (bindnet1_addr) in the cluster. -This specifies the mode of redundant ring, which may be none, active or passive. Using multiple interfaces only allows 'active' or 'passive'. - -`-votes` `integer (1 - N)` :: +`--votes` ` (1 - N)` :: Number of votes for this node. - - *pvecm delnode* `` -Removes a node to the cluster configuration. - -`` `string` :: - -Hostname or IP of the corosync ring0 address of this node. +Removes a node from the cluster configuration. +``: `` :: +The cluster node name. *pvecm expected* `` Tells corosync a new value of expected votes. -`` `integer (1 - N)` :: +``: ` (1 - N)` :: Expected votes - - - -*pvecm help* `[]` `[OPTIONS]` +*pvecm help* `[OPTIONS]` Get help about specified command. -`` `string` :: +`--extra-args` `` :: -Command name +Shows help for a specific command -`-verbose` `boolean` :: +`--verbose` `` :: Verbose output format. - - - *pvecm keygen* `` Generate new cryptographic key for corosync. -`` `string` :: +``: `` :: Output file name +*pvecm mtunnel* `[]` `[OPTIONS]` +Used by VM/CT migration - do not use manually. -*pvecm mtunnel* `[OPTIONS]` +``: `` :: -Used by VM/CT migration - do not use manually. +Extra arguments as array -`-get_migration_ip` `boolean` (default=`0`):: +`--get_migration_ip` `` ('default =' `0`):: return the migration IP, if configured -`-migration_network` `string` :: +`--migration_network` `` :: the migration network used to detect the local migration IP +`--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 status* Displays the local view of the cluster status. - - *pvecm updatecerts* `[OPTIONS]` Update node certificates (and generate all needed files/directories). -`-force` `boolean` :: +`--force` `` :: Force generation of new SSL certifate. -`-silent` `boolean` :: +`--silent` `` :: Ignore errors (i.e. when cluster has no quorum). - -