[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.

`--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` ::

Certificate SHA 256 fingerprint.

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

Do not throw error if node already exists.

`--link[n]` `[address=]<IP> [,priority=<integer>]` ::

Address and priority information of a single corosync link.

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

Node id for this node.

`--use_ssh` `<boolean>` ::

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. This call is for internal use.

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

The cluster node name.

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

Do not throw error if node already exists.

`--link[n]` `[address=]<IP> [,priority=<integer>]` ::

Address and priority information of a single corosync link.

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

Node id for this node.

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

`--link[n]` `[address=]<IP> [,priority=<integer>]` ::

Address and priority information of a single corosync link.

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

Node id for this node.

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

Number of votes for this node.

*pvecm delnode* `<node>`

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 votes

*pvecm help* `[OPTIONS]`

Get help about specified command.

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

Shows help for a specific command

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

Verbose output format.

*pvecm keygen* `<filename>`

Generate new cryptographic key for corosync.

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

Output file name

*pvecm nodes*

Displays the local view of the cluster nodes.

*pvecm qdevice remove*

Remove a configured QDevice

*pvecm qdevice setup* `<address>` `[OPTIONS]`

Setup the use of a QDevice

`<address>`: `<string>` ::

Specifies the network address of an external corosync QDevice

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

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

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	`--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` ::
	12
	13	Certificate SHA 256 fingerprint.
	14
	15	`--force` `<boolean>` ::
	16
	17	Do not throw error if node already exists.
	18
	19	`--link[n]` `[address=]<IP> [,priority=<integer>]` ::
	20
	21	Address and priority information of a single corosync link.
	22
	23	`--nodeid` `<integer> (1 - N)` ::
	24
	25	Node id for this node.
	26
	27	`--use_ssh` `<boolean>` ::
	28
	29	Always use SSH to join, even if peer may do it over API.
	30
	31	`--votes` `<integer> (0 - N)` ::
	32
	33	Number of votes for this node
	34
	35	pvecm addnode `<node>` `[OPTIONS]`
	36
	37	Adds a node to the cluster configuration. This call is for internal use.
	38
	39	`<node>`: `<string>` ::
	40
	41	The cluster node name.
	42
	43	`--force` `<boolean>` ::
	44
	45	Do not throw error if node already exists.
	46
	47	`--link[n]` `[address=]<IP> [,priority=<integer>]` ::
	48
	49	Address and priority information of a single corosync link.
	50
	51	`--nodeid` `<integer> (1 - N)` ::
	52
	53	Node id for this node.
	54
	55	`--votes` `<integer> (0 - N)` ::
	56
	57	Number of votes for this node
	58
	59	pvecm create `<clustername>` `[OPTIONS]`
	60
	61	Generate new cluster configuration.
	62
	63	`<clustername>`: `<string>` ::
	64
	65	The name of the cluster.
	66
	67	`--link[n]` `[address=]<IP> [,priority=<integer>]` ::
	68
	69	Address and priority information of a single corosync link.
	70
	71	`--nodeid` `<integer> (1 - N)` ::
	72
	73	Node id for this node.
	74
	75	`--votes` `<integer> (1 - N)` ::
	76
	77	Number of votes for this node.
	78
	79	pvecm delnode `<node>`
	80
	81	Removes a node from the cluster configuration.
	82
	83	`<node>`: `<string>` ::
	84
	85	The cluster node name.
	86
	87	pvecm expected `<expected>`
	88
	89	Tells corosync a new value of expected votes.
	90
	91	`<expected>`: `<integer> (1 - N)` ::
	92
	93	Expected votes
	94
	95	pvecm help `[OPTIONS]`
	96
	97	Get help about specified command.
	98
	99	`--extra-args` `<array>` ::
	100
	101	Shows help for a specific command
	102
	103	`--verbose` `<boolean>` ::
	104
	105	Verbose output format.
	106
	107	pvecm keygen `<filename>`
	108
	109	Generate new cryptographic key for corosync.
	110
	111	`<filename>`: `<string>` ::
	112
	113	Output file name
	114
	115	pvecm nodes
	116
	117	Displays the local view of the cluster nodes.
	118
	119	pvecm qdevice remove
	120
	121	Remove a configured QDevice
	122
	123	pvecm qdevice setup `<address>` `[OPTIONS]`
	124
	125	Setup the use of a QDevice
	126
	127	`<address>`: `<string>` ::
	128
	129	Specifies the network address of an external corosync QDevice
	130
	131	`--force` `<boolean>` ::
	132
	133	Do not throw error on possible dangerous operations.
	134
	135	`--network` `<string>` ::
	136
	137	The network which should be used to connect to the external qdevice
	138
	139	pvecm status
	140
	141	Displays the local view of the cluster status.
	142
	143	pvecm updatecerts `[OPTIONS]`
	144
	145	Update node certificates (and generate all needed files/directories).
	146
	147	`--force` `<boolean>` ::
	148
	149	Force generation of new SSL certifate.
	150
	151	`--silent` `<boolean>` ::
	152
	153	Ignore errors (i.e. when cluster has no quorum).
	154
	155