mirror of
git://git.proxmox.com/git/pve-docs.git
synced 2025-01-21 18:03:45 +03:00
add pvecm man page
This commit is contained in:
Dietmar Maurer
parent
b0f56e1123
commit
d8742b0c9c
4
Makefile
4
Makefile
@ -22,6 +22,7 @@ DEB_SOURCES= \
|
||||
pve-storage-nfs.adoc \
|
||||
pve-storage-rbd.adoc \
|
||||
pve-storage-zfspool.adoc \
|
||||
pvecm.adoc \
|
||||
pveum.adoc \
|
||||
vzdump.adoc \
|
||||
pve-firewall.adoc \
|
||||
@ -73,6 +74,7 @@ PVE_ADMIN_GUIDE_SOURCES= \
|
||||
${PVE_FIREWALL_MAN8_SOURCES} \
|
||||
${PVESM_MAN1_SOURCES} \
|
||||
${PCT_MAN1_SOURCES} \
|
||||
${PVECM_MAN1_SOURCES} \
|
||||
${QM_SOURCES} \
|
||||
${PVEAM_SOURCES} \
|
||||
${PVEUM_SOURCES} \
|
||||
@ -123,7 +125,7 @@ all: pve-admin-guide.html
|
||||
|
||||
index.html: index.adoc ${PVE_ADMIN_GUIDE_SOURCES}
|
||||
$(MAKE) NOVIEW=1 pve-admin-guide.pdf pve-admin-guide.html pve-admin-guide.epub
|
||||
$(MAKE) NOVIEW=1 qm.1.html pct.1.html pveam.1.html pvesm.1.html pveum.1.html vzdump.1.html pve-firewall.8.html ha-manager.1.html datacenter.cfg.5.html vm.conf.5.html pct.conf.5.html
|
||||
$(MAKE) NOVIEW=1 pvecm.1.html qm.1.html pct.1.html pveam.1.html pvesm.1.html pveum.1.html vzdump.1.html pve-firewall.8.html ha-manager.1.html datacenter.cfg.5.html vm.conf.5.html pct.conf.5.html
|
||||
asciidoc -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}" index.adoc
|
||||
test -n "$${NOVIEW}" || $(BROWSER) index.html &
|
||||
|
||||
|
||||
@ -24,6 +24,7 @@ include::attributes.txt[]
|
||||
| qm | link:qm.1.html[qm.1]
|
||||
| pct | link:pct.1.html[pct.1]
|
||||
| pveam | link:pveam.1.html[pveam.1]
|
||||
| pvecm | link:pvecm.1.html[pvecm.1]
|
||||
| pvesm | link:pvesm.1.html[pvesm.1]
|
||||
| pveum | link:pveum.1.html[pveum.1]
|
||||
| vzdump | link:vzdump.1.html[vzdump.1]
|
||||
|
||||
@ -73,6 +73,15 @@ include::pveam.1-synopsis.adoc[]
|
||||
|
||||
:leveloffset: 0
|
||||
|
||||
*pvecm* - {pve} Cluster Manager
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
:leveloffset: 1
|
||||
include::pvecm.1-synopsis.adoc[]
|
||||
|
||||
:leveloffset: 0
|
||||
|
||||
|
||||
*pveum* - {pve} User Manager
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
|
||||
@ -10,6 +10,11 @@ PVE_COMMON_DOC_SOURCES= \
|
||||
pve-copyright.adoc \
|
||||
docinfo.xml
|
||||
|
||||
PVECM_MAN1_SOURCES= \
|
||||
pvecm.adoc \
|
||||
pvecm.1-synopsis.adoc \
|
||||
${PVE_COMMON_DOC_SOURCES}
|
||||
|
||||
PVE_FIREWALL_MAN8_SOURCES= \
|
||||
pve-firewall.adoc \
|
||||
pve-firewall.8-synopsis.adoc \
|
||||
@ -76,6 +81,10 @@ pct.1: ${PCT_MAN1_SOURCES}
|
||||
a2x -a docinfo1 -a "manvolnum=1" -a "manversion=Release ${DOCRELEASE}" -f manpage pct.adoc
|
||||
test -n "$${NOVIEW}" || man -l $@
|
||||
|
||||
pvecm.1: ${PVECM_MAN1_SOURCES}
|
||||
a2x -a docinfo1 -a "manvolnum=1" -a "manversion=Release ${DOCRELEASE}" -f manpage pvecm.adoc
|
||||
test -n "$${NOVIEW}" || man -l $@
|
||||
|
||||
%.5: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES}
|
||||
a2x -a docinfo1 -a "manvolnum=5" -a "manversion=Release ${DOCRELEASE}" -f manpage $*.adoc
|
||||
test -n "$${NOVIEW}" || man -l $@
|
||||
|
||||
184
pvecm.1-synopsis.adoc
Normal file
184
pvecm.1-synopsis.adoc
Normal file
@ -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).
|
||||
|
||||
|
||||
|
||||
|
||||
34
pvecm.adoc
Normal file
34
pvecm.adoc
Normal file
@ -0,0 +1,34 @@
|
||||
ifdef::manvolnum[]
|
||||
PVE({manvolnum})
|
||||
================
|
||||
include::attributes.txt[]
|
||||
|
||||
NAME
|
||||
----
|
||||
|
||||
pvecm - Proxmox VE Cluster Manager
|
||||
|
||||
SYNOPSYS
|
||||
--------
|
||||
|
||||
include::pvecm.1-synopsis.adoc[]
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
endif::manvolnum[]
|
||||
|
||||
ifndef::manvolnum[]
|
||||
Cluster Manager
|
||||
===============
|
||||
include::attributes.txt[]
|
||||
endif::manvolnum[]
|
||||
|
||||
'pvecm' is a program to manage the cluster configuration. It can be
|
||||
used to create a new cluster, join nodes to a cluster, leave the
|
||||
cluster, get status information and do various other cluster related
|
||||
tasks.
|
||||
|
||||
|
||||
ifdef::manvolnum[]
|
||||
include::pve-copyright.adoc[]
|
||||
endif::manvolnum[]
|
||||
Loading…
x
Reference in New Issue
Block a user