X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=pvenode.1-synopsis.adoc;h=aeba64aeef44be53038744a8b549b8d52fc5ca0c;hp=ae7d4b24f630b1ab20d91578fcbedb50c1a9be2c;hb=HEAD;hpb=5c1699e5ef4b9cd54b2ea9da1f74db39f0c2acd7 diff --git a/pvenode.1-synopsis.adoc b/pvenode.1-synopsis.adoc index ae7d4b2..2c17e99 100644 --- a/pvenode.1-synopsis.adoc +++ b/pvenode.1-synopsis.adoc @@ -69,6 +69,98 @@ Force renewal even if expiry is more than 30 days away. Revoke existing certificate from CA. +*pvenode acme plugin add* ` ` `[OPTIONS]` + +Add ACME plugin configuration. + +``: `` :: + +ACME challenge type. + +``: `` :: + +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` `` :: + +Flag to disable the config. + +`--nodes` `` :: + +List of cluster node names. + +`--validation-delay` ` (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* `` `[FORMAT_OPTIONS]` + +Get ACME plugin configuration. + +``: `` :: + +Unique identifier for ACME plugin instance. + +*pvenode acme plugin list* `[OPTIONS]` `[FORMAT_OPTIONS]` + +ACME plugin index. + +`--type` `` :: + +Only list ACME plugins of a specific type + +*pvenode acme plugin remove* `` + +Delete ACME plugin configuration. + +``: `` :: + +Unique identifier for ACME plugin instance. + +*pvenode acme plugin set* `` `[OPTIONS]` + +Update ACME plugin configuration. + +``: `` :: + +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` `` :: + +A list of settings you want to delete. + +`--digest` `` :: + +Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. + +`--disable` `` :: + +Flag to disable the config. + +`--nodes` `` :: + +List of cluster node names. + +`--validation-delay` ` (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* `[]` DELETE custom certificate chain and key. @@ -105,7 +197,7 @@ Restart pveproxy. Get node configuration options. -`--property` `` ('default =' `all`):: +`--property` `` ('default =' `all`):: Return only a specific property from the node configuration. @@ -113,17 +205,21 @@ Return only a specific property from the node configuration. Set node configuration options. -`--acme` `domains= [,account=]` :: +`--acme` `[account=] [,domains=]` :: Node specific ACME settings. +`--acmedomain[n]` `[domain=] [,alias=] [,plugin=]` :: + +ACME domain and validation plugin + `--delete` `` :: A list of settings you want to delete. `--description` `` :: -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` `` :: @@ -133,9 +229,9 @@ Prevent changes if current configuration file has different SHA1 digest. This ca Initial delay in seconds, before starting all the Virtual Guests with on-boot enabled. -`--wakeonlan` `` :: +`--wakeonlan` `[mac=] [,bind-interface=] [,broadcast-address=]` :: -MAC address for wake on LAN +Node specific wake on LAN settings. *pvenode help* `[OPTIONS]` @@ -159,12 +255,16 @@ Target node. `--maxworkers` ` (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` `` :: Only consider Guests with these IDs. +`--with-local-disks` `` :: + +Enable live storage migration for local disk + *pvenode startall* `[OPTIONS]` Start all VMs and containers located on this node (by default only those @@ -182,6 +282,14 @@ Only consider guests from this comma separated list of VMIDs. Stop all VMs and Containers. +`--force-stop` `` ('default =' `1`):: + +Force a hard-stop after the timeout. + +`--timeout` ` (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` `` :: Only consider Guests with these IDs. @@ -192,12 +300,16 @@ Read task list for one node (finished tasks). `--errors` `` ('default =' `0`):: -no description available +Only list tasks with a status of ERROR. `--limit` ` (0 - N)` ('default =' `50`):: Only list this amount of tasks. +`--since` `` :: + +Only list tasks since this UNIX epoch. + `--source` `` ('default =' `archive`):: List archived, active or all tasks. @@ -206,15 +318,23 @@ List archived, active or all tasks. List tasks beginning from this offset. +`--statusfilter` `` :: + +List of Task States that should be returned. + `--typefilter` `` :: Only list tasks of this type (e.g., vzstart, vzdump). +`--until` `` :: + +Only list tasks until this UNIX epoch. + `--userfilter` `` :: Only list tasks from this user. -`--vmid` ` (1 - N)` :: +`--vmid` ` (100 - 999999999)` :: Only list tasks for this VM. @@ -224,11 +344,15 @@ Read task log. ``: `` :: -no description available +The task's unique ID. + +`--download` `` :: + +Whether the tasklog file should be downloaded. This parameter can't be used in conjunction with other parameters `--start` ` (0 - N)` ('default =' `0`):: -no description available +Start at this line when reading the tasklog *pvenode task status* `` `[FORMAT_OPTIONS]` @@ -236,7 +360,7 @@ Read task status. ``: `` :: -no description available +The task's unique ID. *pvenode wakeonlan* ``