fix typo in api viewer

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