Skip to content

Commit 5ba4bee

Browse files
update static/schema information
Signed-off-by: Thomas Lamprecht <[email protected]>
1 parent acc3795 commit 5ba4bee

8 files changed

+845
-177
lines changed

api-viewer/apidata.js

Lines changed: 724 additions & 148 deletions
Large diffs are not rendered by default.

datacenter.cfg.5-opts.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,10 @@ bandwidth limit in KiB/s for moving disks
2222

2323
bandwidth limit in KiB/s for restoring guests from backups
2424

25+
`consent-text`: `<string>` ::
26+
27+
Consent text that is displayed before logging in.
28+
2529
`console`: `<applet | html5 | vv | xtermjs>` ::
2630

2731
Select the default Console viewer. You can either use the builtin java applet (VNC; deprecated and maps to html5), an external virt-viewer comtatible application (SPICE), an HTML5 based vnc viewer (noVNC), or an HTML5 based console client (xtermjs). If the selected viewer is not available (e.g. SPICE not activated for the VM), the fallback is noVNC.

pveceph.1-synopsis.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Create a Ceph filesystem
4040

4141
Configure the created CephFS as storage for this cluster.
4242

43-
`--name` `<string>` ('default =' `cephfs`)::
43+
`--name` `(?^:^[^:/\s]+$)` ('default =' `cephfs`)::
4444

4545
The ceph filesystem name.
4646

@@ -255,7 +255,7 @@ Print verbose information, same as json-pretty output format.
255255

256256
Create Ceph pool
257257

258-
`<name>`: `<string>` ::
258+
`<name>`: `(?^:^[^:/\s]+$)` ::
259259

260260
The name of the pool. It must be unique.
261261

@@ -344,7 +344,7 @@ endpoints).
344344

345345
Change POOL settings
346346

347-
`<name>`: `<string>` ::
347+
`<name>`: `(?^:^[^:/\s]+$)` ::
348348

349349
The name of the pool. It must be unique.
350350

pvenode.1-synopsis.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ Restart pveproxy.
197197

198198
Get node configuration options.
199199

200-
`--property` `<acme | acmedomain0 | acmedomain1 | acmedomain2 | acmedomain3 | acmedomain4 | acmedomain5 | description | startall-onboot-delay | wakeonlan>` ('default =' `all`)::
200+
`--property` `<acme | acmedomain0 | acmedomain1 | acmedomain2 | acmedomain3 | acmedomain4 | acmedomain5 | ballooning-target | description | startall-onboot-delay | wakeonlan>` ('default =' `all`)::
201201

202202
Return only a specific property from the node configuration.
203203

@@ -213,6 +213,10 @@ Node specific ACME settings.
213213

214214
ACME domain and validation plugin
215215

216+
`--ballooning-target` `<integer> (0 - 100)` ('default =' `80`)::
217+
218+
RAM usage target for ballooning (in percent of total memory)
219+
216220
`--delete` `<string>` ::
217221

218222
A list of settings you want to delete.

pvesm.1-synopsis.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ NFS export path.
8282

8383
Certificate SHA 256 fingerprint.
8484

85-
`--format` `<string>` ::
85+
`--format` `<qcow2 | raw | subvol | vmdk>` ::
8686

8787
Default image format.
8888

@@ -276,9 +276,9 @@ The name of the file to create.
276276

277277
Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and 'G' (gigabyte, 1024M)
278278

279-
`--format` `<qcow2 | raw | subvol>` ::
279+
`--format` `<qcow2 | raw | subvol | vmdk>` ::
280280

281-
no description available
281+
Format of the image.
282282
+
283283
NOTE: Requires option(s): `size`
284284

@@ -650,7 +650,7 @@ Encryption key. Use 'autogen' to generate one automatically without passphrase.
650650

651651
Certificate SHA 256 fingerprint.
652652

653-
`--format` `<string>` ::
653+
`--format` `<qcow2 | raw | subvol | vmdk>` ::
654654

655655
Default image format.
656656

pveum.1-synopsis.adoc

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -286,6 +286,18 @@ LDAP filter for group sync.
286286

287287
LDAP attribute representing a groups name. If not set or found, the first value of the DN will be used as name.
288288

289+
`--groups-autocreate` `<boolean>` ('default =' `0`)::
290+
291+
Automatically create groups if they do not exist.
292+
293+
`--groups-claim` `(?^:A-Za-z0-9\.\-_)` ::
294+
295+
OpenID claim used to retrieve groups with.
296+
297+
`--groups-overwrite` `<boolean>` ('default =' `0`)::
298+
299+
All groups will be overwritten for the user on login.
300+
289301
`--issuer-url` `<string>` ::
290302

