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

Get node configuration options.

*pvenode config set* `[OPTIONS]`

Set node configuration options.

`--acme` `domains=<domain[;domain;...]> [,account=<name>]` ::

Node specific ACME settings.

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

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

*pvenode startall* `[OPTIONS]`

Start all VMs and containers (when onboot=1).

`--force` `<boolean>` ::

force if onboot=0.

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

Only consider Guests with these IDs.

*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
	72	pvenode cert delete `[<restart>]`
	73
	74	DELETE custom certificate chain and key.
	75
76	`<restart>`: `<boolean>` ('default =' `0`)::
77
78	Restart pveproxy.
79
a3eeb58f	80	pvenode cert info `[FORMAT_OPTIONS]`
a99bdc62 FG	81
	82	Get information about node's certificates.
	83
a3eeb58f	84	pvenode cert set `<certificates> [<key>]` `[OPTIONS]` `[FORMAT_OPTIONS]`
a99bdc62 FG	85
	86	Upload or update custom certificate chain and key.
	87
	88	`<certificates>`: `<string>` ::
	89
	90	PEM encoded certificate (chain).
	91
	92	`<key>`: `<string>` ::
	93
	94	PEM encoded private key.
	95
	96	`--force` `<boolean>` ('default =' `0`)::
	97
	98	Overwrite existing custom or ACME certificate files.
	99
	100	`--restart` `<boolean>` ('default =' `0`)::
	101
	102	Restart pveproxy.
	103
	104	pvenode config get
	105
	106	Get node configuration options.
	107
	108	pvenode config set `[OPTIONS]`
	109
	110	Set node configuration options.
	111
	112	`--acme` `domains=<domain[;domain;...]> [,account=<name>]` ::
	113
	114	Node specific ACME settings.
	115
	116	`--delete` `<string>` ::
	117
	118	A list of settings you want to delete.
	119
	120	`--description` `<string>` ::
	121
	122	Node description/comment.
	123
	124	`--digest` `<string>` ::
	125
	126	Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
	127
5f26e15b TL	128	`--wakeonlan` `<string>` ::
	129
	130	MAC address for wake on LAN
	131
a99bdc62 FG	132	pvenode help `[OPTIONS]`
	133
	134	Get help about specified command.
	135
	136	`--extra-args` `<array>` ::
	137
	138	Shows help for a specific command
	139
	140	`--verbose` `<boolean>` ::
	141
	142	Verbose output format.
	143
5da3d723 TL	144	pvenode migrateall `<target>` `[OPTIONS]`
	145
	146	Migrate all VMs and Containers.
	147
	148	`<target>`: `<string>` ::
	149
	150	Target node.
	151
	152	`--maxworkers` `<integer> (1 - N)` ::
	153
	154	Maximal number of parallel migration job. If not set use 'max_workers' from datacenter.cfg, one of both must be set!
	155
	156	`--vms` `<string>` ::
	157
	158	Only consider Guests with these IDs.
	159
	160	pvenode startall `[OPTIONS]`
	161
	162	Start all VMs and containers (when onboot=1).
	163
	164	`--force` `<boolean>` ::
	165
	166	force if onboot=0.
	167
	168	`--vms` `<string>` ::
	169
	170	Only consider Guests with these IDs.
	171
	172	pvenode stopall `[OPTIONS]`
	173
	174	Stop all VMs and Containers.
	175
	176	`--vms` `<string>` ::
	177
	178	Only consider Guests with these IDs.
	179
a3eeb58f DM	180	pvenode task list `[OPTIONS]` `[FORMAT_OPTIONS]`
	181
	182	Read task list for one node (finished tasks).
	183
	184	`--errors` `<boolean>` ('default =' `0`)::
	185
	186	no description available
	187
	188	`--limit` `<integer> (0 - N)` ('default =' `50`)::
	189
	190	Only list this amount of tasks.
	191
5f26e15b TL	192	`--source` `<active \| all \| archive>` ('default =' `archive`)::
	193
	194	List archived, active or all tasks.
	195
a3eeb58f DM	196	`--start` `<integer> (0 - N)` ('default =' `0`)::
	197
	198	List tasks beginning from this offset.
	199
5f26e15b TL	200	`--typefilter` `<string>` ::
	201
	202	Only list tasks of this type (e.g., vzstart, vzdump).
	203
a3eeb58f DM	204	`--userfilter` `<string>` ::
	205
	206	Only list tasks from this user.
	207
	208	`--vmid` `<integer> (1 - N)` ::
	209
	210	Only list tasks for this VM.
	211
	212	pvenode task log `<upid>` `[OPTIONS]`
	213
	214	Read task log.
	215
	216	`<upid>`: `<string>` ::
	217
	218	no description available
	219
	220	`--start` `<integer> (0 - N)` ('default =' `0`)::
	221
	222	no description available
	223
	224	pvenode task status `<upid>` `[FORMAT_OPTIONS]`
	225
	226	Read task status.
	227
	228	`<upid>`: `<string>` ::
	229
	230	no description available
	231
5f26e15b TL	232	pvenode wakeonlan `<node>`
	233
	234	Try to wake a node via 'wake on LAN' network packet.
	235
	236	`<node>`: `<string>` ::
	237
	238	target node for wake on LAN packet
	239
a99bdc62	240