2016-04-06 17:36:10 +02:00
*pvecm* `<COMMAND> [ARGS] [OPTIONS]`
*pvecm add* `<hostname>` `[OPTIONS]`
Adds the current node to an existing cluster.
2016-11-05 16:49:43 +01:00
`<hostname>`: `<string>` ::
2016-04-06 17:36:10 +02:00
2016-04-07 08:20:32 +02:00
Hostname (or IP) of an existing cluster member.
2016-04-06 17:36:10 +02:00
2018-03-22 13:17:37 +01:00
`--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` ::
Certificate SHA 256 fingerprint.
2017-10-19 09:30:23 +02:00
`--force` `<boolean>` ::
2016-04-06 17:36:10 +02:00
2016-04-07 08:20:32 +02:00
Do not throw error if node already exists.
2016-04-06 17:36:10 +02:00
2017-10-19 09:30:23 +02:00
`--nodeid` `<integer> (1 - N)` ::
2016-04-06 17:36:10 +02:00
2016-04-07 08:20:32 +02:00
Node id for this node.
2016-04-06 17:36:10 +02:00
2018-03-22 13:17:37 +01:00
`--ring0_addr` `<string>` ('default =' `Hostname of the node`)::
2016-04-06 17:36:10 +02:00
2018-03-22 13:17:37 +01:00
Hostname (or IP) of the corosync ring0 address of this node.
2016-04-06 17:36:10 +02:00
2017-10-19 09:30:23 +02:00
`--ring1_addr` `<string>` ::
2016-04-06 17:36:10 +02:00
2018-03-22 13:17:37 +01:00
Hostname (or IP) of the corosync ring1 address of this node. Requires a valid configured ring 1 (bindnet1_addr) in the cluster.
`--use_ssh` `<boolean>` ::
Always use SSH to join, even if peer may do it over API.
2016-04-06 17:36:10 +02:00
2017-10-19 09:30:23 +02:00
`--votes` `<integer> (0 - N)` ::
2016-04-06 17:36:10 +02:00
2016-04-07 08:20:32 +02:00
Number of votes for this node
2016-04-06 17:36:10 +02:00
*pvecm addnode* `<node>` `[OPTIONS]`
Adds a node to the cluster configuration.
2016-11-05 16:49:43 +01:00
`<node>`: `<string>` ::
2016-04-06 17:36:10 +02:00
2016-04-07 08:20:32 +02:00
The cluster node name.
2016-04-06 17:36:10 +02:00
2017-10-19 09:30:23 +02:00
`--force` `<boolean>` ::
2016-04-06 17:36:10 +02:00
2016-04-07 08:20:32 +02:00
Do not throw error if node already exists.
2016-04-06 17:36:10 +02:00
2017-10-19 09:30:23 +02:00
`--nodeid` `<integer> (1 - N)` ::
2016-04-06 17:36:10 +02:00
2016-04-07 08:20:32 +02:00
Node id for this node.
2016-04-06 17:36:10 +02:00
2018-03-22 13:17:37 +01:00
`--ring0_addr` `<string>` ('default =' `Hostname of the node`)::
2016-04-06 17:36:10 +02:00
2018-03-22 13:17:37 +01:00
Hostname (or IP) of the corosync ring0 address of this node.
2016-04-06 17:36:10 +02:00
2017-10-19 09:30:23 +02:00
`--ring1_addr` `<string>` ::
2016-04-06 17:36:10 +02:00
2018-03-22 13:17:37 +01:00
Hostname (or IP) of the corosync ring1 address of this node. Requires a valid configured ring 1 (bindnet1_addr) in the cluster.
2016-04-06 17:36:10 +02:00
2017-10-19 09:30:23 +02:00
`--votes` `<integer> (0 - N)` ::
2016-04-06 17:36:10 +02:00
2016-04-07 08:20:32 +02:00
Number of votes for this node
2016-04-06 17:36:10 +02:00
*pvecm create* `<clustername>` `[OPTIONS]`
Generate new cluster configuration.
2016-11-05 16:49:43 +01:00
`<clustername>`: `<string>` ::
2016-04-06 17:36:10 +02:00
2016-04-07 08:20:32 +02:00
The name of the cluster.
2016-04-06 17:36:10 +02:00
2017-10-19 09:30:23 +02:00
`--bindnet0_addr` `<string>` ::
2016-04-06 17:36:10 +02:00
2016-05-19 16:14:05 +02:00
This specifies the network address the corosync ring 0 executive should bind to and defaults to the local IP address of the node.
2016-04-06 17:36:10 +02:00
2017-10-19 09:30:23 +02:00
`--bindnet1_addr` `<string>` ::
2016-04-06 17:36:10 +02:00
2016-05-19 16:14:05 +02:00
This specifies the network address the corosync ring 1 executive should bind to and is optional.
2016-04-06 17:36:10 +02:00
2017-10-19 09:30:23 +02:00
`--nodeid` `<integer> (1 - N)` ::
2016-04-06 17:36:10 +02:00
2016-04-07 08:20:32 +02:00
Node id for this node.
2016-04-06 17:36:10 +02:00
2018-03-22 13:17:37 +01:00
`--ring0_addr` `<string>` ('default =' `Hostname of the node`)::
2016-04-06 17:36:10 +02:00
2018-03-22 13:17:37 +01:00
Hostname (or IP) of the corosync ring0 address of this node.
2016-04-06 17:36:10 +02:00
2017-10-19 09:30:23 +02:00
`--ring1_addr` `<string>` ::
2016-04-06 17:36:10 +02:00
2018-03-22 13:17:37 +01:00
Hostname (or IP) of the corosync ring1 address of this node. Requires a valid configured ring 1 (bindnet1_addr) in the cluster.
2016-04-06 17:36:10 +02:00
2017-10-19 09:30:23 +02:00
`--votes` `<integer> (1 - N)` ::
2016-04-06 17:36:10 +02:00
2016-04-07 08:20:32 +02:00
Number of votes for this node.
2016-04-06 17:36:10 +02:00
*pvecm delnode* `<node>`
2018-03-22 13:17:37 +01:00
Removes a node from the cluster configuration.
2016-04-06 17:36:10 +02:00
2016-11-05 16:49:43 +01:00
`<node>`: `<string>` ::
2016-04-06 17:36:10 +02:00
2018-03-22 13:17:37 +01:00
The cluster node name.
2016-04-06 17:36:10 +02:00
*pvecm expected* `<expected>`
Tells corosync a new value of expected votes.
2016-11-05 16:49:43 +01:00
`<expected>`: `<integer> (1 - N)` ::
2016-04-06 17:36:10 +02:00
2016-04-07 08:20:32 +02:00
Expected votes
2016-04-06 17:36:10 +02:00
2018-02-12 09:50:48 +01:00
*pvecm help* `[OPTIONS]`
2016-04-06 17:36:10 +02:00
Get help about specified command.
2018-02-12 09:50:48 +01:00
`--extra-args` `<array>` ::
2016-04-06 17:36:10 +02:00
2018-02-12 09:50:48 +01:00
Shows help for a specific command
2016-04-06 17:36:10 +02:00
2017-10-19 09:30:23 +02:00
`--verbose` `<boolean>` ::
2016-04-06 17:36:10 +02:00
2016-04-07 08:20:32 +02:00
Verbose output format.
2016-04-06 17:36:10 +02:00
*pvecm keygen* `<filename>`
Generate new cryptographic key for corosync.
2016-11-05 16:49:43 +01:00
`<filename>`: `<string>` ::
2016-04-06 17:36:10 +02:00
2016-04-07 08:20:32 +02:00
Output file name
2016-04-06 17:36:10 +02:00
2017-06-29 18:01:29 +02:00
*pvecm mtunnel* `[<extra-args>]` `[OPTIONS]`
2016-11-03 13:21:10 +01:00
Used by VM/CT migration - do not use manually.
2017-06-29 18:01:29 +02:00
`<extra-args>`: `<array>` ::
Extra arguments as array
2017-10-19 09:30:23 +02:00
`--get_migration_ip` `<boolean>` ('default =' `0`)::
2016-11-03 13:21:10 +01:00
return the migration IP, if configured
2017-10-19 09:30:23 +02:00
`--migration_network` `<string>` ::
2016-11-03 13:21:10 +01:00
the migration network used to detect the local migration IP
2017-10-19 09:30:23 +02:00
`--run-command` `<boolean>` ::
2017-06-29 18:01:29 +02:00
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.
2016-04-06 17:36:10 +02:00
*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).
2017-10-19 09:30:23 +02:00
`--force` `<boolean>` ::
2016-04-06 17:36:10 +02:00
2016-04-07 08:20:32 +02:00
Force generation of new SSL certifate.
2016-04-06 17:36:10 +02:00
2017-10-19 09:30:23 +02:00
`--silent` `<boolean>` ::
2016-04-06 17:36:10 +02:00
2016-04-07 08:20:32 +02:00
Ignore errors (i.e. when cluster has no quorum).
2016-04-06 17:36:10 +02:00