[pve-docs.git] / pvenode.1-synopsis.adoc

*pvenode* `<COMMAND> [ARGS] [OPTIONS]`

*pvenode acme account deactivate* `[<name>]`

Deactivate existing ACME account at CA.

`<name>`: `<name>` ('default =' `default`)::

ACME account config file name.

*pvenode acme account info* `[<name>]` `[FORMAT_OPTIONS]`

Return existing ACME account information.

`<name>`: `<name>` ('default =' `default`)::

ACME account config file name.

*pvenode acme account list*

ACMEAccount index.

*pvenode acme account register* `[<name>] {<contact>}` `[OPTIONS]`

Register a new ACME account with a compatible CA.

`<name>`: `<name>` ('default =' `default`)::

ACME account config file name.

`<contact>`: `<string>` ::

Contact email addresses.

`--directory` `^https?://.*` ::

URL of ACME CA directory endpoint.

*pvenode acme account update* `[<name>]` `[OPTIONS]`

Update existing ACME account information with CA. Note: not specifying any
new account information triggers a refresh.

`<name>`: `<name>` ('default =' `default`)::

ACME account config file name.

`--contact` `<string>` ::

Contact email addresses.

*pvenode acme cert order* `[OPTIONS]`

Order a new certificate from ACME-compatible CA.

`--force` `<boolean>` ('default =' `0`)::

Overwrite existing custom certificate.

*pvenode acme cert renew* `[OPTIONS]`

Renew existing certificate from CA.

`--force` `<boolean>` ('default =' `0`)::

Force renewal even if expiry is more than 30 days away.

*pvenode acme cert revoke*

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` `<acmedns | acmeproxy | active24 | ad | ali | autodns | aws | azure | cf | clouddns | cloudns | cn | conoha | constellix | cx | cyon | da | ddnss | desec | df | dgon | dnsimple | do | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | euserv | exoscale | freedns | gandi_livedns | gcloud | gd | gdnsdk | he | hexonet | hostingde | infoblox | internetbs | inwx | ispconfig | jd | kas | kinghost | knot | leaseweb | lexicon | linode | linode_v4 | loopia | lua | maradns | me | miab | misaka | myapi | mydevil | mydnsjp | namecheap | namecom | namesilo | nederhost | neodigit | netcup | nic | nsd | nsone | nsupdate | nw | one | online | openprovider | opnsense | ovh | pdns | pleskxml | pointhq | rackspace | rcode0 | regru | schlundtech | selectel | servercow | tele3 | ultra | unoeuro | variomedia | vscale | vultr | yandex | 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` `<acmedns | acmeproxy | active24 | ad | ali | autodns | aws | azure | cf | clouddns | cloudns | cn | conoha | constellix | cx | cyon | da | ddnss | desec | df | dgon | dnsimple | do | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | euserv | exoscale | freedns | gandi_livedns | gcloud | gd | gdnsdk | he | hexonet | hostingde | infoblox | internetbs | inwx | ispconfig | jd | kas | kinghost | knot | leaseweb | lexicon | linode | linode_v4 | loopia | lua | maradns | me | miab | misaka | myapi | mydevil | mydnsjp | namecheap | namecom | namesilo | nederhost | neodigit | netcup | nic | nsd | nsone | nsupdate | nw | one | online | openprovider | opnsense | ovh | pdns | pleskxml | pointhq | rackspace | rcode0 | regru | schlundtech | selectel | servercow | tele3 | ultra | unoeuro | variomedia | vscale | vultr | yandex | 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 different SHA1 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>`: `<boolean>` ('default =' `0`)::

Restart pveproxy.

*pvenode cert info* `[FORMAT_OPTIONS]`

Get information about node's certificates.

*pvenode cert set* `<certificates> [<key>]` `[OPTIONS]` `[FORMAT_OPTIONS]`

Upload or update custom certificate chain and key.

`<certificates>`: `<string>` ::

PEM encoded certificate (chain).

`<key>`: `<string>` ::

PEM encoded private key.

`--force` `<boolean>` ('default =' `0`)::

Overwrite existing custom or ACME certificate files.

`--restart` `<boolean>` ('default =' `0`)::

Restart pveproxy.

*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` `[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.

`--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` `<string>` ::

MAC address for wake on LAN

*pvenode help* `[OPTIONS]`

Get help about specified command.

`--extra-args` `<array>` ::

Shows help for a specific command

`--verbose` `<boolean>` ::

Verbose output format.

*pvenode migrateall* `<target>` `[OPTIONS]`

Migrate all VMs and Containers.

`<target>`: `<string>` ::

Target node.

`--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!

