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
+`--link[n]` `[address=]<IP> [,priority=<integer>]` ::
- Hostname (or IP) of the corosync ring0 address of this node.
- Defaults to nodes hostname.
+Address and priority information of a single corosync link. (up to 8 links supported; link0..link7)
- -ring1_addr string
+`--nodeid` `<integer> (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` `<boolean>` ::
- Number of votes for this node
+Always use SSH to join, even if peer may do it over API.
+`--votes` `<integer> (0 - N)` ::
+Number of votes for this node
*pvecm addnode* `<node>` `[OPTIONS]`
-Adds a node to the cluster configuration.
+Adds a node to the cluster configuration. This call is for internal use.
- <node> string
+`<node>`: `<string>` ::
- The cluster node name.
+The cluster node name.
- -force boolean
+`--apiversion` `<integer>` ::
- Do not throw error if node already exists.
+The JOIN_API_VERSION of the new node.
- -nodeid integer (1 - N)
+`--force` `<boolean>` ::
- Node id for this node.
+Do not throw error if node already exists.
- -ring0_addr string
+`--link[n]` `[address=]<IP> [,priority=<integer>]` ::
- Hostname (or IP) of the corosync ring0 address of this node.
- Defaults to nodes hostname.
+Address and priority information of a single corosync link. (up to 8 links supported; link0..link7)
- -ring1_addr string
+`--new_node_ip` `<string>` ::
- Hostname (or IP) of the corosync ring1 address, this needs an
- valid bindnet1_addr.
+IP Address of node to add. Used as fallback if no links are given.
- -votes integer (0 - N)
+`--nodeid` `<integer> (1 - N)` ::
- Number of votes for this node
+Node id for this node.
+`--votes` `<integer> (0 - N)` ::
+Number of votes for this node
-*pvecm create* `<clustername>` `[OPTIONS]`
+*pvecm apiver*
-Generate new cluster configuration.
+Return the version of the cluster join API available on this node.
- <clustername> string
+*pvecm create* `<clustername>` `[OPTIONS]`
- The name of the cluster.
+Generate new cluster configuration. If no links given, default to local IP
+address as link0.
- -bindnet0_addr string
+`<clustername>`: `<string>` ::
- This specifies the network address the corosync ring 0
- executive should bind to and defaults to the local IP address
- of the node.
+The name of the cluster.
- -bindnet1_addr string
+`--link[n]` `[address=]<IP> [,priority=<integer>]` ::
- This specifies the network address the corosync ring 1
- executive should bind to and is optional.
+Address and priority information of a single corosync link. (up to 8 links supported; link0..link7)
- -nodeid integer (1 - N)
+`--nodeid` `<integer> (1 - N)` ::
- Node id for this node.
+Node id for this node.
- -ring0_addr string
+`--votes` `<integer> (1 - N)` ::
- Hostname (or IP) of the corosync ring0 address of this node.
- Defaults to the hostname of the node.
+Number of votes for this node.
- -ring1_addr string
+*pvecm delnode* `<node>`
- 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)
+`<node>`: `<string>` ::
- 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* `<expected>`
- Number of votes for this node.
+Tells corosync a new value of expected votes.
+`<expected>`: `<integer> (1 - N)` ::
+Expected votes
-*pvecm delnode* `<node>`
+*pvecm help* `[OPTIONS]`
-Removes a node to the cluster configuration.
+Get help about specified command.
- <node> string
+`--extra-args` `<array>` ::
- The cluster node name.
+Shows help for a specific command
+`--verbose` `<boolean>` ::
+Verbose output format.
-*pvecm expected* `<expected>`
+*pvecm keygen* `<filename>`
-Tells corosync a new value of expected votes.
+Generate new cryptographic key for corosync.
- <expected> integer (1 - N)
+`<filename>`: `<string>` ::
- Expected votes
+Output file name
+*pvecm mtunnel* `[<extra-args>]` `[OPTIONS]`
+Used by VM/CT migration - do not use manually.
+`<extra-args>`: `<array>` ::
-*pvecm help* `[<cmd>]` `[OPTIONS]`
+Extra arguments as array
-Get help about specified command.
+`--get_migration_ip` `<boolean>` ('default =' `0`)::
- <cmd> string
+return the migration IP, if configured
- Command name
+`--migration_network` `<string>` ::
- -verbose boolean
+the migration network used to detect the local migration IP
- Verbose output format.
+`--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 keygen* `<filename>`
+*pvecm qdevice remove*
-Generate new cryptographic key for corosync.
+Remove a configured QDevice
- <filename> string
+*pvecm qdevice setup* `<address>` `[OPTIONS]`
- Output file name
+Setup the use of a QDevice
+`<address>`: `<string>` ::
+Specifies the network address of an external corosync QDevice
-*pvecm nodes*
+`--force` `<boolean>` ::
-Displays the local view of the cluster nodes.
+Do not throw error on possible dangerous operations.
+`--network` `<string>` ::
+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` `<boolean>` ::
- Ignore errors (i.e. when cluster has no quorum).
+Force generation of new SSL certificate.
+`--silent` `<boolean>` ::
+Ignore errors (i.e. when cluster has no quorum).