d/souce/format: mark package as native

[pmg-docs.git] / pmgcm.1-synopsis.adoc

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

*pmgcm create*

Create initial cluster config with current node as master.

*pmgcm delete* `<cid>`

Remove a node from the cluster.

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

Cluster Node ID.

*pmgcm help* `[OPTIONS]`

Get help about specified command.

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

Shows help for a specific command

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

Verbose output format.

*pmgcm join* `<master_ip>` `[OPTIONS]`

Join a new node to an existing cluster.

`<master_ip>`: `<string>` ::

IP address.

`--fingerprint` `^(:?[A-Z0-9][A-Z0-9]:){31}[A-Z0-9][A-Z0-9]$` ::

SSL certificate fingerprint.

*pmgcm join-cmd*

Prints the command for joining an new node to the cluster. You need to
execute the command on the new node.

*pmgcm join_cmd*

An alias for 'pmgcm join-cmd'.

*pmgcm promote*

Promote current node to become the new master.

*pmgcm status* `[OPTIONS]`

Cluster node status.

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

List local node if there is no cluster defined. Please note that RSA keys and fingerprint are not valid in that case.

*pmgcm sync* `[OPTIONS]`

Synchronize cluster configuration.

`--master_ip` `<string>` ::

Optional IP address for master node.

*pmgcm update-fingerprints*

Notify master to refresh all certificate fingerprints