[pve-docs.git] / pvecm.1-synopsis.adoc

*pvecm* `<COMMAND> [ARGS] [OPTIONS]`

*pvecm add* `<hostname>` `[OPTIONS]`

Adds the current node to an existing cluster.

`<hostname>`: `<string>` ::

Hostname (or IP) of an existing cluster member.

`--force` `<boolean>` ::

Do not throw error if node already exists.

`--nodeid` `<integer> (1 - N)` ::

Node id for this node.

`--ring0_addr` `<string>` ::

Hostname (or IP) of the corosync ring0 address of this node. Defaults to nodes hostname.

`--ring1_addr` `<string>` ::

Hostname (or IP) of the corosync ring1 address, this needs an valid configured ring 1 interface in the cluster.

`--votes` `<integer> (0 - N)` ::

Number of votes for this node


*pvecm addnode* `<node>` `[OPTIONS]`

Adds a node to the cluster configuration.

`<node>`: `<string>` ::

The cluster node name.

`--force` `<boolean>` ::

Do not throw error if node already exists.

`--nodeid` `<integer> (1 - N)` ::

Node id for this node.

`--ring0_addr` `<string>` ::

Hostname (or IP) of the corosync ring0 address of this node. Defaults to nodes hostname.

`--ring1_addr` `<string>` ::

Hostname (or IP) of the corosync ring1 address, this needs an valid bindnet1_addr.

`--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>` ::

This specifies the network address the corosync ring 1 executive should bind to and is optional.

`--nodeid` `<integer> (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.

`--ring1_addr` `<string>` ::

Hostname (or IP) of the corosync ring1 address, this needs an valid bindnet1_addr.

`--votes` `<integer> (1 - N)` ::

Number of votes for this node.


*pvecm delnode* `<node>`

Removes a node to the cluster configuration.

`<node>`: `<string>` ::

Hostname or IP of the corosync ring0 address of this node.


*pvecm expected* `<expected>`

Tells corosync a new value of expected votes.

`<expected>`: `<integer> (1 - N)` ::

Expected votes


*pvecm help* `[<cmd>]` `[OPTIONS]`

Get help about specified command.

`<cmd>`: `<string>` ::

Command name

`--verbose` `<boolean>` ::

Verbose output format.


*pvecm keygen* `<filename>`

Generate new cryptographic key for corosync.

`<filename>`: `<string>` ::

Output file name


*pvecm mtunnel* `[<extra-args>]` `[OPTIONS]`

Used by VM/CT migration - do not use manually.

`<extra-args>`: `<array>` ::

Extra arguments as array

`--get_migration_ip` `<boolean>` ('default =' `0`)::

return the migration IP, if configured

`--migration_network` `<string>` ::

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>` ::

