1 *pvenode* `<COMMAND> [ARGS] [OPTIONS]`
3 *pvenode acme account deactivate* `[<name>]`
5 Deactivate existing ACME account at CA.
7 `<name>`: `<name>` ('default =' `default`)::
9 ACME account config file name.
11 *pvenode acme account info* `[<name>]` `[FORMAT_OPTIONS]`
13 Return existing ACME account information.
15 `<name>`: `<name>` ('default =' `default`)::
17 ACME account config file name.
19 *pvenode acme account list*
23 *pvenode acme account register* `[<name>] {<contact>}` `[OPTIONS]`
25 Register a new ACME account with a compatible CA.
27 `<name>`: `<name>` ('default =' `default`)::
29 ACME account config file name.
31 `<contact>`: `<string>` ::
33 Contact email addresses.
35 `--directory` `^https?://.*` ::
37 URL of ACME CA directory endpoint.
39 *pvenode acme account update* `[<name>]` `[OPTIONS]`
41 Update existing ACME account information with CA. Note: not specifying any
42 new account information triggers a refresh.
44 `<name>`: `<name>` ('default =' `default`)::
46 ACME account config file name.
48 `--contact` `<string>` ::
50 Contact email addresses.
52 *pvenode acme cert order* `[OPTIONS]`
54 Order a new certificate from ACME-compatible CA.
56 `--force` `<boolean>` ('default =' `0`)::
58 Overwrite existing custom certificate.
60 *pvenode acme cert renew* `[OPTIONS]`
62 Renew existing certificate from CA.
64 `--force` `<boolean>` ('default =' `0`)::
66 Force renewal even if expiry is more than 30 days away.
68 *pvenode acme cert revoke*
70 Revoke existing certificate from CA.
72 *pvenode acme plugin add* `<type> <id>` `[OPTIONS]`
74 Add ACME plugin configuration.
76 `<type>`: `<dns | standalone>` ::
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>` ::
88 `--data` `File with one key-value pair per line, will be base64url encode for storage in plugin config.` ::
90 DNS plugin data. (base64 encoded)
92 `--disable` `<boolean>` ::
94 Flag to disable the config.
96 `--nodes` `<string>` ::
98 List of cluster node names.
100 `--validation-delay` `<integer> (0 - 172800)` ('default =' `30`)::
102 Extra delay in seconds to wait before requesting validation. Allows to cope with a long TTL of DNS records.
104 *pvenode acme plugin config* `<id>` `[FORMAT_OPTIONS]`
106 Get ACME plugin configuration.
108 `<id>`: `<string>` ::
110 Unique identifier for ACME plugin instance.
112 *pvenode acme plugin list* `[OPTIONS]` `[FORMAT_OPTIONS]`
116 `--type` `<dns | standalone>` ::
118 Only list ACME plugins of a specific type
120 *pvenode acme plugin remove* `<id>`
122 Delete ACME plugin configuration.
124 `<id>`: `<string>` ::
126 Unique identifier for ACME plugin instance.
128 *pvenode acme plugin set* `<id>` `[OPTIONS]`
130 Update ACME plugin configuration.
132 `<id>`: `<string>` ::
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>` ::
140 `--data` `File with one key-value pair per line, will be base64url encode for storage in plugin config.` ::
142 DNS plugin data. (base64 encoded)
144 `--delete` `<string>` ::
146 A list of settings you want to delete.
148 `--digest` `<string>` ::
150 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
152 `--disable` `<boolean>` ::
154 Flag to disable the config.
156 `--nodes` `<string>` ::
158 List of cluster node names.
160 `--validation-delay` `<integer> (0 - 172800)` ('default =' `30`)::
162 Extra delay in seconds to wait before requesting validation. Allows to cope with a long TTL of DNS records.
164 *pvenode cert delete* `[<restart>]`
166 DELETE custom certificate chain and key.
168 `<restart>`: `<boolean>` ('default =' `0`)::
172 *pvenode cert info* `[FORMAT_OPTIONS]`
174 Get information about node's certificates.
176 *pvenode cert set* `<certificates> [<key>]` `[OPTIONS]` `[FORMAT_OPTIONS]`
178 Upload or update custom certificate chain and key.
180 `<certificates>`: `<string>` ::
182 PEM encoded certificate (chain).
184 `<key>`: `<string>` ::
186 PEM encoded private key.
188 `--force` `<boolean>` ('default =' `0`)::
190 Overwrite existing custom or ACME certificate files.
192 `--restart` `<boolean>` ('default =' `0`)::
196 *pvenode config get* `[OPTIONS]`
198 Get node configuration options.
200 `--property` `<acme | acmedomain0 | acmedomain1 | acmedomain2 | acmedomain3 | acmedomain4 | acmedomain5 | description | startall-onboot-delay | wakeonlan>` ('default =' `all`)::
202 Return only a specific property from the node configuration.
204 *pvenode config set* `[OPTIONS]`
206 Set node configuration options.
208 `--acme` `[account=<name>] [,domains=<domain[;domain;...]>]` ::
210 Node specific ACME settings.
212 `--acmedomain[n]` `[domain=]<domain> [,alias=<domain>] [,plugin=<name of the plugin configuration>]` ::
214 ACME domain and validation plugin
216 `--delete` `<string>` ::
218 A list of settings you want to delete.
220 `--description` `<string>` ::
222 Description for the Node. Shown in the web-interface node notes panel. This is saved as comment inside the configuration file.
224 `--digest` `<string>` ::
226 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
228 `--startall-onboot-delay` `<integer> (0 - 300)` ('default =' `0`)::
230 Initial delay in seconds, before starting all the Virtual Guests with on-boot enabled.
232 `--wakeonlan` `<string>` ::
234 MAC address for wake on LAN
236 *pvenode help* `[OPTIONS]`
238 Get help about specified command.
240 `--extra-args` `<array>` ::
242 Shows help for a specific command
244 `--verbose` `<boolean>` ::
246 Verbose output format.
248 *pvenode migrateall* `<target>` `[OPTIONS]`
250 Migrate all VMs and Containers.
252 `<target>`: `<string>` ::
256 `--maxworkers` `<integer> (1 - N)` ::
258 Maximal number of parallel migration job. If not set, uses'max_workers' from datacenter.cfg. One of both must be set!
260 `--vms` `<string>` ::
262 Only consider Guests with these IDs.
264 `--with-local-disks` `<boolean>` ::
266 Enable live storage migration for local disk
268 *pvenode startall* `[OPTIONS]`
270 Start all VMs and containers located on this node (by default only those
273 `--force` `<boolean>` ('default =' `off`)::
275 Issue start command even if virtual guest have 'onboot' not set or set to off.
277 `--vms` `<string>` ::
279 Only consider guests from this comma separated list of VMIDs.
281 *pvenode stopall* `[OPTIONS]`
283 Stop all VMs and Containers.
285 `--force-stop` `<boolean>` ('default =' `1`)::
287 Force a hard-stop after the timeout.
289 `--timeout` `<integer> (0 - 7200)` ('default =' `180`)::
291 Timeout for each guest shutdown task. Depending on `force-stop`, the shutdown gets then simply aborted or a hard-stop is forced.
293 `--vms` `<string>` ::
295 Only consider Guests with these IDs.
297 *pvenode task list* `[OPTIONS]` `[FORMAT_OPTIONS]`
299 Read task list for one node (finished tasks).
301 `--errors` `<boolean>` ('default =' `0`)::
303 Only list tasks with a status of ERROR.
305 `--limit` `<integer> (0 - N)` ('default =' `50`)::
307 Only list this amount of tasks.
309 `--since` `<integer>` ::
311 Only list tasks since this UNIX epoch.
313 `--source` `<active | all | archive>` ('default =' `archive`)::
315 List archived, active or all tasks.
317 `--start` `<integer> (0 - N)` ('default =' `0`)::
319 List tasks beginning from this offset.
321 `--statusfilter` `<string>` ::
323 List of Task States that should be returned.
325 `--typefilter` `<string>` ::
327 Only list tasks of this type (e.g., vzstart, vzdump).
329 `--until` `<integer>` ::
331 Only list tasks until this UNIX epoch.
333 `--userfilter` `<string>` ::
335 Only list tasks from this user.
337 `--vmid` `<integer> (1 - N)` ::
339 Only list tasks for this VM.
341 *pvenode task log* `<upid>` `[OPTIONS]`
345 `<upid>`: `<string>` ::
347 The task's unique ID.
349 `--download` `<boolean>` ::
351 Whether the tasklog file should be downloaded. This parameter can't be used in conjunction with other parameters
353 `--start` `<integer> (0 - N)` ('default =' `0`)::
355 Start at this line when reading the tasklog
357 *pvenode task status* `<upid>` `[FORMAT_OPTIONS]`
361 `<upid>`: `<string>` ::
363 The task's unique ID.
365 *pvenode wakeonlan* `<node>`
367 Try to wake a node via 'wake on LAN' network packet.
369 `<node>`: `<string>` ::
371 target node for wake on LAN packet