]>
Commit | Line | Data |
---|---|---|
d8742b0c DM |
1 | *pvecm* `<COMMAND> [ARGS] [OPTIONS]` |
2 | ||
3 | *pvecm add* `<hostname>` `[OPTIONS]` | |
4 | ||
5 | Adds the current node to an existing cluster. | |
6 | ||
013dc89f | 7 | `<hostname>`: `<string>` :: |
d8742b0c | 8 | |
9b3e4991 | 9 | Hostname (or IP) of an existing cluster member. |
d8742b0c | 10 | |
27a7acb2 DM |
11 | `--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` :: |
12 | ||
13 | Certificate SHA 256 fingerprint. | |
14 | ||
2489d6df | 15 | `--force` `<boolean>` :: |
d8742b0c | 16 | |
9b3e4991 | 17 | Do not throw error if node already exists. |
d8742b0c | 18 | |
1e3f8156 | 19 | `--link[n]` `[address=]<IP> [,priority=<integer>]` :: |
d8742b0c | 20 | |
c5aa7e14 | 21 | Address and priority information of a single corosync link. (up to 8 links supported; link0..link7) |
d8742b0c | 22 | |
1e3f8156 | 23 | `--nodeid` `<integer> (1 - N)` :: |
d8742b0c | 24 | |
1e3f8156 | 25 | Node id for this node. |
27a7acb2 DM |
26 | |
27 | `--use_ssh` `<boolean>` :: | |
28 | ||
29 | Always use SSH to join, even if peer may do it over API. | |
d8742b0c | 30 | |
2489d6df | 31 | `--votes` `<integer> (0 - N)` :: |
d8742b0c | 32 | |
9b3e4991 | 33 | Number of votes for this node |
d8742b0c | 34 | |
d8742b0c DM |
35 | *pvecm addnode* `<node>` `[OPTIONS]` |
36 | ||
e2d681b3 | 37 | Adds a node to the cluster configuration. This call is for internal use. |
d8742b0c | 38 | |
013dc89f | 39 | `<node>`: `<string>` :: |
d8742b0c | 40 | |
9b3e4991 | 41 | The cluster node name. |
d8742b0c | 42 | |
c5aa7e14 TL |
43 | `--apiversion` `<integer>` :: |
44 | ||
45 | The JOIN_API_VERSION of the new node. | |
46 | ||
2489d6df | 47 | `--force` `<boolean>` :: |
d8742b0c | 48 | |
9b3e4991 | 49 | Do not throw error if node already exists. |
d8742b0c | 50 | |
1e3f8156 | 51 | `--link[n]` `[address=]<IP> [,priority=<integer>]` :: |
d8742b0c | 52 | |
c5aa7e14 TL |
53 | Address and priority information of a single corosync link. (up to 8 links supported; link0..link7) |
54 | ||
55 | `--new_node_ip` `<string>` :: | |
56 | ||
57 | IP Address of node to add. Used as fallback if no links are given. | |
d8742b0c | 58 | |
1e3f8156 | 59 | `--nodeid` `<integer> (1 - N)` :: |
d8742b0c | 60 | |
1e3f8156 | 61 | Node id for this node. |
d8742b0c | 62 | |
2489d6df | 63 | `--votes` `<integer> (0 - N)` :: |
d8742b0c | 64 | |
9b3e4991 | 65 | Number of votes for this node |
d8742b0c | 66 | |
c5aa7e14 TL |
67 | *pvecm apiver* |
68 | ||
69 | Return the version of the cluster join API available on this node. | |
70 | ||
d8742b0c DM |
71 | *pvecm create* `<clustername>` `[OPTIONS]` |
72 | ||
c5aa7e14 TL |
73 | Generate new cluster configuration. If no links given, default to local IP |
74 | address as link0. | |
d8742b0c | 75 | |
013dc89f | 76 | `<clustername>`: `<string>` :: |
d8742b0c | 77 | |
9b3e4991 | 78 | The name of the cluster. |
d8742b0c | 79 | |
1e3f8156 | 80 | `--link[n]` `[address=]<IP> [,priority=<integer>]` :: |
d8742b0c | 81 | |
c5aa7e14 | 82 | Address and priority information of a single corosync link. (up to 8 links supported; link0..link7) |
d8742b0c | 83 | |
2489d6df | 84 | `--nodeid` `<integer> (1 - N)` :: |
d8742b0c | 85 | |
9b3e4991 | 86 | Node id for this node. |
d8742b0c | 87 | |
2489d6df | 88 | `--votes` `<integer> (1 - N)` :: |
d8742b0c | 89 | |
9b3e4991 | 90 | Number of votes for this node. |
d8742b0c | 91 | |
d8742b0c DM |
92 | *pvecm delnode* `<node>` |
93 | ||
27a7acb2 | 94 | Removes a node from the cluster configuration. |
d8742b0c | 95 | |
013dc89f | 96 | `<node>`: `<string>` :: |
d8742b0c | 97 | |
27a7acb2 | 98 | The cluster node name. |
d8742b0c | 99 | |
d8742b0c DM |
100 | *pvecm expected* `<expected>` |
101 | ||
102 | Tells corosync a new value of expected votes. | |
103 | ||
013dc89f | 104 | `<expected>`: `<integer> (1 - N)` :: |
d8742b0c | 105 | |
9b3e4991 | 106 | Expected votes |
d8742b0c | 107 | |
35a75dd3 | 108 | *pvecm help* `[OPTIONS]` |
d8742b0c DM |
109 | |
110 | Get help about specified command. | |
111 | ||
35a75dd3 | 112 | `--extra-args` `<array>` :: |
d8742b0c | 113 | |
35a75dd3 | 114 | Shows help for a specific command |
d8742b0c | 115 | |
2489d6df | 116 | `--verbose` `<boolean>` :: |
d8742b0c | 117 | |
9b3e4991 | 118 | Verbose output format. |
d8742b0c | 119 | |
d8742b0c DM |
120 | *pvecm keygen* `<filename>` |
121 | ||
122 | Generate new cryptographic key for corosync. | |
123 | ||
013dc89f | 124 | `<filename>`: `<string>` :: |
d8742b0c | 125 | |
9b3e4991 | 126 | Output file name |
d8742b0c | 127 | |
9226ccbc TL |
128 | *pvecm mtunnel* `[<extra-args>]` `[OPTIONS]` |
129 | ||
130 | Used by VM/CT migration - do not use manually. | |
131 | ||
132 | `<extra-args>`: `<array>` :: | |
133 | ||
134 | Extra arguments as array | |
135 | ||
136 | `--get_migration_ip` `<boolean>` ('default =' `0`):: | |
137 | ||
138 | return the migration IP, if configured | |
139 | ||
140 | `--migration_network` `<string>` :: | |
141 | ||
142 | the migration network used to detect the local migration IP | |
143 | ||
144 | `--run-command` `<boolean>` :: | |
145 | ||
146 | Run a command with a tcp socket as standard input. The IP address and port are printed via this command's stdandard output first, each on a separate line. | |
147 | ||
d8742b0c DM |
148 | *pvecm nodes* |
149 | ||
150 | Displays the local view of the cluster nodes. | |
151 | ||
95895385 TL |
152 | *pvecm qdevice remove* |
153 | ||
154 | Remove a configured QDevice | |
155 | ||
156 | *pvecm qdevice setup* `<address>` `[OPTIONS]` | |
157 | ||
158 | Setup the use of a QDevice | |
159 | ||
160 | `<address>`: `<string>` :: | |
161 | ||
162 | Specifies the network address of an external corosync QDevice | |
163 | ||
164 | `--force` `<boolean>` :: | |
165 | ||
166 | Do not throw error on possible dangerous operations. | |
167 | ||
168 | `--network` `<string>` :: | |
169 | ||
170 | The network which should be used to connect to the external qdevice | |
171 | ||
d8742b0c DM |
172 | *pvecm status* |
173 | ||
174 | Displays the local view of the cluster status. | |
175 | ||
d8742b0c DM |
176 | *pvecm updatecerts* `[OPTIONS]` |
177 | ||
178 | Update node certificates (and generate all needed files/directories). | |
179 | ||
2489d6df | 180 | `--force` `<boolean>` :: |
d8742b0c | 181 | |
d2656385 | 182 | Force generation of new SSL certificate. |
d8742b0c | 183 | |
2489d6df | 184 | `--silent` `<boolean>` :: |
d8742b0c | 185 | |
9b3e4991 | 186 | Ignore errors (i.e. when cluster has no quorum). |
d8742b0c DM |
187 | |
188 |