add pvecm man page
[pve-docs.git] / pvecm.1-synopsis.adoc
1 *pvecm* `<COMMAND> [ARGS] [OPTIONS]`
2
3 *pvecm add* `<hostname>` `[OPTIONS]`
4
5 Adds the current node to an existing cluster.
6
7   <hostname> string
8
9              Hostname (or IP) of an existing cluster member.
10
11   -force     boolean
12
13              Do not throw error if node already exists.
14
15   -nodeid    integer (1 - N)
16
17              Node id for this node.
18
19   -ring0_addr string
20
21              Hostname (or IP) of the corosync ring0 address of this node.
22              Defaults to nodes hostname.
23
24   -ring1_addr string
25
26              Hostname (or IP) of the corosync ring1 address, this needs an
27              valid configured ring 1 interface in the cluster.
28
29   -votes     integer (0 - N)
30
31              Number of votes for this node
32
33
34
35 *pvecm addnode* `<node>` `[OPTIONS]`
36
37 Adds a node to the cluster configuration.
38
39   <node>     string
40
41              The cluster node name.
42
43   -force     boolean
44
45              Do not throw error if node already exists.
46
47   -nodeid    integer (1 - N)
48
49              Node id for this node.
50
51   -ring0_addr string
52
53              Hostname (or IP) of the corosync ring0 address of this node.
54              Defaults to nodes hostname.
55
56   -ring1_addr string
57
58              Hostname (or IP) of the corosync ring1 address, this needs an
59              valid bindnet1_addr.
60
61   -votes     integer (0 - N)
62
63              Number of votes for this node
64
65
66
67 *pvecm create* `<clustername>` `[OPTIONS]`
68
69 Generate new cluster configuration.
70
71   <clustername> string
72
73              The name of the cluster.
74
75   -bindnet0_addr string
76
77              This specifies the network address the corosync ring 0
78              executive should bind to and defaults to the local IP address
79              of the node.
80
81   -bindnet1_addr string
82
83              This specifies the network address the corosync ring 1
84              executive should bind to and is optional.
85
86   -nodeid    integer (1 - N)
87
88              Node id for this node.
89
90   -ring0_addr string
91
92              Hostname (or IP) of the corosync ring0 address of this node.
93              Defaults to the hostname of the node.
94
95   -ring1_addr string
96
97              Hostname (or IP) of the corosync ring1 address, this needs an
98              valid bindnet1_addr.
99
100   -rrp_mode  (active | none | passive)   (default=none)
101
102              This specifies the mode of redundant ring, which may be none,
103              active or passive. Using multiple interfaces only allows
104              'active' or 'passive'.
105
106   -votes     integer (1 - N)
107
108              Number of votes for this node.
109
110
111
112 *pvecm delnode* `<node>`
113
114 Removes a node to the cluster configuration.
115
116   <node>     string
117
118              The cluster node name.
119
120
121
122 *pvecm expected* `<expected>`
123
124 Tells corosync a new value of expected votes.
125
126   <expected> integer (1 - N)
127
128              Expected votes
129
130
131
132
133 *pvecm help* `[<cmd>]` `[OPTIONS]`
134
135 Get help about specified command.
136
137   <cmd>      string
138
139              Command name
140
141   -verbose   boolean
142
143              Verbose output format.
144
145
146
147
148 *pvecm keygen* `<filename>`
149
150 Generate new cryptographic key for corosync.
151
152   <filename> string
153
154              Output file name
155
156
157
158 *pvecm nodes*
159
160 Displays the local view of the cluster nodes.
161
162
163
164 *pvecm status*
165
166 Displays the local view of the cluster status.
167
168
169
170 *pvecm updatecerts* `[OPTIONS]`
171
172 Update node certificates (and generate all needed files/directories).
173
174   -force     boolean
175
176              Force generation of new SSL certifate.
177
178   -silent    boolean
179
180              Ignore errors (i.e. when cluster has no quorum).
181
182
183
184