proxmox-mirrors/pve-docs
1
0
Fork 0
mirror of https://git.proxmox.com/git/pve-docs synced 2025-04-30 14:56:29 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

update static/schema information

Browse Source 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This commit is contained in:
Thomas Lamprecht 2025-04-09 08:53:50 +02:00
parent 907860602f
commit 46601a3245
4 changed files with 16 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
api-viewer/apidata.js
View File

@ -20746,12 +20746,6 @@ const apiSchema = [
"description" : "Enable support for extended attributes for this mount.", "description" : "Enable support for extended attributes for this mount.",
"optional" : 1, "optional" : 1,
"type" : "boolean" "type" : "boolean"
},
"writeback" : {
"default" : 0,
"description" : "Enable writeback cache. If enabled, writes may be cached in the guest until the file is closed or an fsync is performed.",
"optional" : 1,
"type" : "boolean"
} }
}, },
"optional" : 1, "optional" : 1,
@ -23248,17 +23242,11 @@ const apiSchema = [
"description" : "Enable support for extended attributes for this mount.", "description" : "Enable support for extended attributes for this mount.",
"optional" : 1, "optional" : 1,
"type" : "boolean" "type" : "boolean"
},
"writeback" : {
"default" : 0,
"description" : "Enable writeback cache. If enabled, writes may be cached in the guest until the file is closed or an fsync is performed.",
"optional" : 1,
"type" : "boolean"
} }
}, },
"optional" : 1, "optional" : 1,
"type" : "string", "type" : "string",
"typetext" : "[dirid=]<mapping-id> [,cache=<enum>] [,direct-io=<1|0>] [,expose-acl=<1|0>] [,expose-xattr=<1|0>] [,writeback=<1|0>]" "typetext" : "[dirid=]<mapping-id> [,cache=<enum>] [,direct-io=<1|0>] [,expose-acl=<1|0>] [,expose-xattr=<1|0>]"
}, },
"vmgenid" : { "vmgenid" : {
"default" : "1 (autogenerated)", "default" : "1 (autogenerated)",
@ -25768,17 +25756,11 @@ const apiSchema = [
"description" : "Enable support for extended attributes for this mount.", "description" : "Enable support for extended attributes for this mount.",
"optional" : 1, "optional" : 1,
"type" : "boolean" "type" : "boolean"
},
"writeback" : {
"default" : 0,
"description" : "Enable writeback cache. If enabled, writes may be cached in the guest until the file is closed or an fsync is performed.",
"optional" : 1,
"type" : "boolean"
} }
}, },
"optional" : 1, "optional" : 1,
"type" : "string", "type" : "string",
"typetext" : "[dirid=]<mapping-id> [,cache=<enum>] [,direct-io=<1|0>] [,expose-acl=<1|0>] [,expose-xattr=<1|0>] [,writeback=<1|0>]" "typetext" : "[dirid=]<mapping-id> [,cache=<enum>] [,direct-io=<1|0>] [,expose-acl=<1|0>] [,expose-xattr=<1|0>]"
}, },
"vmgenid" : { "vmgenid" : {
"default" : "1 (autogenerated)", "default" : "1 (autogenerated)",
@ -32146,17 +32128,11 @@ const apiSchema = [
"description" : "Enable support for extended attributes for this mount.", "description" : "Enable support for extended attributes for this mount.",
"optional" : 1, "optional" : 1,
"type" : "boolean" "type" : "boolean"
},
"writeback" : {
"default" : 0,
"description" : "Enable writeback cache. If enabled, writes may be cached in the guest until the file is closed or an fsync is performed.",
"optional" : 1,
"type" : "boolean"
} }
}, },
"optional" : 1, "optional" : 1,
"type" : "string", "type" : "string",
"typetext" : "[dirid=]<mapping-id> [,cache=<enum>] [,direct-io=<1|0>] [,expose-acl=<1|0>] [,expose-xattr=<1|0>] [,writeback=<1|0>]" "typetext" : "[dirid=]<mapping-id> [,cache=<enum>] [,direct-io=<1|0>] [,expose-acl=<1|0>] [,expose-xattr=<1|0>]"
}, },
"vmgenid" : { "vmgenid" : {
"default" : "1 (autogenerated)", "default" : "1 (autogenerated)",
@ -47213,7 +47189,7 @@ const apiSchema = [
"info" : { "info" : {
"POST" : { "POST" : {
"allowtoken" : 1, "allowtoken" : 1,
"description" : "Upload templates, ISO images and OVAs.", "description" : "Upload templates, ISO images, OVAs and VM images.",
"method" : "POST", "method" : "POST",
"name" : "upload", "name" : "upload",
"parameters" : { "parameters" : {
@ -47300,7 +47276,7 @@ const apiSchema = [
"info" : { "info" : {
"POST" : { "POST" : {
"allowtoken" : 1, "allowtoken" : 1,
"description" : "Download templates, ISO images and OVAs by using an URL.", "description" : "Download templates, ISO images, OVAs and VM images by using an URL.",
"method" : "POST", "method" : "POST",
"name" : "download_url", "name" : "download_url",
"parameters" : { "parameters" : {
@ -52514,8 +52490,8 @@ const apiSchema = [
"default" : "login", "default" : "login",
"description" : "Run specific command or default to login (requires 'root@pam')", "description" : "Run specific command or default to login (requires 'root@pam')",
"enum" : [ "enum" : [
"upgrade",
"ceph_install", "ceph_install",
"upgrade",
"login" "login"
], ],
"optional" : 1, "optional" : 1,
@ -52609,8 +52585,8 @@ const apiSchema = [
"default" : "login", "default" : "login",
"description" : "Run specific command or default to login (requires 'root@pam')", "description" : "Run specific command or default to login (requires 'root@pam')",
"enum" : [ "enum" : [
"upgrade",
"ceph_install", "ceph_install",
"upgrade",
"login" "login"
], ],
"optional" : 1, "optional" : 1,
@ -52734,8 +52710,8 @@ const apiSchema = [
"default" : "login", "default" : "login",
"description" : "Run specific command or default to login (requires 'root@pam')", "description" : "Run specific command or default to login (requires 'root@pam')",
"enum" : [ "enum" : [
"upgrade",
"ceph_install", "ceph_install",
"upgrade",
"login" "login"
], ],
"optional" : 1, "optional" : 1,
@ -56744,7 +56720,7 @@ const apiSchema = [
"description" : "OpenID claim used to retrieve groups with.", "description" : "OpenID claim used to retrieve groups with.",
"maxLength" : 256, "maxLength" : 256,
"optional" : 1, "optional" : 1,
"pattern" : "(?^:A-Za-z0-9\\.\\-_)", "pattern" : "(?^:[A-Za-z0-9\\.\\-_]+)",
"type" : "string" "type" : "string"
}, },
"groups-overwrite" : { "groups-overwrite" : {
@ -57110,7 +57086,7 @@ const apiSchema = [
"description" : "OpenID claim used to retrieve groups with.", "description" : "OpenID claim used to retrieve groups with.",
"maxLength" : 256, "maxLength" : 256,
"optional" : 1, "optional" : 1,
"pattern" : "(?^:A-Za-z0-9\\.\\-_)", "pattern" : "(?^:[A-Za-z0-9\\.\\-_]+)",
"type" : "string" "type" : "string"
}, },
"groups-overwrite" : { "groups-overwrite" : {

4
pveum.1-synopsis.adoc
View File

@ -290,7 +290,7 @@ LDAP attribute representing a groups name. If not set or found, the first value
Automatically create groups if they do not exist. Automatically create groups if they do not exist.
`--groups-claim` `(?^:A-Za-z0-9\.\-_)` :: `--groups-claim` `(?^:[A-Za-z0-9\.\-_]+)` ::
OpenID claim used to retrieve groups with. OpenID claim used to retrieve groups with.
@ -482,7 +482,7 @@ LDAP attribute representing a groups name. If not set or found, the first value
Automatically create groups if they do not exist. Automatically create groups if they do not exist.
`--groups-claim` `(?^:A-Za-z0-9\.\-_)` :: `--groups-claim` `(?^:[A-Za-z0-9\.\-_]+)` ::
OpenID claim used to retrieve groups with. OpenID claim used to retrieve groups with.

6
qm.1-synopsis.adoc
View File

@ -473,7 +473,7 @@ 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. 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>]` :: `--virtiofs[n]` `[dirid=]<mapping-id> [,cache=<enum>] [,direct-io=<1|0>] [,expose-acl=<1|0>] [,expose-xattr=<1|0>]` ::
Configuration for sharing a directory between host and guest using Virtio-fs. Configuration for sharing a directory between host and guest using Virtio-fs.
@ -1068,7 +1068,7 @@ Configure the VGA hardware.
Use volume as VIRTIO hard disk (n is 0 to 15). 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>]` :: `--virtiofs[n]` `[dirid=]<mapping-id> [,cache=<enum>] [,direct-io=<1|0>] [,expose-acl=<1|0>] [,expose-xattr=<1|0>]` ::
Configuration for sharing a directory between host and guest using Virtio-fs. Configuration for sharing a directory between host and guest using Virtio-fs.
@ -1664,7 +1664,7 @@ 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. 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>]` :: `--virtiofs[n]` `[dirid=]<mapping-id> [,cache=<enum>] [,direct-io=<1|0>] [,expose-acl=<1|0>] [,expose-xattr=<1|0>]` ::
Configuration for sharing a directory between host and guest using Virtio-fs. Configuration for sharing a directory between host and guest using Virtio-fs.

6
qm.conf.5-opts.adoc
View File

@ -1458,7 +1458,7 @@ Force disk geometry bios translation mode.
Write error action. 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>]` :: `virtiofs[n]`: `[dirid=]<mapping-id> [,cache=<enum>] [,direct-io=<1|0>] [,expose-acl=<1|0>] [,expose-xattr=<1|0>]` ::
Configuration for sharing a directory between host and guest using Virtio-fs. Configuration for sharing a directory between host and guest using Virtio-fs.
@ -1482,10 +1482,6 @@ Enable support for POSIX ACLs (enabled ACL implies xattr) for this mount.
Enable support for extended attributes for this mount. 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)`):: `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. 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.