Skip to content

Commit 82551b2

Browse files
update static/schema information
Signed-off-by: Thomas Lamprecht <[email protected]>
1 parent 501744f commit 82551b2

10 files changed

+2452
-796
lines changed

api-viewer/apidata.js

Lines changed: 2369 additions & 771 deletions
Large diffs are not rendered by default.

datacenter.cfg.5-opts.adoc

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,17 +108,43 @@ Lower, inclusive boundary for free next-id API range.
108108

109109
Upper, exclusive boundary for free next-id API range.
110110

111-
`notify`: `package-updates=<auto|always|never>` ::
111+
`notify`: `[fencing=<always|never>] [,package-updates=<auto|always|never>] [,replication=<always|never>] [,target-fencing=<TARGET>] [,target-package-updates=<TARGET>] [,target-replication=<TARGET>]` ::
112112

113113
Cluster-wide notification settings.
114114

115+
`fencing`=`<always | never>` ('default =' `always`);;
116+
117+
Control if notifications about node fencing should be sent.
118+
* 'always' always send out notifications
119+
* 'never' never send out notifications.
120+
For production systems, turning off node fencing notifications is notrecommended!
121+
115122
`package-updates`=`<always | auto | never>` ('default =' `auto`);;
116123

117-
Control how often the daily update job should send out notification mails:
124+
Control how often the daily update job should send out notifications:
118125
* 'auto' daily for systems with a valid subscription, as those are assumed to be production-ready and thus should know about pending updates.
119126
* 'always' every update, if there are new pending updates.
120127
* 'never' never send a notification for new pending updates.
121128

129+
`replication`=`<always | never>` ('default =' `always`);;
130+
131+
Control if notifications for replication failures should be sent.
132+
* 'always' always send out notifications
133+
* 'never' never send out notifications.
134+
For production systems, turning off replication notifications is notrecommended!
135+
136+
`target-fencing`=`<TARGET>` ;;
137+
138+
Control where notifications about fenced cluster nodes should be sent to. Has to be the name of a notification target (endpoint or notification group). If the 'target-fencing' parameter is not set, the system will send mails to root via a 'sendmail' notification endpoint.
139+
140+
`target-package-updates`=`<TARGET>` ;;
141+
142+
Control where notifications about available updates should be sent to. Has to be the name of a notification target (endpoint or notification group). If the 'target-package-updates' parameter is not set, the system will send mails to root via a 'sendmail' notification endpoint.
143+
144+
`target-replication`=`<TARGET>` ;;
145+
146+
Control where notifications for failed storage replication jobs should be sent to. Has to be the name of a notification target (endpoint or notification group). If the 'target-replication' parameter is not set, the system will send mails to root via a 'sendmail' notification endpoint.
147+
122148
`registered-tags`: `<tag>[;<tag>...]` ::
123149

124150
A list of tags that require a `Sys.Modify` on '/' to set and delete. Tags set here that are also in 'user-tag-access' also require `Sys.Modify`.

ha-manager.1-synopsis.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ A list of settings you want to delete.
151151

152152
`--digest` `<string>` ::
153153

154-
Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
154+
Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.
155155

156156
`--nodes` `<node>[:<pri>]{,<node>[:<pri>]}*` ::
157157

@@ -211,7 +211,7 @@ A list of settings you want to delete.
211211

212212
`--digest` `<string>` ::
213213

214-
Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
214+
Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.
215215

216216
`--group` `<string>` ::
217217

pveceph.1-synopsis.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ Allow experimental versions. Use with care!
122122

123123
Ceph repository to use.
124124

125-
`--version` `<quincy>` ('default =' `quincy`)::
125+
`--version` `<quincy | reef>` ('default =' `quincy`)::
126126

127127
Ceph version to install.
128128

pvenode.1-synopsis.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ A list of settings you want to delete.
147147

148148
`--digest` `<string>` ::
149149

150-
Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
150+
Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.
151151

152152
`--disable` `<boolean>` ::
153153

pvesm.1-synopsis.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -628,7 +628,7 @@ A list of settings you want to delete.
628628

629629
`--digest` `<string>` ::
630630

631-
Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
631+
Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.
632632

633633
`--disable` `<boolean>` ::
634634

pvesr.1-synopsis.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ A list of settings you want to delete.
208208

209209
`--digest` `<string>` ::
210210

211-
Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
211+
Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.
212212

213213
`--disable` `<boolean>` ::
214214

