cert management: move some headings a level up for better visibility

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