add pvecm man page

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

diff --git a/pvecm.1-synopsis.adoc b/pvecm.1-synopsis.adoc
new file mode 100644 (file)
index 0000000..91da77a
--- /dev/null
+++ b/pvecm.1-synopsis.adoc
@@ -0,0 +1,184 @@
+*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.
+
+  -rrp_mode  (active | none | passive)  (default=none)
+
+            This specifies the mode of redundant ring, which may be none,
+            active or passive. Using multiple interfaces only allows
+            'active' or 'passive'.
+
+  -votes     integer (1 - N)
+
+            Number of votes for this node.
+
+
+
+*pvecm delnode* `<node>`
+
+Removes a node to 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* `[<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 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).
+
+
+
+