ACME account config file name.
-*pvenode acme account info* `[<name>]`
+*pvenode acme account info* `[<name>]` `[FORMAT_OPTIONS]`
Return existing ACME account information.
Revoke existing certificate from CA.
+*pvenode acme plugin add* `<type> <id>` `[OPTIONS]`
+
+Add ACME plugin configuration.
+
+`<type>`: `<dns | standalone>` ::
+
+ACME challenge type.
+
+`<id>`: `<string>` ::
+
+ACME Plugin ID name
+
+`--api` `<1984hosting | acmedns | acmeproxy | active24 | ad | ali | anx | artfiles | arvan | aurora | autodns | aws | azion | azure | bookmyname | bunny | cf | clouddns | cloudns | cn | conoha | constellix | cpanel | curanet | cyon | da | ddnss | desec | df | dgon | dnsexit | dnshome | dnsimple | dnsservices | do | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | edgedns | euserv | exoscale | fornex | freedns | gandi_livedns | gcloud | gcore | gd | geoscaling | googledomains | he | hetzner | hexonet | hostingde | huaweicloud | infoblox | infomaniak | internetbs | inwx | ionos | ipv64 | 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 | nanelo | 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 | tencent | transip | udr | ultra | unoeuro | variomedia | veesp | vercel | vscale | vultr | websupport | world4you | yandex | yc | zilore | zone | zonomi>` ::
+
+API plugin name
+
+`--data` `File with one key-value pair per line, will be base64url encode for storage in plugin config.` ::
+
+DNS plugin data. (base64 encoded)
+
+`--disable` `<boolean>` ::
+
+Flag to disable the config.
+
+`--nodes` `<string>` ::
+
+List of cluster node names.
+
+`--validation-delay` `<integer> (0 - 172800)` ('default =' `30`)::
+
+Extra delay in seconds to wait before requesting validation. Allows to cope with a long TTL of DNS records.
+
+*pvenode acme plugin config* `<id>` `[FORMAT_OPTIONS]`
+
+Get ACME plugin configuration.
+
+`<id>`: `<string>` ::
+
+Unique identifier for ACME plugin instance.
+
+*pvenode acme plugin list* `[OPTIONS]` `[FORMAT_OPTIONS]`
+
+ACME plugin index.
+
+`--type` `<dns | standalone>` ::
+
+Only list ACME plugins of a specific type
+
+*pvenode acme plugin remove* `<id>`
+
+Delete ACME plugin configuration.
+
+`<id>`: `<string>` ::
+
+Unique identifier for ACME plugin instance.
+
+*pvenode acme plugin set* `<id>` `[OPTIONS]`
+
+Update ACME plugin configuration.
+
+`<id>`: `<string>` ::
+
+ACME Plugin ID name
+
+`--api` `<1984hosting | acmedns | acmeproxy | active24 | ad | ali | anx | artfiles | arvan | aurora | autodns | aws | azion | azure | bookmyname | bunny | cf | clouddns | cloudns | cn | conoha | constellix | cpanel | curanet | cyon | da | ddnss | desec | df | dgon | dnsexit | dnshome | dnsimple | dnsservices | do | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | edgedns | euserv | exoscale | fornex | freedns | gandi_livedns | gcloud | gcore | gd | geoscaling | googledomains | he | hetzner | hexonet | hostingde | huaweicloud | infoblox | infomaniak | internetbs | inwx | ionos | ipv64 | 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 | nanelo | 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 | tencent | transip | udr | ultra | unoeuro | variomedia | veesp | vercel | vscale | vultr | websupport | world4you | yandex | yc | zilore | zone | zonomi>` ::
+
+API plugin name
+
+`--data` `File with one key-value pair per line, will be base64url encode for storage in plugin config.` ::
+
+DNS plugin data. (base64 encoded)
+
+`--delete` `<string>` ::
+
+A list of settings you want to delete.
+
+`--digest` `<string>` ::
+
+Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.
+
+`--disable` `<boolean>` ::
+
+Flag to disable the config.
+
+`--nodes` `<string>` ::
+
+List of cluster node names.
+
+`--validation-delay` `<integer> (0 - 172800)` ('default =' `30`)::
+
+Extra delay in seconds to wait before requesting validation. Allows to cope with a long TTL of DNS records.
+
*pvenode cert delete* `[<restart>]`
DELETE custom certificate chain and key.
Restart pveproxy.
-*pvenode cert info*
+*pvenode cert info* `[FORMAT_OPTIONS]`
Get information about node's certificates.
-*pvenode cert set* `<certificates> [<key>]` `[OPTIONS]`
+*pvenode cert set* `<certificates> [<key>]` `[OPTIONS]` `[FORMAT_OPTIONS]`
Upload or update custom certificate chain and key.
Restart pveproxy.
-*pvenode config get*
+*pvenode config get* `[OPTIONS]`
Get node configuration options.
+`--property` `<acme | acmedomain0 | acmedomain1 | acmedomain2 | acmedomain3 | acmedomain4 | acmedomain5 | description | startall-onboot-delay | wakeonlan>` ('default =' `all`)::
+
+Return only a specific property from the node configuration.
+
*pvenode config set* `[OPTIONS]`
Set node configuration options.
-`--acme` `domains=<domain[;domain;...]> [,account=<name>]` ::
+`--acme` `[account=<name>] [,domains=<domain[;domain;...]>]` ::
Node specific ACME settings.
+`--acmedomain[n]` `[domain=]<domain> [,alias=<domain>] [,plugin=<name of the plugin configuration>]` ::
+
+ACME domain and validation plugin
+
`--delete` `<string>` ::
A list of settings you want to delete.
`--description` `<string>` ::
-Node description/comment.
+Description for the Node. Shown in the web-interface node notes panel. This is saved as comment inside the configuration file.
`--digest` `<string>` ::
Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
+`--startall-onboot-delay` `<integer> (0 - 300)` ('default =' `0`)::
+
+Initial delay in seconds, before starting all the Virtual Guests with on-boot enabled.
+
+`--wakeonlan` `[mac=]<MAC address> [,bind-interface=<bind interface>] [,broadcast-address=<IPv4 broadcast address>]` ::
+
+Node specific wake on LAN settings.
+
*pvenode help* `[OPTIONS]`
Get help about specified command.
`--maxworkers` `<integer> (1 - N)` ::
-Maximal number of parallel migration job. If not set use 'max_workers' from datacenter.cfg, one of both must be set!
+Maximal number of parallel migration job. If not set, uses'max_workers' from datacenter.cfg. One of both must be set!
`--vms` `<string>` ::
Only consider Guests with these IDs.
+`--with-local-disks` `<boolean>` ::
+
+Enable live storage migration for local disk
+
*pvenode startall* `[OPTIONS]`
-Start all VMs and containers (when onboot=1).
+Start all VMs and containers located on this node (by default only those
+with onboot=1).
-`--force` `<boolean>` ::
+`--force` `<boolean>` ('default =' `off`)::
-force if onboot=0.
+Issue start command even if virtual guest have 'onboot' not set or set to off.
`--vms` `<string>` ::
-Only consider Guests with these IDs.
+Only consider guests from this comma separated list of VMIDs.
*pvenode stopall* `[OPTIONS]`
Stop all VMs and Containers.
+`--force-stop` `<boolean>` ('default =' `1`)::
+
+Force a hard-stop after the timeout.
+
+`--timeout` `<integer> (0 - 7200)` ('default =' `180`)::
+
+Timeout for each guest shutdown task. Depending on `force-stop`, the shutdown gets then simply aborted or a hard-stop is forced.
+
`--vms` `<string>` ::
Only consider Guests with these IDs.
+*pvenode task list* `[OPTIONS]` `[FORMAT_OPTIONS]`
+
+Read task list for one node (finished tasks).
+
+`--errors` `<boolean>` ('default =' `0`)::
+
+Only list tasks with a status of ERROR.
+
+`--limit` `<integer> (0 - N)` ('default =' `50`)::
+
+Only list this amount of tasks.
+
+`--since` `<integer>` ::
+
+Only list tasks since this UNIX epoch.
+
+`--source` `<active | all | archive>` ('default =' `archive`)::
+
+List archived, active or all tasks.
+
+`--start` `<integer> (0 - N)` ('default =' `0`)::
+
+List tasks beginning from this offset.
+
+`--statusfilter` `<string>` ::
+
+List of Task States that should be returned.
+
+`--typefilter` `<string>` ::
+
+Only list tasks of this type (e.g., vzstart, vzdump).
+
+`--until` `<integer>` ::
+
+Only list tasks until this UNIX epoch.
+
+`--userfilter` `<string>` ::
+
+Only list tasks from this user.
+
+`--vmid` `<integer> (100 - 999999999)` ::
+
+Only list tasks for this VM.
+
+*pvenode task log* `<upid>` `[OPTIONS]`
+
+Read task log.
+
+`<upid>`: `<string>` ::
+
+The task's unique ID.
+
+`--download` `<boolean>` ::
+
+Whether the tasklog file should be downloaded. This parameter can't be used in conjunction with other parameters
+
+`--start` `<integer> (0 - N)` ('default =' `0`)::
+
+Start at this line when reading the tasklog
+
+*pvenode task status* `<upid>` `[FORMAT_OPTIONS]`
+
+Read task status.
+
+`<upid>`: `<string>` ::
+
+The task's unique ID.
+
+*pvenode wakeonlan* `<node>`
+
+Try to wake a node via 'wake on LAN' network packet.
+
+`<node>`: `<string>` ::
+
+target node for wake on LAN packet
+
projects / pve-docs.git / blobdiff