]>
Commit | Line | Data |
---|---|---|
a99bdc62 FG |
1 | *pvenode* `<COMMAND> [ARGS] [OPTIONS]` |
2 | ||
3 | *pvenode acme account deactivate* `[<name>]` | |
4 | ||
5 | Deactivate existing ACME account at CA. | |
6 | ||
7 | `<name>`: `<name>` ('default =' `default`):: | |
8 | ||
9 | ACME account config file name. | |
10 | ||
a3eeb58f | 11 | *pvenode acme account info* `[<name>]` `[FORMAT_OPTIONS]` |
a99bdc62 FG |
12 | |
13 | Return existing ACME account information. | |
14 | ||
15 | `<name>`: `<name>` ('default =' `default`):: | |
16 | ||
17 | ACME account config file name. | |
18 | ||
19 | *pvenode acme account list* | |
20 | ||
21 | ACMEAccount index. | |
22 | ||
23 | *pvenode acme account register* `[<name>] {<contact>}` `[OPTIONS]` | |
24 | ||
25 | Register a new ACME account with a compatible CA. | |
26 | ||
27 | `<name>`: `<name>` ('default =' `default`):: | |
28 | ||
29 | ACME account config file name. | |
30 | ||
31 | `<contact>`: `<string>` :: | |
32 | ||
33 | Contact email addresses. | |
34 | ||
35 | `--directory` `^https?://.*` :: | |
36 | ||
37 | URL of ACME CA directory endpoint. | |
38 | ||
39 | *pvenode acme account update* `[<name>]` `[OPTIONS]` | |
40 | ||
41 | Update existing ACME account information with CA. Note: not specifying any | |
42 | new account information triggers a refresh. | |
43 | ||
44 | `<name>`: `<name>` ('default =' `default`):: | |
45 | ||
46 | ACME account config file name. | |
47 | ||
48 | `--contact` `<string>` :: | |
49 | ||
50 | Contact email addresses. | |
51 | ||
52 | *pvenode acme cert order* `[OPTIONS]` | |
53 | ||
54 | Order a new certificate from ACME-compatible CA. | |
55 | ||
56 | `--force` `<boolean>` ('default =' `0`):: | |
57 | ||
58 | Overwrite existing custom certificate. | |
59 | ||
60 | *pvenode acme cert renew* `[OPTIONS]` | |
61 | ||
62 | Renew existing certificate from CA. | |
63 | ||
64 | `--force` `<boolean>` ('default =' `0`):: | |
65 | ||
66 | Force renewal even if expiry is more than 30 days away. | |
67 | ||
68 | *pvenode acme cert revoke* | |
69 | ||
70 | Revoke existing certificate from CA. | |
71 | ||
c5aa7e14 TL |
72 | *pvenode acme plugin add* `<type> <id>` `[OPTIONS]` |
73 | ||
74 | Add ACME plugin configuration. | |
75 | ||
76 | `<type>`: `<dns | standalone>` :: | |
77 | ||
78 | ACME challenge type. | |
79 | ||
80 | `<id>`: `<string>` :: | |
81 | ||
82 | ACME Plugin ID name | |
83 | ||
9d2e98ed | 84 | `--api` `<1984hosting | acmedns | acmeproxy | active24 | ad | ali | anx | arvan | aurora | autodns | aws | azion | azure | bunny | cf | clouddns | cloudns | cn | conoha | constellix | cpanel | curanet | cyon | da | ddnss | desec | df | dgon | dnshome | dnsimple | dnsservices | do | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | edgedns | euserv | exoscale | fornex | freedns | gandi_livedns | gcloud | gd | geoscaling | he | hetzner | hexonet | hostingde | huaweicloud | infoblox | infomaniak | internetbs | inwx | ionos | ispconfig | jd | joker | kappernet | kas | kinghost | knot | la | leaseweb | lexicon | linode | linode_v4 | loopia | lua | maradns | me | miab | misaka | myapi | mydevil | mydnsjp | mythic_beasts | namecheap | namecom | namesilo | nederhost | neodigit | netcup | netlify | nic | njalla | nm | nsd | nsone | nsupdate | nw | oci | one | online | openprovider | openstack | opnsense | ovh | pdns | pleskxml | pointhq | porkbun | rackcorp | rackspace | rage4 | rcode0 | regru | scaleway | schlundtech | selectel | selfhost | servercow | simply | tele3 | transip | udr | ultra | unoeuro | variomedia | veesp | vercel | vscale | vultr | websupport | world4you | yandex | yc | zilore | zone | zonomi>` :: |
c5aa7e14 TL |
85 | |
86 | API plugin name | |
87 | ||
88 | `--data` `File with one key-value pair per line, will be base64url encode for storage in plugin config.` :: | |
89 | ||
90 | DNS plugin data. (base64 encoded) | |
91 | ||
92 | `--disable` `<boolean>` :: | |
93 | ||
94 | Flag to disable the config. | |
95 | ||
96 | `--nodes` `<string>` :: | |
97 | ||
98 | List of cluster node names. | |
99 | ||
100 | `--validation-delay` `<integer> (0 - 172800)` ('default =' `30`):: | |
101 | ||
102 | Extra delay in seconds to wait before requesting validation. Allows to cope with a long TTL of DNS records. | |
103 | ||
104 | *pvenode acme plugin config* `<id>` `[FORMAT_OPTIONS]` | |
105 | ||
106 | Get ACME plugin configuration. | |
107 | ||
108 | `<id>`: `<string>` :: | |
109 | ||
110 | Unique identifier for ACME plugin instance. | |
111 | ||
112 | *pvenode acme plugin list* `[OPTIONS]` `[FORMAT_OPTIONS]` | |
113 | ||
114 | ACME plugin index. | |
115 | ||
116 | `--type` `<dns | standalone>` :: | |
117 | ||
118 | Only list ACME plugins of a specific type | |
119 | ||
120 | *pvenode acme plugin remove* `<id>` | |
121 | ||
122 | Delete ACME plugin configuration. | |
123 | ||
124 | `<id>`: `<string>` :: | |
125 | ||
126 | Unique identifier for ACME plugin instance. | |
127 | ||
128 | *pvenode acme plugin set* `<id>` `[OPTIONS]` | |
129 | ||
130 | Update ACME plugin configuration. | |
131 | ||
132 | `<id>`: `<string>` :: | |
133 | ||
134 | ACME Plugin ID name | |
135 | ||
9d2e98ed | 136 | `--api` `<1984hosting | acmedns | acmeproxy | active24 | ad | ali | anx | arvan | aurora | autodns | aws | azion | azure | bunny | cf | clouddns | cloudns | cn | conoha | constellix | cpanel | curanet | cyon | da | ddnss | desec | df | dgon | dnshome | dnsimple | dnsservices | do | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | edgedns | euserv | exoscale | fornex | freedns | gandi_livedns | gcloud | gd | geoscaling | he | hetzner | hexonet | hostingde | huaweicloud | infoblox | infomaniak | internetbs | inwx | ionos | ispconfig | jd | joker | kappernet | kas | kinghost | knot | la | leaseweb | lexicon | linode | linode_v4 | loopia | lua | maradns | me | miab | misaka | myapi | mydevil | mydnsjp | mythic_beasts | namecheap | namecom | namesilo | nederhost | neodigit | netcup | netlify | nic | njalla | nm | nsd | nsone | nsupdate | nw | oci | one | online | openprovider | openstack | opnsense | ovh | pdns | pleskxml | pointhq | porkbun | rackcorp | rackspace | rage4 | rcode0 | regru | scaleway | schlundtech | selectel | selfhost | servercow | simply | tele3 | transip | udr | ultra | unoeuro | variomedia | veesp | vercel | vscale | vultr | websupport | world4you | yandex | yc | zilore | zone | zonomi>` :: |
c5aa7e14 TL |
137 | |
138 | API plugin name | |
139 | ||
140 | `--data` `File with one key-value pair per line, will be base64url encode for storage in plugin config.` :: | |
141 | ||
142 | DNS plugin data. (base64 encoded) | |
143 | ||
144 | `--delete` `<string>` :: | |
145 | ||
146 | A list of settings you want to delete. | |
147 | ||
148 | `--digest` `<string>` :: | |
149 | ||
150 | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. | |
151 | ||
152 | `--disable` `<boolean>` :: | |
153 | ||
154 | Flag to disable the config. | |
155 | ||
156 | `--nodes` `<string>` :: | |
157 | ||
158 | List of cluster node names. | |
159 | ||
160 | `--validation-delay` `<integer> (0 - 172800)` ('default =' `30`):: | |
161 | ||
162 | Extra delay in seconds to wait before requesting validation. Allows to cope with a long TTL of DNS records. | |
163 | ||
a99bdc62 FG |
164 | *pvenode cert delete* `[<restart>]` |
165 | ||
166 | DELETE custom certificate chain and key. | |
167 | ||
168 | `<restart>`: `<boolean>` ('default =' `0`):: | |
169 | ||
170 | Restart pveproxy. | |
171 | ||
a3eeb58f | 172 | *pvenode cert info* `[FORMAT_OPTIONS]` |
a99bdc62 FG |
173 | |
174 | Get information about node's certificates. | |
175 | ||
a3eeb58f | 176 | *pvenode cert set* `<certificates> [<key>]` `[OPTIONS]` `[FORMAT_OPTIONS]` |
a99bdc62 FG |
177 | |
178 | Upload or update custom certificate chain and key. | |
179 | ||
180 | `<certificates>`: `<string>` :: | |
181 | ||
182 | PEM encoded certificate (chain). | |
183 | ||
184 | `<key>`: `<string>` :: | |
185 | ||
186 | PEM encoded private key. | |
187 | ||
188 | `--force` `<boolean>` ('default =' `0`):: | |
189 | ||
190 | Overwrite existing custom or ACME certificate files. | |
191 | ||
192 | `--restart` `<boolean>` ('default =' `0`):: | |
193 | ||
194 | Restart pveproxy. | |
195 | ||
5c1699e5 | 196 | *pvenode config get* `[OPTIONS]` |
a99bdc62 FG |
197 | |
198 | Get node configuration options. | |
199 | ||
c5aa7e14 | 200 | `--property` `<acme | acmedomain0 | acmedomain1 | acmedomain2 | acmedomain3 | acmedomain4 | acmedomain5 | description | startall-onboot-delay | wakeonlan>` ('default =' `all`):: |
5c1699e5 TL |
201 | |
202 | Return only a specific property from the node configuration. | |
203 | ||
a99bdc62 FG |
204 | *pvenode config set* `[OPTIONS]` |
205 | ||
206 | Set node configuration options. | |
207 | ||
c5aa7e14 | 208 | `--acme` `[account=<name>] [,domains=<domain[;domain;...]>]` :: |
a99bdc62 FG |
209 | |
210 | Node specific ACME settings. | |
211 | ||
c5aa7e14 TL |
212 | `--acmedomain[n]` `[domain=]<domain> [,alias=<domain>] [,plugin=<name of the plugin configuration>]` :: |
213 | ||
214 | ACME domain and validation plugin | |
215 | ||
a99bdc62 FG |
216 | `--delete` `<string>` :: |
217 | ||
218 | A list of settings you want to delete. | |
219 | ||
220 | `--description` `<string>` :: | |
221 | ||
0695fdaf | 222 | Description for the Node. Shown in the web-interface node notes panel. This is saved as comment inside the configuration file. |
a99bdc62 FG |
223 | |
224 | `--digest` `<string>` :: | |
225 | ||
226 | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. | |
227 | ||
5c1699e5 TL |
228 | `--startall-onboot-delay` `<integer> (0 - 300)` ('default =' `0`):: |
229 | ||
230 | Initial delay in seconds, before starting all the Virtual Guests with on-boot enabled. | |
231 | ||
5f26e15b TL |
232 | `--wakeonlan` `<string>` :: |
233 | ||
234 | MAC address for wake on LAN | |
235 | ||
a99bdc62 FG |
236 | *pvenode help* `[OPTIONS]` |
237 | ||
238 | Get help about specified command. | |
239 | ||
240 | `--extra-args` `<array>` :: | |
241 | ||
242 | Shows help for a specific command | |
243 | ||
244 | `--verbose` `<boolean>` :: | |
245 | ||
246 | Verbose output format. | |
247 | ||
5da3d723 TL |
248 | *pvenode migrateall* `<target>` `[OPTIONS]` |
249 | ||
250 | Migrate all VMs and Containers. | |
251 | ||
252 | `<target>`: `<string>` :: | |
253 | ||
254 | Target node. | |
255 | ||
256 | `--maxworkers` `<integer> (1 - N)` :: | |
257 | ||
9d2e98ed | 258 | Maximal number of parallel migration job. If not set, uses'max_workers' from datacenter.cfg. One of both must be set! |
5da3d723 TL |
259 | |
260 | `--vms` `<string>` :: | |
261 | ||
262 | Only consider Guests with these IDs. | |
263 | ||
e9cd3bd4 TL |
264 | `--with-local-disks` `<boolean>` :: |
265 | ||
266 | Enable live storage migration for local disk | |
267 | ||
5da3d723 TL |
268 | *pvenode startall* `[OPTIONS]` |
269 | ||
1c532546 TL |
270 | Start all VMs and containers located on this node (by default only those |
271 | with onboot=1). | |
5da3d723 | 272 | |
1c532546 | 273 | `--force` `<boolean>` ('default =' `off`):: |
5da3d723 | 274 | |
1c532546 | 275 | Issue start command even if virtual guest have 'onboot' not set or set to off. |
5da3d723 TL |
276 | |
277 | `--vms` `<string>` :: | |
278 | ||
1c532546 | 279 | Only consider guests from this comma separated list of VMIDs. |
5da3d723 TL |
280 | |
281 | *pvenode stopall* `[OPTIONS]` | |
282 | ||
283 | Stop all VMs and Containers. | |
284 | ||
9d2e98ed TL |
285 | `--force-stop` `<boolean>` ('default =' `1`):: |
286 | ||
287 | Force a hard-stop after the timeout. | |
288 | ||
289 | `--timeout` `<integer> (0 - 7200)` ('default =' `180`):: | |
290 | ||
291 | Timeout for each guest shutdown task. Depending on `force-stop`, the shutdown gets then simply aborted or a hard-stop is forced. | |
292 | ||
5da3d723 TL |
293 | `--vms` `<string>` :: |
294 | ||
295 | Only consider Guests with these IDs. | |
296 | ||
a3eeb58f DM |
297 | *pvenode task list* `[OPTIONS]` `[FORMAT_OPTIONS]` |
298 | ||
299 | Read task list for one node (finished tasks). | |
300 | ||
301 | `--errors` `<boolean>` ('default =' `0`):: | |
302 | ||
5370fa8c | 303 | Only list tasks with a status of ERROR. |
a3eeb58f DM |
304 | |
305 | `--limit` `<integer> (0 - N)` ('default =' `50`):: | |
306 | ||
307 | Only list this amount of tasks. | |
308 | ||
34f3e481 TL |
309 | `--since` `<integer>` :: |
310 | ||
311 | Only list tasks since this UNIX epoch. | |
312 | ||
5f26e15b TL |
313 | `--source` `<active | all | archive>` ('default =' `archive`):: |
314 | ||
315 | List archived, active or all tasks. | |
316 | ||
a3eeb58f DM |
317 | `--start` `<integer> (0 - N)` ('default =' `0`):: |
318 | ||
319 | List tasks beginning from this offset. | |
320 | ||
34f3e481 TL |
321 | `--statusfilter` `<string>` :: |
322 | ||
323 | List of Task States that should be returned. | |
324 | ||
5f26e15b TL |
325 | `--typefilter` `<string>` :: |
326 | ||
327 | Only list tasks of this type (e.g., vzstart, vzdump). | |
328 | ||
34f3e481 TL |
329 | `--until` `<integer>` :: |
330 | ||
331 | Only list tasks until this UNIX epoch. | |
332 | ||
a3eeb58f DM |
333 | `--userfilter` `<string>` :: |
334 | ||
335 | Only list tasks from this user. | |
336 | ||
337 | `--vmid` `<integer> (1 - N)` :: | |
338 | ||
339 | Only list tasks for this VM. | |
340 | ||
341 | *pvenode task log* `<upid>` `[OPTIONS]` | |
342 | ||
343 | Read task log. | |
344 | ||
345 | `<upid>`: `<string>` :: | |
346 | ||
5370fa8c | 347 | The task's unique ID. |
a3eeb58f | 348 | |
9d2e98ed TL |
349 | `--download` `<boolean>` :: |
350 | ||
351 | Whether the tasklog file should be downloaded. This parameter can't be used in conjunction with other parameters | |
352 | ||
a3eeb58f DM |
353 | `--start` `<integer> (0 - N)` ('default =' `0`):: |
354 | ||
9d2e98ed | 355 | Start at this line when reading the tasklog |
a3eeb58f DM |
356 | |
357 | *pvenode task status* `<upid>` `[FORMAT_OPTIONS]` | |
358 | ||
359 | Read task status. | |
360 | ||
361 | `<upid>`: `<string>` :: | |
362 | ||
5370fa8c | 363 | The task's unique ID. |
a3eeb58f | 364 | |
5f26e15b TL |
365 | *pvenode wakeonlan* `<node>` |
366 | ||
367 | Try to wake a node via 'wake on LAN' network packet. | |
368 | ||
369 | `<node>`: `<string>` :: | |
370 | ||
371 | target node for wake on LAN packet | |
372 | ||
a99bdc62 | 373 |