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