update synopsis 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
22 nodes hostname.
23
24 `-ring1_addr` `string` ::
25
26 Hostname (or IP) of the corosync ring1 address, this needs an valid
27 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. Defaults to
54 nodes hostname.
55
56 `-ring1_addr` `string` ::
57
58 Hostname (or IP) of the corosync ring1 address, this needs an valid
59 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 executive should
78 bind to and defaults to the local IP address of the node.
79
80 `-bindnet1_addr` `string` ::
81
82 This specifies the network address the corosync ring 1 executive should
83 bind to and is optional.
84
85 `-nodeid` `integer (1 - N)` ::
86
87 Node id for this node.
88
89 `-ring0_addr` `string` ::
90
91 Hostname (or IP) of the corosync ring0 address of this node. Defaults to
92 the hostname of the node.
93
94 `-ring1_addr` `string` ::
95
96 Hostname (or IP) of the corosync ring1 address, this needs an valid
97 bindnet1_addr.
98
99 `-rrp_mode` `(active | none | passive)` (default=`none`)::
100
101 This specifies the mode of redundant ring, which may be none, active or
102 passive. Using multiple interfaces only allows 'active' or 'passive'.
103
104 `-votes` `integer (1 - N)` ::
105
106 Number of votes for this node.
107
108
109
110 *pvecm delnode* `<node>`
111
112 Removes a node to the cluster configuration.
113
114 `<node>` `string` ::
115
116 The cluster node name.
117
118
119
120 *pvecm expected* `<expected>`
121
122 Tells corosync a new value of expected votes.
123
124 `<expected>` `integer (1 - N)` ::
125
126 Expected votes
127
128
129
130
131 *pvecm help* `[<cmd>]` `[OPTIONS]`
132
133 Get help about specified command.
134
135 `<cmd>` `string` ::
136
137 Command name
138
139 `-verbose` `boolean` ::
140
141 Verbose output format.
142
143
144
145
146 *pvecm keygen* `<filename>`
147
148 Generate new cryptographic key for corosync.
149
150 `<filename>` `string` ::
151
152 Output file name
153
154
155
156 *pvecm nodes*
157
158 Displays the local view of the cluster nodes.
159
160
161
162 *pvecm status*
163
164 Displays the local view of the cluster status.
165
166
167
168 *pvecm updatecerts* `[OPTIONS]`
169
170 Update node certificates (and generate all needed files/directories).
171
172 `-force` `boolean` ::
173
174 Force generation of new SSL certifate.
175
176 `-silent` `boolean` ::
177
178 Ignore errors (i.e. when cluster has no quorum).
179
180
181
182