291303
OpenID Issuer Url
@@ -306,6 +318,10 @@ Server port.
306318

307319
Specifies whether the Authorization Server prompts the End-User for reauthentication and consent.
308320

321+
`--query-userinfo` `<boolean>` ('default =' `1`)::
322+
323+
Enables querying the userinfo endpoint for claims values.
324+
309325
`--scopes` `<string>` ('default =' `email profile`)::
310326

311327
Specifies the scopes (user details) that should be authorized and returned, for example 'email' or 'profile'.
@@ -462,6 +478,18 @@ LDAP filter for group sync.
462478

463479
LDAP attribute representing a groups name. If not set or found, the first value of the DN will be used as name.
464480

481+
`--groups-autocreate` `<boolean>` ('default =' `0`)::
482+
483+
Automatically create groups if they do not exist.
484+
485+
`--groups-claim` `(?^:A-Za-z0-9\.\-_)` ::
486+
487+
OpenID claim used to retrieve groups with.
488+
489+
`--groups-overwrite` `<boolean>` ('default =' `0`)::
490+
491+
All groups will be overwritten for the user on login.
492+
465493
`--issuer-url` `<string>` ::
466494

467495
OpenID Issuer Url
@@ -482,6 +510,10 @@ Server port.
482510

483511
Specifies whether the Authorization Server prompts the End-User for reauthentication and consent.
484512

513+
`--query-userinfo` `<boolean>` ('default =' `1`)::
514+
515+
Enables querying the userinfo endpoint for claims values.
516+
485517
`--scopes` `<string>` ('default =' `email profile`)::
486518

487519
Specifies the scopes (user details) that should be authorized and returned, for example 'email' or 'profile'.
@@ -554,7 +586,7 @@ DEPRECATED: use 'remove-vanished' instead. Remove ACLs for users or groups which
554586

555587
`--remove-vanished` `([acl];[properties];[entry])|none` ('default =' `none`)::
556588

557-
A semicolon-seperated list of things to remove when they or the user vanishes during a sync. The following values are possible: 'entry' removes the user/group when not returned from the sync. 'properties' removes the set properties on existing user/group that do not appear in the source (even custom ones). 'acl' removes acls when the user/group is not returned from the sync. Instead of a list it also can be 'none' (the default).
589+
A semicolon-separated list of things to remove when they or the user vanishes during a sync. The following values are possible: 'entry' removes the user/group when not returned from the sync. 'properties' removes the set properties on existing user/group that do not appear in the source (even custom ones). 'acl' removes acls when the user/group is not returned from the sync. Instead of a list it also can be 'none' (the default).
558590

559591
`--scope` `<both | groups | users>` ::
560592

@@ -644,7 +676,7 @@ NOTE: Requires option(s): `path`
644676

645677
`--realm` `<string>` ::
646678

647-
You can optionally pass the realm using this parameter. Normally the realm is simply added to the username <username>@<relam>.
679+
You can optionally pass the realm using this parameter. Normally the realm is simply added to the username <username>@<realm>.
648680

649681
`--tfa-challenge` `<string>` ::
650682

qm.1-synopsis.adoc

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ List of host cores used to execute guest processes, for example: 0,5,8-11
135135

136136
Enable/disable communication with the QEMU Guest Agent and its properties.
137137

138-
`--amd-sev` `[type=]<sev-type> [,kernel-hashes=<1|0>] [,no-debug=<1|0>] [,no-key-sharing=<1|0>]` ::
138+
`--amd-sev` `[type=]<sev-type> [,allow-smt=<1|0>] [,kernel-hashes=<1|0>] [,no-debug=<1|0>] [,no-key-sharing=<1|0>]` ::
139139

140140
Secure Encrypted Virtualization (SEV) features by AMD CPUs
141141