Ignore errors (i.e. when cluster has no quorum).
Commit	Line	Data
	1	pvecm `<COMMAND> [ARGS] [OPTIONS]`
	2
	3	pvecm add `<hostname>` `[OPTIONS]`
	4
	5	Adds the current node to an existing cluster.
	6
	7	`<hostname>`: `<string>` ::
	8
	9	Hostname (or IP) of an existing cluster member.
	10
	11	`--force` `<boolean>` ::
	12
	13	Do not throw error if node already exists.
	14
	15	`--nodeid` `<integer> (1 - N)` ::
	16
	17	Node id for this node.
	18
	19	`--ring0_addr` `<string>` ::
	20
	21	Hostname (or IP) of the corosync ring0 address of this node. Defaults to nodes hostname.
	22
	23	`--ring1_addr` `<string>` ::
	24
	25	Hostname (or IP) of the corosync ring1 address, this needs an valid configured ring 1 interface in the cluster.
	26
	27	`--votes` `<integer> (0 - N)` ::
	28
	29	Number of votes for this node
	30
	31
	32
	33	pvecm addnode `<node>` `[OPTIONS]`
	34
	35	Adds a node to the cluster configuration.
	36
	37	`<node>`: `<string>` ::
	38
	39	The cluster node name.
	40
	41	`--force` `<boolean>` ::
	42
	43	Do not throw error if node already exists.
	44
	45	`--nodeid` `<integer> (1 - N)` ::
	46
	47	Node id for this node.
	48
	49	`--ring0_addr` `<string>` ::
	50
	51	Hostname (or IP) of the corosync ring0 address of this node. Defaults to nodes hostname.
	52
	53	`--ring1_addr` `<string>` ::
	54
	55	Hostname (or IP) of the corosync ring1 address, this needs an valid bindnet1_addr.
	56
	57	`--votes` `<integer> (0 - N)` ::
	58
	59	Number of votes for this node
	60
	61
	62
	63	pvecm create `<clustername>` `[OPTIONS]`
	64
	65	Generate new cluster configuration.
	66
	67	`<clustername>`: `<string>` ::
	68
	69	The name of the cluster.
	70
	71	`--bindnet0_addr` `<string>` ::
	72
	73	This specifies the network address the corosync ring 0 executive should bind to and defaults to the local IP address of the node.
	74
	75	`--bindnet1_addr` `<string>` ::
	76
	77	This specifies the network address the corosync ring 1 executive should bind to and is optional.
	78
	79	`--nodeid` `<integer> (1 - N)` ::
	80
	81	Node id for this node.
	82
	83	`--ring0_addr` `<string>` ::
	84
	85	Hostname (or IP) of the corosync ring0 address of this node. Defaults to the hostname of the node.
	86
	87	`--ring1_addr` `<string>` ::
	88
	89	Hostname (or IP) of the corosync ring1 address, this needs an valid bindnet1_addr.
	90
	91	`--votes` `<integer> (1 - N)` ::
	92
	93	Number of votes for this node.
	94
	95
	96
	97	pvecm delnode `<node>`
	98
	99	Removes a node to the cluster configuration.
	100
	101	`<node>`: `<string>` ::
	102
	103	Hostname or IP of the corosync ring0 address of this node.
	104
	105
	106
	107	pvecm expected `<expected>`
	108
	109	Tells corosync a new value of expected votes.
	110
	111	`<expected>`: `<integer> (1 - N)` ::
	112
	113	Expected votes
	114
	115
	116
	117
	118	pvecm help `[<cmd>]` `[OPTIONS]`
	119
	120	Get help about specified command.
	121
	122	`<cmd>`: `<string>` ::
	123
	124	Command name
	125
	126	`--verbose` `<boolean>` ::
	127
	128	Verbose output format.
	129
	130
	131
	132
	133	pvecm keygen `<filename>`
	134
	135	Generate new cryptographic key for corosync.
	136
	137	`<filename>`: `<string>` ::
	138
	139	Output file name
	140
	141
	142
	143	pvecm mtunnel `[<extra-args>]` `[OPTIONS]`
	144
	145	Used by VM/CT migration - do not use manually.
	146
	147	`<extra-args>`: `<array>` ::
	148
	149	Extra arguments as array
	150
	151	`--get_migration_ip` `<boolean>` ('default =' `0`)::
	152
	153	return the migration IP, if configured
	154
	155	`--migration_network` `<string>` ::
	156
	157	the migration network used to detect the local migration IP
	158
	159	`--run-command` `<boolean>` ::
	160
	161	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.
	162
	163
	164
	165	pvecm nodes
	166
	167	Displays the local view of the cluster nodes.
	168
	169
	170
	171	pvecm status
	172
	173	Displays the local view of the cluster status.
	174
	175
	176
	177	pvecm updatecerts `[OPTIONS]`
	178
	179	Update node certificates (and generate all needed files/directories).
	180
	181	`--force` `<boolean>` ::
	182
	183	Force generation of new SSL certifate.
	184
	185	`--silent` `<boolean>` ::
	186
	187	Ignore errors (i.e. when cluster has no quorum).
	188
	189
	190
	191