`--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 located on this node (by default only those
with onboot=1).

`--force` `<boolean>` ('default =' `off`)::

Issue start command even if virtual guest have 'onboot' not set or set to off.

`--vms` `<string>` ::

Only consider guests from this comma separated list of VMIDs.

*pvenode stopall* `[OPTIONS]`

Stop all VMs and Containers.

`--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`)::

no description available

`--limit` `<integer> (0 - N)` ('default =' `50`)::

Only list this amount of tasks.

`--source` `<active | all | archive>` ('default =' `archive`)::

List archived, active or all tasks.

`--start` `<integer> (0 - N)` ('default =' `0`)::

List tasks beginning from this offset.

`--typefilter` `<string>` ::

Only list tasks of this type (e.g., vzstart, vzdump).

`--userfilter` `<string>` ::

Only list tasks from this user.

`--vmid` `<integer> (1 - N)` ::

Only list tasks for this VM.

*pvenode task log* `<upid>` `[OPTIONS]`

Read task log.

`<upid>`: `<string>` ::

no description available

`--start` `<integer> (0 - N)` ('default =' `0`)::

no description available

*pvenode task status* `<upid>` `[FORMAT_OPTIONS]`

Read task status.

`<upid>`: `<string>` ::

no description available

*pvenode wakeonlan* `<node>`

Try to wake a node via 'wake on LAN' network packet.

`<node>`: `<string>` ::

target node for wake on LAN packet
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
ac70d7d1	84	`--api` `<acmedns \| acmeproxy \| active24 \| ad \| ali \| autodns \| aws \| azure \| cf \| clouddns \| cloudns \| cn \| conoha \| constellix \| cx \| cyon \| da \| ddnss \| desec \| df \| dgon \| dnsimple \| do \| doapi \| domeneshop \| dp \| dpi \| dreamhost \| duckdns \| durabledns \| dyn \| dynu \| dynv6 \| easydns \| euserv \| exoscale \| freedns \| gandi_livedns \| gcloud \| gd \| gdnsdk \| he \| hexonet \| hostingde \| infoblox \| internetbs \| inwx \| ispconfig \| jd \| kas \| kinghost \| knot \| leaseweb \| lexicon \| linode \| linode_v4 \| loopia \| lua \| maradns \| me \| miab \| misaka \| myapi \| mydevil \| mydnsjp \| namecheap \| namecom \| namesilo \| nederhost \| neodigit \| netcup \| nic \| nsd \| nsone \| nsupdate \| nw \| one \| online \| openprovider \| opnsense \| ovh \| pdns \| pleskxml \| pointhq \| rackspace \| rcode0 \| regru \| schlundtech \| selectel \| servercow \| tele3 \| ultra \| unoeuro \| variomedia \| vscale \| vultr \| yandex \| 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
ac70d7d1	136	`--api` `<acmedns \| acmeproxy \| active24 \| ad \| ali \| autodns \| aws \| azure \| cf \| clouddns \| cloudns \| cn \| conoha \| constellix \| cx \| cyon \| da \| ddnss \| desec \| df \| dgon \| dnsimple \| do \| doapi \| domeneshop \| dp \| dpi \| dreamhost \| duckdns \| durabledns \| dyn \| dynu \| dynv6 \| easydns \| euserv \| exoscale \| freedns \| gandi_livedns \| gcloud \| gd \| gdnsdk \| he \| hexonet \| hostingde \| infoblox \| internetbs \| inwx \| ispconfig \| jd \| kas \| kinghost \| knot \| leaseweb \| lexicon \| linode \| linode_v4 \| loopia \| lua \| maradns \| me \| miab \| misaka \| myapi \| mydevil \| mydnsjp \| namecheap \| namecom \| namesilo \| nederhost \| neodigit \| netcup \| nic \| nsd \| nsone \| nsupdate \| nw \| one \| online \| openprovider \| opnsense \| ovh \| pdns \| pleskxml \| pointhq \| rackspace \| rcode0 \| regru \| schlundtech \| selectel \| servercow \| tele3 \| ultra \| unoeuro \| variomedia \| vscale \| vultr \| yandex \| 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
	222	Node description/comment.
	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
	258	Maximal number of parallel migration job. If not set use 'max_workers' from datacenter.cfg, one of both must be set!
	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]`
5da3d723 TL	269
1c532546 TL	270	Start all VMs and containers located on this node (by default only those
1c532546 TL	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
	285	`--vms` `<string>` ::
	286
	287	Only consider Guests with these IDs.
	288
a3eeb58f DM	289	pvenode task list `[OPTIONS]` `[FORMAT_OPTIONS]`
	290
	291	Read task list for one node (finished tasks).
	292
	293	`--errors` `<boolean>` ('default =' `0`)::
	294
	295	no description available
	296
	297	`--limit` `<integer> (0 - N)` ('default =' `50`)::
	298
	299	Only list this amount of tasks.
	300
5f26e15b TL	301	`--source` `<active \| all \| archive>` ('default =' `archive`)::
	302
	303	List archived, active or all tasks.
	304
a3eeb58f DM	305	`--start` `<integer> (0 - N)` ('default =' `0`)::
	306
	307	List tasks beginning from this offset.
	308
5f26e15b TL	309	`--typefilter` `<string>` ::
	310
	311	Only list tasks of this type (e.g., vzstart, vzdump).
	312
a3eeb58f DM	313	`--userfilter` `<string>` ::
	314
	315	Only list tasks from this user.
	316
	317	`--vmid` `<integer> (1 - N)` ::
	318
	319	Only list tasks for this VM.
	320
	321	pvenode task log `<upid>` `[OPTIONS]`
	322
	323	Read task log.
	324
	325	`<upid>`: `<string>` ::
	326
	327	no description available
	328
	329	`--start` `<integer> (0 - N)` ('default =' `0`)::
	330
	331	no description available
	332
	333	pvenode task status `<upid>` `[FORMAT_OPTIONS]`
	334
	335	Read task status.
	336
	337	`<upid>`: `<string>` ::
	338
	339	no description available
	340
5f26e15b TL	341	pvenode wakeonlan `<node>`
	342
	343	Try to wake a node via 'wake on LAN' network packet.
	344
	345	`<node>`: `<string>` ::
	346
	347	target node for wake on LAN packet
	348
a99bdc62	349