update static/schema information

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This commit is contained in:
Thomas Lamprecht 2025-04-07 22:59:21 +02:00
parent acc3795eed
commit 5ba4beea55
8 changed files with 845 additions and 177 deletions

File diff suppressed because it is too large Load Diff

View File

@ -22,6 +22,10 @@ bandwidth limit in KiB/s for moving disks
bandwidth limit in KiB/s for restoring guests from backups
`consent-text`: `<string>` ::
Consent text that is displayed before logging in.
`console`: `<applet | html5 | vv | xtermjs>` ::
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.

View File

@ -40,7 +40,7 @@ Create a Ceph filesystem
Configure the created CephFS as storage for this cluster.
`--name` `<string>` ('default =' `cephfs`)::
`--name` `(?^:^[^:/\s]+$)` ('default =' `cephfs`)::
The ceph filesystem name.
@ -255,7 +255,7 @@ Print verbose information, same as json-pretty output format.
Create Ceph pool
`<name>`: `<string>` ::
`<name>`: `(?^:^[^:/\s]+$)` ::
The name of the pool. It must be unique.
@ -344,7 +344,7 @@ endpoints).
Change POOL settings
`<name>`: `<string>` ::
`<name>`: `(?^:^[^:/\s]+$)` ::
The name of the pool. It must be unique.

View File

@ -197,7 +197,7 @@ Restart pveproxy.
Get node configuration options.
`--property` `<acme | acmedomain0 | acmedomain1 | acmedomain2 | acmedomain3 | acmedomain4 | acmedomain5 | description | startall-onboot-delay | wakeonlan>` ('default =' `all`)::
`--property` `<acme | acmedomain0 | acmedomain1 | acmedomain2 | acmedomain3 | acmedomain4 | acmedomain5 | ballooning-target | description | startall-onboot-delay | wakeonlan>` ('default =' `all`)::
Return only a specific property from the node configuration.
@ -213,6 +213,10 @@ Node specific ACME settings.
ACME domain and validation plugin
`--ballooning-target` `<integer> (0 - 100)` ('default =' `80`)::
RAM usage target for ballooning (in percent of total memory)
`--delete` `<string>` ::
A list of settings you want to delete.

View File

@ -82,7 +82,7 @@ NFS export path.
Certificate SHA 256 fingerprint.
`--format` `<string>` ::
`--format` `<qcow2 | raw | subvol | vmdk>` ::
Default image format.
@ -276,9 +276,9 @@ The name of the file to create.
Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and 'G' (gigabyte, 1024M)
`--format` `<qcow2 | raw | subvol>` ::
`--format` `<qcow2 | raw | subvol | vmdk>` ::
no description available
Format of the image.
+
NOTE: Requires option(s): `size`
@ -650,7 +650,7 @@ Encryption key. Use 'autogen' to generate one automatically without passphrase.
Certificate SHA 256 fingerprint.
`--format` `<string>` ::
`--format` `<qcow2 | raw | subvol | vmdk>` ::
Default image format.

View File

@ -286,6 +286,18 @@ LDAP filter for group sync.
LDAP attribute representing a groups name. If not set or found, the first value of the DN will be used as name.
`--groups-autocreate` `<boolean>` ('default =' `0`)::
Automatically create groups if they do not exist.
`--groups-claim` `(?^:A-Za-z0-9\.\-_)` ::
OpenID claim used to retrieve groups with.
`--groups-overwrite` `<boolean>` ('default =' `0`)::
All groups will be overwritten for the user on login.
`--issuer-url` `<string>` ::
OpenID Issuer Url
@ -306,6 +318,10 @@ Server port.
Specifies whether the Authorization Server prompts the End-User for reauthentication and consent.
`--query-userinfo` `<boolean>` ('default =' `1`)::
Enables querying the userinfo endpoint for claims values.
`--scopes` `<string>` ('default =' `email profile`)::
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.
LDAP attribute representing a groups name. If not set or found, the first value of the DN will be used as name.
`--groups-autocreate` `<boolean>` ('default =' `0`)::
Automatically create groups if they do not exist.
`--groups-claim` `(?^:A-Za-z0-9\.\-_)` ::
OpenID claim used to retrieve groups with.
`--groups-overwrite` `<boolean>` ('default =' `0`)::
All groups will be overwritten for the user on login.
`--issuer-url` `<string>` ::
OpenID Issuer Url
@ -482,6 +510,10 @@ Server port.
Specifies whether the Authorization Server prompts the End-User for reauthentication and consent.
`--query-userinfo` `<boolean>` ('default =' `1`)::
Enables querying the userinfo endpoint for claims values.
`--scopes` `<string>` ('default =' `email profile`)::
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
`--remove-vanished` `([acl];[properties];[entry])|none` ('default =' `none`)::
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).
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).
`--scope` `<both | groups | users>` ::
@ -644,7 +676,7 @@ NOTE: Requires option(s): `path`
`--realm` `<string>` ::
You can optionally pass the realm using this parameter. Normally the realm is simply added to the username <username>@<relam>.
You can optionally pass the realm using this parameter. Normally the realm is simply added to the username <username>@<realm>.
`--tfa-challenge` `<string>` ::

