Adds the current node to an existing cluster.
- <hostname> string
+`<hostname>`: `<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` `<boolean>` ::
- Node id for this node.
+Do not throw error if node already exists.
- -ring0_addr string
+`--nodeid` `<integer> (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` `<string>` ('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` `<string>` ::
- 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` `<boolean>` ::
+Always use SSH to join, even if peer may do it over API.
-*pvecm addnode* `<node>` `[OPTIONS]`
+`--votes` `<integer> (0 - N)` ::
-Adds a node to the cluster configuration.
+Number of votes for this node
- <node> string
+*pvecm addnode* `<node>` `[OPTIONS]`
- The cluster node name.
+Adds a node to the cluster configuration. This call is for internal use.
- -force boolean
+`<node>`: `<string>` ::
- Do not throw error if node already exists.
+The cluster node name.
- -nodeid integer (1 - N)
+`--force` `<boolean>` ::
- Node id for this node.
+Do not throw error if node already exists.
- -ring0_addr string
+`--nodeid` `<integer> (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` `<string>` ('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` `<string>` ::
- 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` `<integer> (0 - N)` ::
+Number of votes for this node
*pvecm create* `<clustername>` `[OPTIONS]`
Generate new cluster configuration.
- <clustername> string
-
- The name of the cluster.
-
- -bindnet0_addr string
-
- 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
+`<clustername>`: `<string>` ::
- This specifies the network address the corosync ring 1
- executive should bind to and is optional.
+The name of the cluster.
- -nodeid integer (1 - N)
+`--bindnet0_addr` `<string>` ::
- Node id for this node.
+This specifies the network address the corosync ring 0 executive should bind to and defaults to the local IP address of the node.
- -ring0_addr string
+`--bindnet1_addr` `<string>` ::
- Hostname (or IP) of the corosync ring0 address of this node.
- Defaults to the hostname of the node.
+This specifies the network address the corosync ring 1 executive should bind to and is optional.
- -ring1_addr string
+`--nodeid` `<integer> (1 - N)` ::
- Hostname (or IP) of the corosync ring1 address, this needs an
- valid bindnet1_addr.
+Node id for this node.
- -rrp_mode (active | none | passive) (default=none)
+`--ring0_addr` `<string>` ('default =' `Hostname of the node`)::
- This specifies the mode of redundant ring, which may be none,
- active or passive. Using multiple interfaces only allows
- 'active' or 'passive'.
+Hostname (or IP) of the corosync ring0 address of this node.
- -votes integer (1 - N)
+`--ring1_addr` `<string>` ::
- 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` `<integer> (1 - N)` ::
+Number of votes for this node.
*pvecm delnode* `<node>`
-Removes a node to the cluster configuration.
-
- <node> string
-
- The cluster node name.
+Removes a node from the cluster configuration.
+`<node>`: `<string>` ::
+The cluster node name.
*pvecm expected* `<expected>`
Tells corosync a new value of expected votes.
- <expected> integer (1 - N)
+`<expected>`: `<integer> (1 - N)` ::
- Expected votes
+Expected votes
+*pvecm help* `[OPTIONS]`
+Get help about specified command.
+`--extra-args` `<array>` ::
-*pvecm help* `[<cmd>]` `[OPTIONS]`
+Shows help for a specific command
-Get help about specified command.
+`--verbose` `<boolean>` ::
+
+Verbose output format.
- <cmd> string
+*pvecm keygen* `<filename>`
- Command name
+Generate new cryptographic key for corosync.
- -verbose boolean
+`<filename>`: `<string>` ::
- Verbose output format.
+Output file name
+*pvecm mtunnel* `[<extra-args>]` `[OPTIONS]`
+Used by VM/CT migration - do not use manually.
+`<extra-args>`: `<array>` ::
-*pvecm keygen* `<filename>`
+Extra arguments as array
-Generate new cryptographic key for corosync.
+`--get_migration_ip` `<boolean>` ('default =' `0`)::
+
+return the migration IP, if configured
- <filename> string
+`--migration_network` `<string>` ::
- Output file name
+the migration network used to detect the local migration IP
+`--run-command` `<boolean>` ::
+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 generation of new SSL certifate.
-
- -silent boolean
+`--force` `<boolean>` ::
- Ignore errors (i.e. when cluster has no quorum).
+Force generation of new SSL certifate.
+`--silent` `<boolean>` ::
+Ignore errors (i.e. when cluster has no quorum).