1 *pvecm* `<COMMAND> [ARGS] [OPTIONS]`
3 *pvecm add* `<hostname>` `[OPTIONS]`
5 Adds the current node to an existing cluster.
7 `<hostname>`: `<string>` ::
9 Hostname (or IP) of an existing cluster member.
11 `--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` ::
13 Certificate SHA 256 fingerprint.
15 `--force` `<boolean>` ::
17 Do not throw error if node already exists.
19 `--link[n]` `[address=]<IP> [,priority=<integer>]` ::
21 Address and priority information of a single corosync link. (up to 8 links supported; link0..link7)
23 `--nodeid` `<integer> (1 - N)` ::
25 Node id for this node.
27 `--use_ssh` `<boolean>` ::
29 Always use SSH to join, even if peer may do it over API.
31 `--votes` `<integer> (0 - N)` ::
33 Number of votes for this node
35 *pvecm addnode* `<node>` `[OPTIONS]`
37 Adds a node to the cluster configuration. This call is for internal use.
39 `<node>`: `<string>` ::
41 The cluster node name.
43 `--apiversion` `<integer>` ::
45 The JOIN_API_VERSION of the new node.
47 `--force` `<boolean>` ::
49 Do not throw error if node already exists.
51 `--link[n]` `[address=]<IP> [,priority=<integer>]` ::
53 Address and priority information of a single corosync link. (up to 8 links supported; link0..link7)
55 `--new_node_ip` `<string>` ::
57 IP Address of node to add. Used as fallback if no links are given.
59 `--nodeid` `<integer> (1 - N)` ::
61 Node id for this node.
63 `--votes` `<integer> (0 - N)` ::
65 Number of votes for this node
69 Return the version of the cluster join API available on this node.
71 *pvecm create* `<clustername>` `[OPTIONS]`
73 Generate new cluster configuration. If no links given, default to local IP
76 `<clustername>`: `<string>` ::
78 The name of the cluster.
80 `--link[n]` `[address=]<IP> [,priority=<integer>]` ::
82 Address and priority information of a single corosync link. (up to 8 links supported; link0..link7)
84 `--nodeid` `<integer> (1 - N)` ::
86 Node id for this node.
88 `--votes` `<integer> (1 - N)` ::
90 Number of votes for this node.
92 *pvecm delnode* `<node>`
94 Removes a node from the cluster configuration.
96 `<node>`: `<string>` ::
98 The cluster node name.
100 *pvecm expected* `<expected>`
102 Tells corosync a new value of expected votes.
104 `<expected>`: `<integer> (1 - N)` ::
108 *pvecm help* `[OPTIONS]`
110 Get help about specified command.
112 `--extra-args` `<array>` ::
114 Shows help for a specific command
116 `--verbose` `<boolean>` ::
118 Verbose output format.
120 *pvecm keygen* `<filename>`
122 Generate new cryptographic key for corosync.
124 `<filename>`: `<string>` ::
128 *pvecm mtunnel* `[<extra-args>]` `[OPTIONS]`
130 Used by VM/CT migration - do not use manually.
132 `<extra-args>`: `<array>` ::
134 Extra arguments as array
136 `--get_migration_ip` `<boolean>` ('default =' `0`)::
138 return the migration IP, if configured
140 `--migration_network` `<string>` ::
142 the migration network used to detect the local migration IP
144 `--run-command` `<boolean>` ::
146 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.
150 Displays the local view of the cluster nodes.
152 *pvecm qdevice remove*
154 Remove a configured QDevice
156 *pvecm qdevice setup* `<address>` `[OPTIONS]`
158 Setup the use of a QDevice
160 `<address>`: `<string>` ::
162 Specifies the network address of an external corosync QDevice
164 `--force` `<boolean>` ::
166 Do not throw error on possible dangerous operations.
168 `--network` `<string>` ::
170 The network which should be used to connect to the external qdevice
174 Displays the local view of the cluster status.
176 *pvecm updatecerts* `[OPTIONS]`
178 Update node certificates (and generate all needed files/directories).
180 `--force` `<boolean>` ::
182 Force generation of new SSL certificate.
184 `--silent` `<boolean>` ::
186 Ignore errors (i.e. when cluster has no quorum).