View File

@ -135,7 +135,7 @@ List of host cores used to execute guest processes, for example: 0,5,8-11
Enable/disable communication with the QEMU Guest Agent and its properties.
`--amd-sev` `[type=]<sev-type> [,kernel-hashes=<1|0>] [,no-debug=<1|0>] [,no-key-sharing=<1|0>]` ::
`--amd-sev` `[type=]<sev-type> [,allow-smt=<1|0>] [,kernel-hashes=<1|0>] [,no-debug=<1|0>] [,no-key-sharing=<1|0>]` ::
Secure Encrypted Virtualization (SEV) features by AMD CPUs
@ -303,7 +303,7 @@ Set the real time clock (RTC) to local time. This is enabled by default if the `
Lock/unlock the VM.
`--machine` `[[type=]<machine type>] [,viommu=<intel|virtio>]` ::
`--machine` `[[type=]<machine type>] [,enable-s3=<1|0>] [,enable-s4=<1|0>] [,viommu=<intel|virtio>]` ::
Specify the QEMU machine.
@ -473,6 +473,10 @@ Configure the VGA hardware.
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.
`--virtiofs[n]` `[dirid=]<mapping-id> [,cache=<enum>] [,direct-io=<1|0>] [,expose-acl=<1|0>] [,expose-xattr=<1|0>] [,writeback=<1|0>]` ::
Configuration for sharing a directory between host and guest using Virtio-fs.
`--vmgenid` `<UUID>` ('default =' `1 (autogenerated)`)::
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
Enable/disable communication with the QEMU Guest Agent and its properties.
`--amd-sev` `[type=]<sev-type> [,kernel-hashes=<1|0>] [,no-debug=<1|0>] [,no-key-sharing=<1|0>]` ::
`--amd-sev` `[type=]<sev-type> [,allow-smt=<1|0>] [,kernel-hashes=<1|0>] [,no-debug=<1|0>] [,no-key-sharing=<1|0>]` ::
Secure Encrypted Virtualization (SEV) features by AMD CPUs
@ -908,7 +912,7 @@ Set the real time clock (RTC) to local time. This is enabled by default if the `
Lock/unlock the VM.
`--machine` `[[type=]<machine type>] [,viommu=<intel|virtio>]` ::
`--machine` `[[type=]<machine type>] [,enable-s3=<1|0>] [,enable-s4=<1|0>] [,viommu=<intel|virtio>]` ::
Specify the QEMU machine.
@ -1064,6 +1068,10 @@ Configure the VGA hardware.
Use volume as VIRTIO hard disk (n is 0 to 15).
`--virtiofs[n]` `[dirid=]<mapping-id> [,cache=<enum>] [,direct-io=<1|0>] [,expose-acl=<1|0>] [,expose-xattr=<1|0>] [,writeback=<1|0>]` ::
Configuration for sharing a directory between host and guest using Virtio-fs.
`--vmgenid` `<UUID>` ('default =' `1 (autogenerated)`)::
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
Enable/disable communication with the QEMU Guest Agent and its properties.
`--amd-sev` `[type=]<sev-type> [,kernel-hashes=<1|0>] [,no-debug=<1|0>] [,no-key-sharing=<1|0>]` ::
`--amd-sev` `[type=]<sev-type> [,allow-smt=<1|0>] [,kernel-hashes=<1|0>] [,no-debug=<1|0>] [,no-key-sharing=<1|0>]` ::
Secure Encrypted Virtualization (SEV) features by AMD CPUs
@ -1496,7 +1504,7 @@ Set the real time clock (RTC) to local time. This is enabled by default if the `
Lock/unlock the VM.
`--machine` `[[type=]<machine type>] [,viommu=<intel|virtio>]` ::
`--machine` `[[type=]<machine type>] [,enable-s3=<1|0>] [,enable-s4=<1|0>] [,viommu=<intel|virtio>]` ::
Specify the QEMU machine.
@ -1656,6 +1664,10 @@ Configure the VGA hardware.
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.
`--virtiofs[n]` `[dirid=]<mapping-id> [,cache=<enum>] [,direct-io=<1|0>] [,expose-acl=<1|0>] [,expose-xattr=<1|0>] [,writeback=<1|0>]` ::
Configuration for sharing a directory between host and guest using Virtio-fs.
`--vmgenid` `<UUID>` ('default =' `1 (autogenerated)`)::
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.
Override QEMU's -cpu argument with the given string.
`--machine` `[[type=]<machine type>] [,viommu=<intel|virtio>]` ::
`--machine` `[[type=]<machine type>] [,enable-s3=<1|0>] [,enable-s4=<1|0>] [,viommu=<intel|virtio>]` ::
Specify the QEMU machine.

View File

@ -26,25 +26,29 @@ Run fstrim after moving a disk or migrating the VM.
Select the agent type
`amd-sev`: `[type=]<sev-type> [,kernel-hashes=<1|0>] [,no-debug=<1|0>] [,no-key-sharing=<1|0>]` ::
`amd-sev`: `[type=]<sev-type> [,allow-smt=<1|0>] [,kernel-hashes=<1|0>] [,no-debug=<1|0>] [,no-key-sharing=<1|0>]` ::
Secure Encrypted Virtualization (SEV) features by AMD CPUs
`allow-smt`=`<boolean>` ('default =' `1`);;
Sets policy bit to allow Simultaneous Multi Threading (SMT) (Ignored unless for SEV-SNP)
`kernel-hashes`=`<boolean>` ('default =' `0`);;
Add kernel hashes to guest firmware for measured linux kernel launch
`no-debug`=`<boolean>` ('default =' `0`);;
Sets policy bit 0 to 1 to disallow debugging of guest
Sets policy bit to disallow debugging of guest
`no-key-sharing`=`<boolean>` ('default =' `0`);;
Sets policy bit 1 to 1 to disallow key sharing with other guests
Sets policy bit to disallow key sharing with other guests (Ignored for SEV-SNP)
`type`=`<sev-type>` ;;
Enable standard SEV with type='std' or enable experimental SEV-ES with the 'es' option.
Enable standard SEV with type='std' or enable experimental SEV-ES with the 'es' option or enable experimental SEV-SNP with the 'snp' option.
`arch`: `<aarch64 | x86_64>` ::
@ -207,7 +211,7 @@ Size and type of the OVMF EFI vars. '4m' is newer and recommended, and required
The drive's backing volume.
`format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
`format`=`<cloop | qcow | qcow2 | qed | raw | vmdk>` ;;
The drive's backing file's data format.
@ -357,7 +361,7 @@ Controls whether to pass discard/trim requests to the underlying storage.
The drive's backing volume.
`format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
`format`=`<cloop | qcow | qcow2 | qed | raw | vmdk>` ;;
The drive's backing file's data format.
@ -545,10 +549,18 @@ Set the real time clock (RTC) to local time. This is enabled by default if the `
Lock/unlock the VM.
`machine`: `[[type=]<machine type>] [,viommu=<intel|virtio>]` ::
`machine`: `[[type=]<machine type>] [,enable-s3=<1|0>] [,enable-s4=<1|0>] [,viommu=<intel|virtio>]` ::
Specify the QEMU machine.
`enable-s3`=`<boolean>` ;;
Enables S3 power state. Defaults to false beginning with machine types 9.2+pve1, true before.
`enable-s4`=`<boolean>` ;;
Enables S4 power state. Defaults to false beginning with machine types 9.2+pve1, true before.
`type`=`<machine type>` ;;
Specifies the QEMU machine type.
@ -707,7 +719,7 @@ Configure a VirtIO-based Random Number Generator.
`max_bytes`=`<integer>` ('default =' `1024`);;
Maximum bytes of entropy allowed to get injected into the guest every 'period' milliseconds. Prefer a lower value when using '/dev/random' as source. Use `0` to disable limiting (potentially dangerous!).
Maximum bytes of entropy allowed to get injected into the guest every 'period' milliseconds. Use `0` to disable limiting (potentially dangerous!).
`period`=`<integer>` ('default =' `1000`);;
@ -715,7 +727,7 @@ Every 'period' milliseconds the entropy-injection quota is reset, allowing the g
`source`=`</dev/hwrng | /dev/random | /dev/urandom>` ;;
The file on the host to gather entropy from. In most cases '/dev/urandom' should be preferred over '/dev/random' to avoid entropy-starvation issues on the host. Using urandom does *not* decrease security in any meaningful way, as it's still seeded from real entropy, and the bytes provided will most likely be mixed with real entropy on the guest as well. '/dev/hwrng' can be used to pass through a hardware RNG from the host.
The file on the host to gather entropy from. Using urandom does *not* decrease security in any meaningful way, as it's still seeded from real entropy, and the bytes provided will most likely be mixed with real entropy on the guest as well. '/dev/hwrng' can be used to pass through a hardware RNG from the host.
`sata[n]`: `[file=]<volume> [,aio=<native|threads|io_uring>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]` ::
@ -773,7 +785,7 @@ Controls whether to pass discard/trim requests to the underlying storage.
The drive's backing volume.
`format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
`format`=`<cloop | qcow | qcow2 | qed | raw | vmdk>` ;;
The drive's backing file's data format.
@ -947,7 +959,7 @@ Controls whether to pass discard/trim requests to the underlying storage.
The drive's backing volume.
`format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
`format`=`<cloop | qcow | qcow2 | qed | raw | vmdk>` ;;
The drive's backing file's data format.
@ -1328,7 +1340,7 @@ Controls whether to pass discard/trim requests to the underlying storage.
The drive's backing volume.
`format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
`format`=`<cloop | qcow | qcow2 | qed | raw | vmdk>` ;;
The drive's backing file's data format.
@ -1446,6 +1458,34 @@ Force disk geometry bios translation mode.
Write error action.
`virtiofs[n]`: `[dirid=]<mapping-id> [,cache=<enum>] [,direct-io=<1|0>] [,expose-acl=<1|0>] [,expose-xattr=<1|0>] [,writeback=<1|0>]` ::
Configuration for sharing a directory between host and guest using Virtio-fs.
`cache`=`<always | auto | metadata | never>` ('default =' `auto`);;
The caching policy the file system should use (auto, always, metadata, never).
`direct-io`=`<boolean>` ('default =' `0`);;
Honor the O_DIRECT flag passed down by guest applications.
`dirid`=`<mapping-id>` ;;
Mapping identifier of the directory mapping to be shared with the guest. Also used as a mount tag inside the VM.
`expose-acl`=`<boolean>` ('default =' `0`);;
Enable support for POSIX ACLs (enabled ACL implies xattr) for this mount.
`expose-xattr`=`<boolean>` ('default =' `0`);;
Enable support for extended attributes for this mount.
`writeback`=`<boolean>` ('default =' `0`);;
Enable writeback cache. If enabled, writes may be cached in the guest until the file is closed or an fsync is performed.
`vmgenid`: `<UUID>` ('default =' `1 (autogenerated)`)::
The VM generation ID (vmgenid) device exposes a 128-bit integer value identifier to the guest OS. This allows to notify the guest operating system when the virtual machine is executed with a different configuration (e.g. snapshot execution or creation from a template). The guest operating system notices the change, and is then able to react as appropriate by marking its copies of distributed databases as dirty, re-initializing its random number generator, etc.