pveum.1-synopsis.adoc

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -168,21 +168,25 @@ Update pool data.
168168

169169
no description available
170170

171+
`--allow-move` `<boolean>` ('default =' `0`)::
172+
173+
Allow adding a guest even if already in another pool. The guest will be removed from its current pool and added to this one.
174+
171175
`--comment` `<string>` ::
172176

173177
no description available
174178

175-
`--delete` `<boolean>` ::
179+
`--delete` `<boolean>` ('default =' `0`)::
176180

177-
Remove vms/storage (instead of adding it).
181+
Remove the passed VMIDs and/or storage IDs instead of adding them.
178182

179183
`--storage` `<string>` ::
180184

181-
List of storage IDs.
185+
List of storage IDs to add or remove from this pool.
182186

183187
`--vms` `<string>` ::
184188

185-
List of virtual machines.
189+
List of guest VMIDs to add or remove from this pool.
186190

187191
*pveum realm add* `<realm> --type <string>` `[OPTIONS]`
188192

@@ -200,11 +204,11 @@ Specifies the Authentication Context Class Reference values that theAuthorizatio
200204

201205
Automatically create users if they do not exist.
202206

203-
`--base_dn` `(?^:\w+=(?^:("[^"]+"|[^ ,+"/<>;=#][^,+"/<>;=]*[^ ,+"/<>;=]|[^ ,+"/<>;=#]))(,\s*\w+=(?^:("[^"]+"|[^ ,+"/<>;=#][^,+"/<>;=]*[^ ,+"/<>;=]|[^ ,+"/<>;=#])))*)` ::
207+
`--base_dn` `<string>` ::
204208

205209
LDAP base domain name
206210

207-
`--bind_dn` `(?^:\w+=(?^:("[^"]+"|[^ ,+"/<>;=#][^,+"/<>;=]*[^ ,+"/<>;=]|[^ ,+"/<>;=#]))(,\s*\w+=(?^:("[^"]+"|[^ ,+"/<>;=#][^,+"/<>;=]*[^ ,+"/<>;=]|[^ ,+"/<>;=#])))*)` ::
211+
`--bind_dn` `<string>` ::
208212

209213
LDAP bind domain name
210214

@@ -224,6 +228,10 @@ Path to the client certificate
224228

225229
Path to the client certificate key
226230

231+
`--check-connection` `<boolean>` ('default =' `0`)::
232+
233+
Check bind connection to the server.
234+
227235
`--client-id` `<string>` ::
228236

229237
OpenID Client ID
@@ -252,7 +260,7 @@ LDAP filter for user sync.
252260

253261
The objectclasses for groups.
254262

255-
`--group_dn` `(?^:\w+=(?^:("[^"]+"|[^ ,+"/<>;=#][^,+"/<>;=]*[^ ,+"/<>;=]|[^ ,+"/<>;=#]))(,\s*\w+=(?^:("[^"]+"|[^ ,+"/<>;=#][^,+"/<>;=]*[^ ,+"/<>;=]|[^ ,+"/<>;=#])))*)` ::
263+
`--group_dn` `<string>` ::
256264

257265
LDAP base domain name for group sync. If not set, the base_dn will be used.
258266

@@ -364,11 +372,11 @@ Specifies the Authentication Context Class Reference values that theAuthorizatio
364372

365373
Automatically create users if they do not exist.
366374

367-
`--base_dn` `(?^:\w+=(?^:("[^"]+"|[^ ,+"/<>;=#][^,+"/<>;=]*[^ ,+"/<>;=]|[^ ,+"/<>;=#]))(,\s*\w+=(?^:("[^"]+"|[^ ,+"/<>;=#][^,+"/<>;=]*[^ ,+"/<>;=]|[^ ,+"/<>;=#])))*)` ::
375+
`--base_dn` `<string>` ::
368376

369377
LDAP base domain name
370378

371-
`--bind_dn` `(?^:\w+=(?^:("[^"]+"|[^ ,+"/<>;=#][^,+"/<>;=]*[^ ,+"/<>;=]|[^ ,+"/<>;=#]))(,\s*\w+=(?^:("[^"]+"|[^ ,+"/<>;=#][^,+"/<>;=]*[^ ,+"/<>;=]|[^ ,+"/<>;=#])))*)` ::
379+
`--bind_dn` `<string>` ::
372380

373381
LDAP bind domain name
374382

@@ -388,6 +396,10 @@ Path to the client certificate
388396