@@ -303,7 +303,7 @@ Set the real time clock (RTC) to local time. This is enabled by default if the `
303303

304304
Lock/unlock the VM.
305305

306-
`--machine` `[[type=]<machine type>] [,viommu=<intel|virtio>]` ::
306+
`--machine` `[[type=]<machine type>] [,enable-s3=<1|0>] [,enable-s4=<1|0>] [,viommu=<intel|virtio>]` ::
307307

308308
Specify the QEMU machine.
309309

@@ -473,6 +473,10 @@ Configure the VGA hardware.
473473

474474
Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume.
475475

476+
`--virtiofs[n]` `[dirid=]<mapping-id> [,cache=<enum>] [,direct-io=<1|0>] [,expose-acl=<1|0>] [,expose-xattr=<1|0>] [,writeback=<1|0>]` ::
477+
478+
Configuration for sharing a directory between host and guest using Virtio-fs.
479+
476480
`--vmgenid` `<UUID>` ('default =' `1 (autogenerated)`)::
477481

478482
Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly.
@@ -746,7 +750,7 @@ List of host cores used to execute guest processes, for example: 0,5,8-11
746750

747751
Enable/disable communication with the QEMU Guest Agent and its properties.
748752

749-
`--amd-sev` `[type=]<sev-type> [,kernel-hashes=<1|0>] [,no-debug=<1|0>] [,no-key-sharing=<1|0>]` ::
753+
`--amd-sev` `[type=]<sev-type> [,allow-smt=<1|0>] [,kernel-hashes=<1|0>] [,no-debug=<1|0>] [,no-key-sharing=<1|0>]` ::
750754

751755
Secure Encrypted Virtualization (SEV) features by AMD CPUs
752756

@@ -908,7 +912,7 @@ Set the real time clock (RTC) to local time. This is enabled by default if the `
908912

909913
Lock/unlock the VM.
910914

911-
`--machine` `[[type=]<machine type>] [,viommu=<intel|virtio>]` ::
915+
`--machine` `[[type=]<machine type>] [,enable-s3=<1|0>] [,enable-s4=<1|0>] [,viommu=<intel|virtio>]` ::
912916

913917
Specify the QEMU machine.
914918

@@ -1064,6 +1068,10 @@ Configure the VGA hardware.
10641068

10651069
Use volume as VIRTIO hard disk (n is 0 to 15).
10661070

1071+
`--virtiofs[n]` `[dirid=]<mapping-id> [,cache=<enum>] [,direct-io=<1|0>] [,expose-acl=<1|0>] [,expose-xattr=<1|0>] [,writeback=<1|0>]` ::
1072+
1073+
Configuration for sharing a directory between host and guest using Virtio-fs.
1074+
10671075
`--vmgenid` `<UUID>` ('default =' `1 (autogenerated)`)::
10681076

10691077
Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly.
@@ -1336,7 +1344,7 @@ List of host cores used to execute guest processes, for example: 0,5,8-11
13361344

13371345
Enable/disable communication with the QEMU Guest Agent and its properties.
13381346

1339-
`--amd-sev` `[type=]<sev-type> [,kernel-hashes=<1|0>] [,no-debug=<1|0>] [,no-key-sharing=<1|0>]` ::
1347+
`--amd-sev` `[type=]<sev-type> [,allow-smt=<1|0>] [,kernel-hashes=<1|0>] [,no-debug=<1|0>] [,no-key-sharing=<1|0>]` ::
13401348

13411349
Secure Encrypted Virtualization (SEV) features by AMD CPUs
13421350

@@ -1496,7 +1504,7 @@ Set the real time clock (RTC) to local time. This is enabled by default if the `
14961504

14971505
Lock/unlock the VM.
14981506

1499-
`--machine` `[[type=]<machine type>] [,viommu=<intel|virtio>]` ::
1507+
`--machine` `[[type=]<machine type>] [,enable-s3=<1|0>] [,enable-s4=<1|0>] [,viommu=<intel|virtio>]` ::
15001508

15011509
Specify the QEMU machine.
15021510

@@ -1656,6 +1664,10 @@ Configure the VGA hardware.
16561664

16571665
Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume.
16581666

1667+
`--virtiofs[n]` `[dirid=]<mapping-id> [,cache=<enum>] [,direct-io=<1|0>] [,expose-acl=<1|0>] [,expose-xattr=<1|0>] [,writeback=<1|0>]` ::
1668+
1669+
Configuration for sharing a directory between host and guest using Virtio-fs.
1670+
16591671
`--vmgenid` `<UUID>` ('default =' `1 (autogenerated)`)::
16601672

16611673
Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly.
@@ -1742,7 +1754,7 @@ The (unique) ID of the VM.
17421754

17431755
Override QEMU's -cpu argument with the given string.
17441756

1745-
`--machine` `[[type=]<machine type>] [,viommu=<intel|virtio>]` ::
1757+
`--machine` `[[type=]<machine type>] [,enable-s3=<1|0>] [,enable-s4=<1|0>] [,viommu=<intel|virtio>]` ::
17461758

17471759
Specify the QEMU machine.
17481760

0 commit comments

Comments
 (0)