389397
Path to the client certificate key
390398

399+
`--check-connection` `<boolean>` ('default =' `0`)::
400+
401+
Check bind connection to the server.
402+
391403
`--client-id` `<string>` ::
392404

393405
OpenID Client ID
@@ -410,7 +422,7 @@ A list of settings you want to delete.
410422

411423
`--digest` `<string>` ::
412424

413-
Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
425+
Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.
414426

415427
`--domain` `\S+` ::
416428

@@ -424,7 +436,7 @@ LDAP filter for user sync.
424436

425437
The objectclasses for groups.
426438

427-
`--group_dn` `(?^:\w+=(?^:("[^"]+"|[^ ,+"/<>;=#][^,+"/<>;=]*[^ ,+"/<>;=]|[^ ,+"/<>;=#]))(,\s*\w+=(?^:("[^"]+"|[^ ,+"/<>;=#][^,+"/<>;=]*[^ ,+"/<>;=]|[^ ,+"/<>;=#])))*)` ::
439+
`--group_dn` `<string>` ::
428440

429441
LDAP base domain name for group sync. If not set, the base_dn will be used.
430442

vzdump.1-synopsis.adoc

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,11 @@ Maximal time to wait for the global lock (minutes).
4242

4343
`--mailnotification` `<always | failure>` ('default =' `always`)::
4444

45-
Specify when to send an email
45+
Deprecated: use 'notification-policy' instead.
4646

4747
`--mailto` `<string>` ::
4848

49-
Comma-separated list of email addresses or users that should receive email notifications.
49+
Comma-separated list of email addresses or users that should receive email notifications. Has no effect if the 'notification-target' option is set at the same time.
5050

5151
`--maxfiles` `<integer> (1 - N)` ::
5252

@@ -66,7 +66,15 @@ Template string for generating notes for the backup(s). It can contain variables
6666
+
6767
NOTE: Requires option(s): `storage`
6868

69-
`--performance` `[max-workers=<integer>]` ::
69+
`--notification-policy` `<always | failure | never>` ('default =' `always`)::
70+
71+
Specify when to send a notification
72+
73+
`--notification-target` `<string>` ::
74+
75+
Determine the target to which notifications should be sent. Can either be a notification endpoint or a notification group. This option takes precedence over 'mailto', meaning that if both are set, the 'mailto' option will be ignored.
76+
77+
`--performance` `[max-workers=<integer>] [,pbs-entries-max=<integer>]` ::
7078

7179
Other performance-related settings.
7280

vzdump.conf.5-opts.adoc

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,11 @@ Maximal time to wait for the global lock (minutes).
2424

2525
`mailnotification`: `<always | failure>` ('default =' `always`)::
2626

27-
Specify when to send an email
27+
Deprecated: use 'notification-policy' instead.
2828

2929
`mailto`: `<string>` ::
3030

31-
Comma-separated list of email addresses or users that should receive email notifications.
31+
Comma-separated list of email addresses or users that should receive email notifications. Has no effect if the 'notification-target' option is set at the same time.
3232

3333
`maxfiles`: `<integer> (1 - N)` ::
3434

@@ -44,14 +44,26 @@ Template string for generating notes for the backup(s). It can contain variables
4444
+
4545
NOTE: Requires option(s): `storage`
4646

47-
`performance`: `[max-workers=<integer>]` ::
47+
`notification-policy`: `<always | failure | never>` ('default =' `always`)::
48+
49+
Specify when to send a notification
50+
51+
`notification-target`: `<string>` ::
52+
53+
Determine the target to which notifications should be sent. Can either be a notification endpoint or a notification group. This option takes precedence over 'mailto', meaning that if both are set, the 'mailto' option will be ignored.
54+
55+
`performance`: `[max-workers=<integer>] [,pbs-entries-max=<integer>]` ::
4856

4957
Other performance-related settings.
5058

5159
`max-workers`=`<integer> (1 - 256)` ('default =' `16`);;
5260

5361
Applies to VMs. Allow up to this many IO workers at the same time.
5462

63+
`pbs-entries-max`=`<integer> (1 - N)` ('default =' `1048576`);;
64+
65+
Applies to container backups sent to PBS. Limits the number of entries allowed in memory at a given time to avoid unintended OOM situations. Increase it to enable backups of containers with a large amount of files.
66+
5567
`pigz`: `<integer>` ('default =' `0`)::
5668

5769
Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count.

0 commit comments

Comments
 (0)