From 907e4bc32b66bfcdd3fe90c6098da041bb0f67f5 Mon Sep 17 00:00:00 2001 From: Thomas Lamprecht Date: Mon, 22 Apr 2024 13:15:46 +0200 Subject: [PATCH] update static/schema information Signed-off-by: Thomas Lamprecht --- api-viewer/apidata.js | 439 ++++++++++++++++++++++++++++-------- datacenter.cfg.5-opts.adoc | 21 +- pct.1-synopsis.adoc | 14 +- pve-firewall-host-opts.adoc | 4 + pveam.1-synopsis.adoc | 4 +- pvecm.1-synopsis.adoc | 4 + pvenode.1-synopsis.adoc | 4 +- pvesm.1-synopsis.adoc | 20 +- qm.1-synopsis.adoc | 48 ++-- qm.conf.5-opts.adoc | 12 +- qmrestore.1-synopsis.adoc | 2 +- vzdump.1-synopsis.adoc | 6 +- vzdump.conf.5-opts.adoc | 14 +- 13 files changed, 435 insertions(+), 157 deletions(-) diff --git a/api-viewer/apidata.js b/api-viewer/apidata.js index 6eb7cff..ffc3a1f 100644 --- a/api-viewer/apidata.js +++ b/api-viewer/apidata.js @@ -2127,7 +2127,8 @@ const apiSchema = [ "description" : "Type of the target.", "enum" : [ "sendmail", - "gotify" + "gotify", + "smtp" ], "type" : "string" } @@ -5568,6 +5569,13 @@ const apiSchema = [ "type" : "array", "typetext" : "" }, + "fleecing" : { + "description" : "Options for backup fleecing (VM only).", + "format" : "backup-fleecing", + "optional" : 1, + "type" : "string", + "typetext" : "[[enabled=]<1|0>] [,storage=]" + }, "id" : { "description" : "The job ID.", "maxLength" : 50, @@ -5772,9 +5780,10 @@ const apiSchema = [ "storage" : { "description" : "Store resulting file to this storage.", "format" : "pve-storage-id", + "format_description" : "storage ID", "optional" : 1, "type" : "string", - "typetext" : "" + "typetext" : "" }, "tmpdir" : { "description" : "Store temporary files to specified directory.", @@ -5938,6 +5947,13 @@ const apiSchema = [ "type" : "array", "typetext" : "" }, + "fleecing" : { + "description" : "Options for backup fleecing (VM only).", + "format" : "backup-fleecing", + "optional" : 1, + "type" : "string", + "typetext" : "[[enabled=]<1|0>] [,storage=]" + }, "id" : { "description" : "Job ID (will be autogenerated).", "format" : "pve-configid", @@ -6143,9 +6159,10 @@ const apiSchema = [ "storage" : { "description" : "Store resulting file to this storage.", "format" : "pve-storage-id", + "format_description" : "storage ID", "optional" : 1, "type" : "string", - "typetext" : "" + "typetext" : "" }, "tmpdir" : { "description" : "Store temporary files to specified directory.", @@ -9336,6 +9353,8 @@ const apiSchema = [ "typetext" : "" }, "mdev" : { + "default" : 0, + "description" : "Marks the device(s) as being capable of providing mediated devices.", "optional" : 1, "type" : "boolean", "typetext" : "" @@ -9503,6 +9522,8 @@ const apiSchema = [ "typetext" : "" }, "mdev" : { + "default" : 0, + "description" : "Marks the device(s) as being capable of providing mediated devices.", "optional" : 1, "type" : "boolean", "typetext" : "" @@ -12270,6 +12291,7 @@ const apiSchema = [ "storage" : { "description" : "The storage identifier (when type == storage).", "format" : "pve-storage-id", + "format_description" : "storage ID", "optional" : 1, "type" : "string" }, @@ -12651,19 +12673,17 @@ const apiSchema = [ "description" : "Cluster-wide notification settings.", "format" : { "fencing" : { - "default" : "always", - "description" : "Control if notifications about node fencing should be sent.", + "description" : "UNUSED - Use datacenter notification settings instead.", "enum" : [ "always", "never" ], "optional" : 1, - "type" : "string", - "verbose_description" : "Control if notifications about node fencing should be sent.\n* 'always' always send out notifications\n* 'never' never send out notifications.\nFor production systems, turning off node fencing notifications is notrecommended!\n" + "type" : "string" }, "package-updates" : { "default" : "auto", - "description" : "Control when the daily update job should send out notifications.", + "description" : "DEPRECATED: Use datacenter notification settings instead. Control when the daily update job should send out notifications.", "enum" : [ "auto", "always", @@ -12671,39 +12691,34 @@ const apiSchema = [ ], "optional" : 1, "type" : "string", - "verbose_description" : "Control how often the daily update job should send out notifications:\n* 'auto' daily for systems with a valid subscription, as those are assumed to be production-ready and thus should know about pending updates.\n* 'always' every update, if there are new pending updates.\n* 'never' never send a notification for new pending updates.\n" + "verbose_description" : "DEPRECATED: Use datacenter notification settings instead.\nControl how often the daily update job should send out notifications:\n* 'auto' daily for systems with a valid subscription, as those are assumed to be production-ready and thus should know about pending updates.\n* 'always' every update, if there are new pending updates.\n* 'never' never send a notification for new pending updates.\n" }, "replication" : { - "default" : "always", - "description" : "Control if notifications for replication failures should be sent.", + "description" : "UNUSED - Use datacenter notification settings instead.", "enum" : [ "always", "never" ], "optional" : 1, - "type" : "string", - "verbose_description" : "Control if notifications for replication failures should be sent.\n* 'always' always send out notifications\n* 'never' never send out notifications.\nFor production systems, turning off replication notifications is notrecommended!\n" + "type" : "string" }, "target-fencing" : { - "description" : "Control where notifications about fenced cluster nodes should be sent to.", + "description" : "UNUSED - Use datacenter notification settings instead.", "format_description" : "TARGET", "optional" : 1, - "type" : "string", - "verbose_description" : "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." + "type" : "string" }, "target-package-updates" : { - "description" : "Control where notifications about available updates should be sent to.", + "description" : "UNUSED - Use datacenter notification settings instead.", "format_description" : "TARGET", "optional" : 1, - "type" : "string", - "verbose_description" : "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." + "type" : "string" }, "target-replication" : { - "description" : "Control where notifications for failed storage replication jobs should be sent to.", + "description" : "UNUSED - Use datacenter notification settings instead.", "format_description" : "TARGET", "optional" : 1, - "type" : "string", - "verbose_description" : "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." + "type" : "string" } }, "optional" : 1, @@ -17218,10 +17233,28 @@ const apiSchema = [ "type" : "string" }, "machine" : { - "description" : "Specifies the QEMU machine type.", - "maxLength" : 40, + "description" : "Specify the QEMU machine.", + "format" : { + "type" : { + "default_key" : 1, + "description" : "Specifies the QEMU machine type.", + "format_description" : "machine type", + "maxLength" : 40, + "optional" : 1, + "pattern" : "(pc|pc(-i440fx)?-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|q35|pc-q35-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|virt(?:-\\d+(\\.\\d+)+)?(\\+pve\\d+)?)", + "type" : "string" + }, + "viommu" : { + "description" : "Enable and set guest vIOMMU variant (Intel vIOMMU needs q35 to be set as machine type).", + "enum" : [ + "intel", + "virtio" + ], + "optional" : 1, + "type" : "string" + } + }, "optional" : 1, - "pattern" : "(pc|pc(-i440fx)?-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|q35|pc-q35-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|virt(?:-\\d+(\\.\\d+)+)?(\\+pve\\d+)?)", "type" : "string" }, "memory" : { @@ -18777,6 +18810,7 @@ const apiSchema = [ "vmstatestorage" : { "description" : "Default storage for VM state volumes/files.", "format" : "pve-storage-id", + "format_description" : "storage ID", "optional" : 1, "type" : "string" }, @@ -19575,11 +19609,30 @@ const apiSchema = [ "type" : "string" }, "machine" : { - "description" : "Specifies the QEMU machine type.", - "maxLength" : 40, + "description" : "Specify the QEMU machine.", + "format" : { + "type" : { + "default_key" : 1, + "description" : "Specifies the QEMU machine type.", + "format_description" : "machine type", + "maxLength" : 40, + "optional" : 1, + "pattern" : "(pc|pc(-i440fx)?-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|q35|pc-q35-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|virt(?:-\\d+(\\.\\d+)+)?(\\+pve\\d+)?)", + "type" : "string" + }, + "viommu" : { + "description" : "Enable and set guest vIOMMU variant (Intel vIOMMU needs q35 to be set as machine type).", + "enum" : [ + "intel", + "virtio" + ], + "optional" : 1, + "type" : "string" + } + }, "optional" : 1, - "pattern" : "(pc|pc(-i440fx)?-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|q35|pc-q35-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|virt(?:-\\d+(\\.\\d+)+)?(\\+pve\\d+)?)", - "type" : "string" + "type" : "string", + "typetext" : "[[type=]] [,viommu=]" }, "memory" : { "description" : "Memory properties.", @@ -21220,9 +21273,10 @@ const apiSchema = [ "vmstatestorage" : { "description" : "Default storage for VM state volumes/files.", "format" : "pve-storage-id", + "format_description" : "storage ID", "optional" : 1, "type" : "string", - "typetext" : "" + "typetext" : "" }, "watchdog" : { "description" : "Create a virtual hardware watchdog device.", @@ -22035,11 +22089,30 @@ const apiSchema = [ "type" : "string" }, "machine" : { - "description" : "Specifies the QEMU machine type.", - "maxLength" : 40, + "description" : "Specify the QEMU machine.", + "format" : { + "type" : { + "default_key" : 1, + "description" : "Specifies the QEMU machine type.", + "format_description" : "machine type", + "maxLength" : 40, + "optional" : 1, + "pattern" : "(pc|pc(-i440fx)?-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|q35|pc-q35-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|virt(?:-\\d+(\\.\\d+)+)?(\\+pve\\d+)?)", + "type" : "string" + }, + "viommu" : { + "description" : "Enable and set guest vIOMMU variant (Intel vIOMMU needs q35 to be set as machine type).", + "enum" : [ + "intel", + "virtio" + ], + "optional" : 1, + "type" : "string" + } + }, "optional" : 1, - "pattern" : "(pc|pc(-i440fx)?-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|q35|pc-q35-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|virt(?:-\\d+(\\.\\d+)+)?(\\+pve\\d+)?)", - "type" : "string" + "type" : "string", + "typetext" : "[[type=]] [,viommu=]" }, "memory" : { "description" : "Memory properties.", @@ -23680,9 +23753,10 @@ const apiSchema = [ "vmstatestorage" : { "description" : "Default storage for VM state volumes/files.", "format" : "pve-storage-id", + "format_description" : "storage ID", "optional" : 1, "type" : "string", - "typetext" : "" + "typetext" : "" }, "watchdog" : { "description" : "Create a virtual hardware watchdog device.", @@ -24464,11 +24538,30 @@ const apiSchema = [ "typetext" : "" }, "machine" : { - "description" : "Specifies the QEMU machine type.", - "maxLength" : 40, + "description" : "Specify the QEMU machine.", + "format" : { + "type" : { + "default_key" : 1, + "description" : "Specifies the QEMU machine type.", + "format_description" : "machine type", + "maxLength" : 40, + "optional" : 1, + "pattern" : "(pc|pc(-i440fx)?-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|q35|pc-q35-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|virt(?:-\\d+(\\.\\d+)+)?(\\+pve\\d+)?)", + "type" : "string" + }, + "viommu" : { + "description" : "Enable and set guest vIOMMU variant (Intel vIOMMU needs q35 to be set as machine type).", + "enum" : [ + "intel", + "virtio" + ], + "optional" : 1, + "type" : "string" + } + }, "optional" : 1, - "pattern" : "(pc|pc(-i440fx)?-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|q35|pc-q35-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|virt(?:-\\d+(\\.\\d+)+)?(\\+pve\\d+)?)", - "type" : "string" + "type" : "string", + "typetext" : "[[type=]] [,viommu=]" }, "migratedfrom" : { "description" : "The cluster node name.", @@ -24561,7 +24654,7 @@ const apiSchema = [ "info" : { "POST" : { "allowtoken" : 1, - "description" : "Stop virtual machine. The qemu process will exit immediately. Thisis akin to pulling the power plug of a running computer and may damage the VM data", + "description" : "Stop virtual machine. The qemu process will exit immediately. This is akin to pulling the power plug of a running computer and may damage the VM data.", "method" : "POST", "name" : "vm_stop", "parameters" : { @@ -24587,6 +24680,13 @@ const apiSchema = [ "type" : "string", "typetext" : "" }, + "overrule-shutdown" : { + "default" : 0, + "description" : "Try to abort active 'qmshutdown' tasks before stopping.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, "skiplock" : { "description" : "Ignore locks - only root is allowed to use this option.", "optional" : 1, @@ -24686,7 +24786,7 @@ const apiSchema = [ "info" : { "POST" : { "allowtoken" : 1, - "description" : "Shutdown virtual machine. This is similar to pressing the power button on a physical machine.This will send an ACPI event for the guest OS, which should then proceed to a clean shutdown.", + "description" : "Shutdown virtual machine. This is similar to pressing the power button on a physical machine. This will send an ACPI event for the guest OS, which should then proceed to a clean shutdown.", "method" : "POST", "name" : "vm_shutdown", "parameters" : { @@ -24833,10 +24933,11 @@ const apiSchema = [ "statestorage" : { "description" : "The storage for the VM state", "format" : "pve-storage-id", + "format_description" : "storage ID", "optional" : 1, "requires" : "todisk", "type" : "string", - "typetext" : "" + "typetext" : "" }, "todisk" : { "default" : 0, @@ -25196,9 +25297,10 @@ const apiSchema = [ "storage" : { "description" : "Target storage for full clone.", "format" : "pve-storage-id", + "format_description" : "storage ID", "optional" : 1, "type" : "string", - "typetext" : "" + "typetext" : "" }, "target" : { "description" : "Target node. Only allowed if the original VM is on shared storage.", @@ -25632,9 +25734,10 @@ const apiSchema = [ "storage" : { "description" : "Target storage.", "format" : "pve-storage-id", + "format_description" : "storage ID", "optional" : 1, "type" : "string", - "typetext" : "" + "typetext" : "" }, "target-digest" : { "description" : "Prevent changes if the current config file of the target VM has a\"\n\t\t .\" different SHA1 digest. This can be used to detect concurrent modifications.", @@ -26228,7 +26331,7 @@ const apiSchema = [ "description" : "Remote target endpoint", "format" : "proxmox-remote", "type" : "string", - "typetext" : "apitoken= ,host=
[,fingerprint=] [,port=]" + "typetext" : "apitoken= ,host=
[,fingerprint=] [,port=]" }, "target-storage" : { "description" : "Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself.", @@ -28149,11 +28252,30 @@ const apiSchema = [ "type" : "string" }, "machine" : { - "description" : "Specifies the QEMU machine type.", - "maxLength" : 40, + "description" : "Specify the QEMU machine.", + "format" : { + "type" : { + "default_key" : 1, + "description" : "Specifies the QEMU machine type.", + "format_description" : "machine type", + "maxLength" : 40, + "optional" : 1, + "pattern" : "(pc|pc(-i440fx)?-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|q35|pc-q35-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|virt(?:-\\d+(\\.\\d+)+)?(\\+pve\\d+)?)", + "type" : "string" + }, + "viommu" : { + "description" : "Enable and set guest vIOMMU variant (Intel vIOMMU needs q35 to be set as machine type).", + "enum" : [ + "intel", + "virtio" + ], + "optional" : 1, + "type" : "string" + } + }, "optional" : 1, - "pattern" : "(pc|pc(-i440fx)?-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|q35|pc-q35-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|virt(?:-\\d+(\\.\\d+)+)?(\\+pve\\d+)?)", - "type" : "string" + "type" : "string", + "typetext" : "[[type=]] [,viommu=]" }, "memory" : { "description" : "Memory properties.", @@ -29282,9 +29404,10 @@ const apiSchema = [ "storage" : { "description" : "Default storage.", "format" : "pve-storage-id", + "format_description" : "storage ID", "optional" : 1, "type" : "string", - "typetext" : "" + "typetext" : "" }, "tablet" : { "default" : 1, @@ -29809,9 +29932,10 @@ const apiSchema = [ "vmstatestorage" : { "description" : "Default storage for VM state volumes/files.", "format" : "pve-storage-id", + "format_description" : "storage ID", "optional" : 1, "type" : "string", - "typetext" : "" + "typetext" : "" }, "watchdog" : { "description" : "Create a virtual hardware watchdog device.", @@ -31221,6 +31345,13 @@ const apiSchema = [ "type" : "string", "typetext" : "" }, + "overrule-shutdown" : { + "default" : 0, + "description" : "Try to abort active 'vzshutdown' tasks before stopping.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, "skiplock" : { "description" : "Ignore locks - only root is allowed to use this option.", "optional" : 1, @@ -34285,7 +34416,7 @@ const apiSchema = [ "description" : "Remote target endpoint", "format" : "proxmox-remote", "type" : "string", - "typetext" : "apitoken= ,host=
[,fingerprint=] [,port=]" + "typetext" : "apitoken= ,host=
[,fingerprint=] [,port=]" }, "target-storage" : { "description" : "Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself.", @@ -34612,9 +34743,10 @@ const apiSchema = [ "storage" : { "description" : "Target storage for full clone.", "format" : "pve-storage-id", + "format_description" : "storage ID", "optional" : 1, "type" : "string", - "typetext" : "" + "typetext" : "" }, "target" : { "description" : "Target node. Only allowed if the original VM is on shared storage.", @@ -35041,9 +35173,10 @@ const apiSchema = [ "storage" : { "description" : "Target Storage.", "format" : "pve-storage-id", + "format_description" : "storage ID", "optional" : 1, "type" : "string", - "typetext" : "" + "typetext" : "" }, "target-digest" : { "description" : "Prevent changes if current configuration file of the target \" .\n\t\t \"container has a different SHA1 digest. This can be used to prevent \" .\n\t\t \"concurrent modifications.", @@ -37175,9 +37308,10 @@ const apiSchema = [ "default" : "local", "description" : "Default Storage.", "format" : "pve-storage-id", + "format_description" : "storage ID", "optional" : 1, "type" : "string", - "typetext" : "" + "typetext" : "" }, "swap" : { "default" : 512, @@ -39945,9 +40079,10 @@ const apiSchema = [ "storage" : { "description" : "The storage identifier.", "format" : "pve-storage-id", + "format_description" : "storage ID", "optional" : 1, "type" : "string", - "typetext" : "" + "typetext" : "" } } }, @@ -40004,6 +40139,12 @@ const apiSchema = [ "optional" : 1, "type" : "array" }, + "fleecing" : { + "description" : "Options for backup fleecing (VM only).", + "format" : "backup-fleecing", + "optional" : 1, + "type" : "string" + }, "ionice" : { "default" : 7, "description" : "Set IO priority when using the BFQ scheduler. For snapshot and suspend mode backups of VMs, this only affects the compressor. A value of 8 means the idle priority is used, otherwise the best-effort priority is used with the specified value.", @@ -40162,6 +40303,7 @@ const apiSchema = [ "storage" : { "description" : "Store resulting file to this storage.", "format" : "pve-storage-id", + "format_description" : "storage ID", "optional" : 1, "type" : "string" }, @@ -40289,6 +40431,13 @@ const apiSchema = [ "type" : "array", "typetext" : "" }, + "fleecing" : { + "description" : "Options for backup fleecing (VM only).", + "format" : "backup-fleecing", + "optional" : 1, + "type" : "string", + "typetext" : "[[enabled=]<1|0>] [,storage=]" + }, "ionice" : { "default" : 7, "description" : "Set IO priority when using the BFQ scheduler. For snapshot and suspend mode backups of VMs, this only affects the compressor. A value of 8 means the idle priority is used, otherwise the best-effort priority is used with the specified value.", @@ -40471,9 +40620,10 @@ const apiSchema = [ "storage" : { "description" : "Store resulting file to this storage.", "format" : "pve-storage-id", + "format_description" : "storage ID", "optional" : 1, "type" : "string", - "typetext" : "" + "typetext" : "" }, "tmpdir" : { "description" : "Store temporary files to specified directory.", @@ -40498,7 +40648,7 @@ const apiSchema = [ } }, "permissions" : { - "description" : "The user needs 'VM.Backup' permissions on any VM, and 'Datastore.AllocateSpace' on the backup storage. The 'tmpdir', 'dumpdir' and 'script' parameters are restricted to the 'root@pam' user. The 'maxfiles' and 'prune-backups' settings require 'Datastore.Allocate' on the backup storage. The 'bwlimit', 'performance' and 'ionice' parameters require 'Sys.Modify' on '/'. ", + "description" : "The user needs 'VM.Backup' permissions on any VM, and 'Datastore.AllocateSpace' on the backup storage (and fleecing storage when fleecing is used). The 'tmpdir', 'dumpdir' and 'script' parameters are restricted to the 'root@pam' user. The 'maxfiles' and 'prune-backups' settings require 'Datastore.Allocate' on the backup storage. The 'bwlimit', 'performance' and 'ionice' parameters require 'Sys.Modify' on '/'.", "user" : "all" }, "protected" : 1, @@ -43287,8 +43437,9 @@ const apiSchema = [ "storage" : { "description" : "The storage identifier.", "format" : "pve-storage-id", + "format_description" : "storage ID", "type" : "string", - "typetext" : "" + "typetext" : "" }, "type" : { "description" : "Either 'qemu' or 'lxc'. Only consider backups for guests of this type.", @@ -43344,8 +43495,9 @@ const apiSchema = [ "storage" : { "description" : "The storage identifier.", "format" : "pve-storage-id", + "format_description" : "storage ID", "type" : "string", - "typetext" : "" + "typetext" : "" }, "type" : { "description" : "Either 'qemu' or 'lxc'. Only consider backups for guests of this type.", @@ -43451,9 +43603,10 @@ const apiSchema = [ "storage" : { "description" : "The storage identifier.", "format" : "pve-storage-id", + "format_description" : "storage ID", "optional" : 1, "type" : "string", - "typetext" : "" + "typetext" : "" }, "volume" : { "description" : "Volume identifier", @@ -43490,9 +43643,10 @@ const apiSchema = [ "storage" : { "description" : "The storage identifier.", "format" : "pve-storage-id", + "format_description" : "storage ID", "optional" : 1, "type" : "string", - "typetext" : "" + "typetext" : "" }, "volume" : { "description" : "Volume identifier", @@ -43558,9 +43712,10 @@ const apiSchema = [ "storage" : { "description" : "The storage identifier.", "format" : "pve-storage-id", + "format_description" : "storage ID", "optional" : 1, "type" : "string", - "typetext" : "" + "typetext" : "" }, "target" : { "description" : "Target volume identifier", @@ -43616,9 +43771,10 @@ const apiSchema = [ "storage" : { "description" : "The storage identifier.", "format" : "pve-storage-id", + "format_description" : "storage ID", "optional" : 1, "type" : "string", - "typetext" : "" + "typetext" : "" }, "volume" : { "description" : "Volume identifier", @@ -43668,8 +43824,9 @@ const apiSchema = [ "storage" : { "description" : "The storage identifier.", "format" : "pve-storage-id", + "format_description" : "storage ID", "type" : "string", - "typetext" : "" + "typetext" : "" }, "vmid" : { "description" : "Only list images for this VM", @@ -43813,8 +43970,9 @@ const apiSchema = [ "storage" : { "description" : "The storage identifier.", "format" : "pve-storage-id", + "format_description" : "storage ID", "type" : "string", - "typetext" : "" + "typetext" : "" }, "vmid" : { "description" : "Specify owner VM", @@ -43873,8 +44031,9 @@ const apiSchema = [ "storage" : { "description" : "The storage identifier.", "format" : "pve-storage-id", + "format_description" : "storage ID", "type" : "string", - "typetext" : "" + "typetext" : "" }, "volume" : { "description" : "Backup volume ID or name. Currently only PBS snapshots are supported.", @@ -43953,8 +44112,9 @@ const apiSchema = [ "storage" : { "description" : "The storage identifier.", "format" : "pve-storage-id", + "format_description" : "storage ID", "type" : "string", - "typetext" : "" + "typetext" : "" }, "tar" : { "default" : 0, @@ -44009,8 +44169,9 @@ const apiSchema = [ "storage" : { "description" : "The storage identifier.", "format" : "pve-storage-id", + "format_description" : "storage ID", "type" : "string", - "typetext" : "" + "typetext" : "" } } }, @@ -44071,8 +44232,9 @@ const apiSchema = [ "storage" : { "description" : "The storage identifier.", "format" : "pve-storage-id", + "format_description" : "storage ID", "type" : "string", - "typetext" : "" + "typetext" : "" }, "timeframe" : { "description" : "Specify the time frame you are interested in.", @@ -44143,8 +44305,9 @@ const apiSchema = [ "storage" : { "description" : "The storage identifier.", "format" : "pve-storage-id", + "format_description" : "storage ID", "type" : "string", - "typetext" : "" + "typetext" : "" }, "timeframe" : { "description" : "Specify the time frame you are interested in.", @@ -44241,8 +44404,9 @@ const apiSchema = [ "storage" : { "description" : "The storage identifier.", "format" : "pve-storage-id", + "format_description" : "storage ID", "type" : "string", - "typetext" : "" + "typetext" : "" }, "tmpfilename" : { "description" : "The source file name. This parameter is usually set by the REST handler. You can only overwrite it when connecting to the trusted port on localhost.", @@ -44333,8 +44497,9 @@ const apiSchema = [ "storage" : { "description" : "The storage identifier.", "format" : "pve-storage-id", + "format_description" : "storage ID", "type" : "string", - "typetext" : "" + "typetext" : "" }, "url" : { "description" : "The URL to download the file from.", @@ -44411,8 +44576,9 @@ const apiSchema = [ "storage" : { "description" : "The storage identifier.", "format" : "pve-storage-id", + "format_description" : "storage ID", "type" : "string", - "typetext" : "" + "typetext" : "" }, "volume" : { "description" : "Volume identifier for the guest archive/entry.", @@ -44523,8 +44689,9 @@ const apiSchema = [ "storage" : { "description" : "The storage identifier.", "format" : "pve-storage-id", + "format_description" : "storage ID", "type" : "string", - "typetext" : "" + "typetext" : "" } } }, @@ -44603,9 +44770,10 @@ const apiSchema = [ "storage" : { "description" : "Only list status for specified storage", "format" : "pve-storage-id", + "format_description" : "storage ID", "optional" : 1, "type" : "string", - "typetext" : "" + "typetext" : "" }, "target" : { "description" : "If target is different to 'node', we only lists shared storages which content is accessible on this 'node' and the specified 'target' node.", @@ -44654,6 +44822,7 @@ const apiSchema = [ "storage" : { "description" : "The storage identifier.", "format" : "pve-storage-id", + "format_description" : "storage ID", "type" : "string" }, "total" : { @@ -44726,8 +44895,9 @@ const apiSchema = [ "name" : { "description" : "The storage identifier.", "format" : "pve-storage-id", + "format_description" : "storage ID", "type" : "string", - "typetext" : "" + "typetext" : "" }, "node" : { "description" : "The cluster node name.", @@ -44867,8 +45037,9 @@ const apiSchema = [ "name" : { "description" : "The storage identifier.", "format" : "pve-storage-id", + "format_description" : "storage ID", "type" : "string", - "typetext" : "" + "typetext" : "" }, "node" : { "description" : "The cluster node name.", @@ -44928,8 +45099,9 @@ const apiSchema = [ "name" : { "description" : "The storage identifier.", "format" : "pve-storage-id", + "format_description" : "storage ID", "type" : "string", - "typetext" : "" + "typetext" : "" }, "node" : { "description" : "The cluster node name.", @@ -44940,8 +45112,9 @@ const apiSchema = [ "volume-group" : { "description" : "The storage identifier.", "format" : "pve-storage-id", + "format_description" : "storage ID", "type" : "string", - "typetext" : "" + "typetext" : "" } } }, @@ -45051,8 +45224,9 @@ const apiSchema = [ "name" : { "description" : "The storage identifier.", "format" : "pve-storage-id", + "format_description" : "storage ID", "type" : "string", - "typetext" : "" + "typetext" : "" }, "node" : { "description" : "The cluster node name.", @@ -45112,8 +45286,9 @@ const apiSchema = [ "name" : { "description" : "The storage identifier.", "format" : "pve-storage-id", + "format_description" : "storage ID", "type" : "string", - "typetext" : "" + "typetext" : "" }, "node" : { "description" : "The cluster node name.", @@ -45235,8 +45410,9 @@ const apiSchema = [ "name" : { "description" : "The storage identifier.", "format" : "pve-storage-id", + "format_description" : "storage ID", "type" : "string", - "typetext" : "" + "typetext" : "" }, "node" : { "description" : "The cluster node name.", @@ -45296,8 +45472,9 @@ const apiSchema = [ "name" : { "description" : "The storage identifier.", "format" : "pve-storage-id", + "format_description" : "storage ID", "type" : "string", - "typetext" : "" + "typetext" : "" }, "node" : { "description" : "The cluster node name.", @@ -45334,8 +45511,9 @@ const apiSchema = [ "name" : { "description" : "The storage identifier.", "format" : "pve-storage-id", + "format_description" : "storage ID", "type" : "string", - "typetext" : "" + "typetext" : "" }, "node" : { "description" : "The cluster node name.", @@ -45565,8 +45743,9 @@ const apiSchema = [ "name" : { "description" : "The storage identifier.", "format" : "pve-storage-id", + "format_description" : "storage ID", "type" : "string", - "typetext" : "" + "typetext" : "" }, "node" : { "description" : "The cluster node name.", @@ -47115,6 +47294,12 @@ const apiSchema = [ "optional" : 1, "type" : "integer" }, + "nftables" : { + "default" : 0, + "description" : "Enable nftables based firewall (tech preview)", + "optional" : 1, + "type" : "boolean" + }, "nosmurfs" : { "description" : "Enable SMURFS filter.", "optional" : 1, @@ -47294,6 +47479,13 @@ const apiSchema = [ "type" : "integer", "typetext" : " (30 - 60)" }, + "nftables" : { + "default" : 0, + "description" : "Enable nftables based firewall (tech preview)", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", @@ -48331,8 +48523,32 @@ const apiSchema = [ "type" : "integer" }, "wakeonlan" : { - "description" : "MAC address for wake on LAN", - "format" : "mac-addr", + "description" : "Node specific wake on LAN settings.", + "format" : { + "bind-interface" : { + "default" : "The interface carrying the default route", + "description" : "Bind to this interface when sending wake on LAN packet", + "format" : "pve-iface", + "format_description" : "bind interface", + "optional" : 1, + "type" : "string" + }, + "broadcast-address" : { + "default" : "255.255.255.255", + "description" : "IPv4 broadcast address to use when sending wake on LAN packet", + "format" : "ipv4", + "format_description" : "IPv4 broadcast address", + "optional" : 1, + "type" : "string" + }, + "mac" : { + "default_key" : 1, + "description" : "MAC address for wake on LAN", + "format" : "mac-addr", + "format_description" : "MAC address", + "type" : "string" + } + }, "optional" : 1, "type" : "string" } @@ -48438,11 +48654,35 @@ const apiSchema = [ "typetext" : " (0 - 300)" }, "wakeonlan" : { - "description" : "MAC address for wake on LAN", - "format" : "mac-addr", + "description" : "Node specific wake on LAN settings.", + "format" : { + "bind-interface" : { + "default" : "The interface carrying the default route", + "description" : "Bind to this interface when sending wake on LAN packet", + "format" : "pve-iface", + "format_description" : "bind interface", + "optional" : 1, + "type" : "string" + }, + "broadcast-address" : { + "default" : "255.255.255.255", + "description" : "IPv4 broadcast address to use when sending wake on LAN packet", + "format" : "ipv4", + "format_description" : "IPv4 broadcast address", + "optional" : 1, + "type" : "string" + }, + "mac" : { + "default_key" : 1, + "description" : "MAC address for wake on LAN", + "format" : "mac-addr", + "format_description" : "MAC address", + "type" : "string" + } + }, "optional" : 1, "type" : "string", - "typetext" : "" + "typetext" : "[mac=] [,bind-interface=] [,broadcast-address=]" } } }, @@ -49827,8 +50067,9 @@ const apiSchema = [ "storage" : { "description" : "The storage where the template will be stored", "format" : "pve-storage-id", + "format_description" : "storage ID", "type" : "string", - "typetext" : "" + "typetext" : "" }, "template" : { "description" : "The template which will downloaded", @@ -50407,8 +50648,9 @@ const apiSchema = [ "storage" : { "description" : "The storage identifier.", "format" : "pve-storage-id", + "format_description" : "storage ID", "type" : "string", - "typetext" : "" + "typetext" : "" } } }, @@ -50437,8 +50679,9 @@ const apiSchema = [ "storage" : { "description" : "The storage identifier.", "format" : "pve-storage-id", + "format_description" : "storage ID", "type" : "string", - "typetext" : "" + "typetext" : "" } } }, @@ -50732,7 +50975,6 @@ const apiSchema = [ "typetext" : "" }, "port" : { - "default" : 8007, "description" : "For non default port.", "maximum" : 65535, "minimum" : 1, @@ -50822,8 +51064,9 @@ const apiSchema = [ "storage" : { "description" : "The storage identifier.", "format" : "pve-storage-id", + "format_description" : "storage ID", "type" : "string", - "typetext" : "" + "typetext" : "" }, "subdir" : { "description" : "Subdir to mount.", @@ -51273,7 +51516,6 @@ const apiSchema = [ "typetext" : "" }, "port" : { - "default" : 8007, "description" : "For non default port.", "maximum" : 65535, "minimum" : 1, @@ -51376,8 +51618,9 @@ const apiSchema = [ "storage" : { "description" : "The storage identifier.", "format" : "pve-storage-id", + "format_description" : "storage ID", "type" : "string", - "typetext" : "" + "typetext" : "" }, "subdir" : { "description" : "Subdir to mount.", diff --git a/datacenter.cfg.5-opts.adoc b/datacenter.cfg.5-opts.adoc index 4363451..473f906 100644 --- a/datacenter.cfg.5-opts.adoc +++ b/datacenter.cfg.5-opts.adoc @@ -117,38 +117,33 @@ Upper, exclusive boundary for free next-id API range. Cluster-wide notification settings. -`fencing`=`` ('default =' `always`);; +`fencing`=`` ;; -Control if notifications about node fencing should be sent. -* 'always' always send out notifications -* 'never' never send out notifications. -For production systems, turning off node fencing notifications is notrecommended! +UNUSED - Use datacenter notification settings instead. `package-updates`=`` ('default =' `auto`);; +DEPRECATED: Use datacenter notification settings instead. Control how often the daily update job should send out notifications: * 'auto' daily for systems with a valid subscription, as those are assumed to be production-ready and thus should know about pending updates. * 'always' every update, if there are new pending updates. * 'never' never send a notification for new pending updates. -`replication`=`` ('default =' `always`);; +`replication`=`` ;; -Control if notifications for replication failures should be sent. -* 'always' always send out notifications -* 'never' never send out notifications. -For production systems, turning off replication notifications is notrecommended! +UNUSED - Use datacenter notification settings instead. `target-fencing`=`` ;; -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. +UNUSED - Use datacenter notification settings instead. `target-package-updates`=`` ;; -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. +UNUSED - Use datacenter notification settings instead. `target-replication`=`` ;; -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. +UNUSED - Use datacenter notification settings instead. `registered-tags`: `[;...]` :: diff --git a/pct.1-synopsis.adoc b/pct.1-synopsis.adoc index 5096033..47e8304 100644 --- a/pct.1-synopsis.adoc +++ b/pct.1-synopsis.adoc @@ -36,7 +36,7 @@ Add the new CT to the specified pool. The name of the snapshot. -`--storage` `` :: +`--storage` `` :: Target storage for full clone. @@ -214,7 +214,7 @@ Start the CT after its creation finished successfully. Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped. -`--storage` `` ('default =' `local`):: +`--storage` `` ('default =' `local`):: Default Storage. @@ -432,7 +432,7 @@ The (unique) ID of the VM. Volume which will be moved. -``: `` :: +``: `` :: Target Storage. @@ -557,7 +557,7 @@ The (unique) ID of the VM. The (unique) ID of the VM. -``: `apitoken= ,host=
[,fingerprint=] [,port=]` :: +``: `apitoken= ,host=
[,fingerprint=] [,port=]` :: Remote target endpoint @@ -755,7 +755,7 @@ Start the CT after its creation finished successfully. Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped. -`--storage` `` ('default =' `local`):: +`--storage` `` ('default =' `local`):: Default Storage. @@ -1029,6 +1029,10 @@ container. The (unique) ID of the VM. +`--overrule-shutdown` `` ('default =' `0`):: + +Try to abort active 'vzshutdown' tasks before stopping. + `--skiplock` `` :: Ignore locks - only root is allowed to use this option. diff --git a/pve-firewall-host-opts.adoc b/pve-firewall-host-opts.adoc index 1dfcf5a..f9adbc5 100644 --- a/pve-firewall-host-opts.adoc +++ b/pve-firewall-host-opts.adoc @@ -38,6 +38,10 @@ Conntrack established timeout. Conntrack syn recv timeout. +`nftables`: `` ('default =' `0`):: + +Enable nftables based firewall (tech preview) + `nosmurfs`: `` :: Enable SMURFS filter. diff --git a/pveam.1-synopsis.adoc b/pveam.1-synopsis.adoc index feab465..36e559f 100644 --- a/pveam.1-synopsis.adoc +++ b/pveam.1-synopsis.adoc @@ -12,7 +12,7 @@ Restrict list to specified section. Download appliance templates. -``: `` :: +``: `` :: The storage where the template will be stored @@ -36,7 +36,7 @@ Verbose output format. Get list of all templates on storage -``: `` :: +``: `` :: Only list templates on specified storage diff --git a/pvecm.1-synopsis.adoc b/pvecm.1-synopsis.adoc index e0bdec2..ae3b202 100644 --- a/pvecm.1-synopsis.adoc +++ b/pvecm.1-synopsis.adoc @@ -185,4 +185,8 @@ Force generation of new SSL certificate. Ignore errors (i.e. when cluster has no quorum). +`--unmerge-known-hosts` `` ('default =' `0`):: + +Unmerge legacy SSH known hosts. + diff --git a/pvenode.1-synopsis.adoc b/pvenode.1-synopsis.adoc index 7f7085a..2c17e99 100644 --- a/pvenode.1-synopsis.adoc +++ b/pvenode.1-synopsis.adoc @@ -229,9 +229,9 @@ Prevent changes if current configuration file has different SHA1 digest. This ca Initial delay in seconds, before starting all the Virtual Guests with on-boot enabled. -`--wakeonlan` `` :: +`--wakeonlan` `[mac=] [,bind-interface=] [,broadcast-address=]` :: -MAC address for wake on LAN +Node specific wake on LAN settings. *pvenode help* `[OPTIONS]` diff --git a/pvesm.1-synopsis.adoc b/pvesm.1-synopsis.adoc index 7ad4249..e5f885f 100644 --- a/pvesm.1-synopsis.adoc +++ b/pvesm.1-synopsis.adoc @@ -8,7 +8,7 @@ Create a new storage. Storage type. -``: `` :: +``: `` :: The storage identifier. @@ -170,7 +170,7 @@ File system path. Pool. -`--port` ` (1 - 65535)` ('default =' `8007`):: +`--port` ` (1 - 65535)` :: For non default port. @@ -260,7 +260,7 @@ Glusterfs Volume. Allocate disk images. -``: `` :: +``: `` :: The storage identifier. @@ -342,7 +342,7 @@ Volume identifier Time to wait for the task to finish. We return 'null' if the task finish within that time. -`--storage` `` :: +`--storage` `` :: The storage identifier. @@ -406,7 +406,7 @@ An alias for 'pvesm scan iscsi'. List storage content. -``: `` :: +``: `` :: The storage identifier. @@ -444,7 +444,7 @@ Prune backups. Only those using the standard naming scheme are considered. If no keep options are specified, those from the storage configuration are used. -``: `` :: +``: `` :: The storage identifier. @@ -492,7 +492,7 @@ Only consider backups for this guest. Delete storage configuration. -``: `` :: +``: `` :: The storage identifier. @@ -584,7 +584,7 @@ Scan zfs pool list on local node. Update storage configuration. -``: `` :: +``: `` :: The storage identifier. @@ -730,7 +730,7 @@ Password for accessing the share/datastore. Pool. -`--port` ` (1 - 65535)` ('default =' `8007`):: +`--port` ` (1 - 65535)` :: For non default port. @@ -808,7 +808,7 @@ Only list stores which are enabled (not disabled in config). Include information about formats -`--storage` `` :: +`--storage` `` :: Only list status for specified storage diff --git a/qm.1-synopsis.adoc b/qm.1-synopsis.adoc index 089b32f..adc713e 100644 --- a/qm.1-synopsis.adoc +++ b/qm.1-synopsis.adoc @@ -61,7 +61,7 @@ Add the new VM to the specified pool. The name of the snapshot. -`--storage` `` :: +`--storage` `` :: Target storage for full clone. @@ -295,9 +295,9 @@ Set the real time clock (RTC) to local time. This is enabled by default if the ` Lock/unlock the VM. -`--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` :: +`--machine` `[[type=]] [,viommu=]` :: -Specifies the QEMU machine type. +Specify the QEMU machine. `--memory` `[current=]` :: @@ -415,7 +415,7 @@ Set the initial date of the real time clock. Valid format for date are:'now' or Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped. -`--storage` `` :: +`--storage` `` :: Default storage. @@ -469,7 +469,7 @@ Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly. -`--vmstatestorage` `` :: +`--vmstatestorage` `` :: Default storage for VM state volumes/files. @@ -527,7 +527,7 @@ The (unique) ID of the VM. Path to the disk image to import -``: `` :: +``: `` :: Target storage ID @@ -547,7 +547,7 @@ The (unique) ID of the VM. The disk you want to move. -``: `` :: +``: `` :: Target storage. @@ -892,9 +892,9 @@ Set the real time clock (RTC) to local time. This is enabled by default if the ` Lock/unlock the VM. -`--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` :: +`--machine` `[[type=]] [,viommu=]` :: -Specifies the QEMU machine type. +Specify the QEMU machine. `--memory` `[current=]` :: @@ -1004,7 +1004,7 @@ Set the initial date of the real time clock. Valid format for date are:'now' or Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped. -`--storage` `` :: +`--storage` `` :: Default storage. @@ -1052,7 +1052,7 @@ Use volume as VIRTIO hard disk (n is 0 to 15). Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly. -`--vmstatestorage` `` :: +`--vmstatestorage` `` :: Default storage for VM state volumes/files. @@ -1076,7 +1076,7 @@ The (unique) ID of the VM. path to the ovf file -``: `` :: +``: `` :: Target storage ID @@ -1206,7 +1206,7 @@ The (unique) ID of the VM. The (unique) ID of the VM. -``: `apitoken= ,host=
[,fingerprint=] [,port=]` :: +``: `apitoken= ,host=
[,fingerprint=] [,port=]` :: Remote target endpoint @@ -1476,9 +1476,9 @@ Set the real time clock (RTC) to local time. This is enabled by default if the ` Lock/unlock the VM. -`--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` :: +`--machine` `[[type=]] [,viommu=]` :: -Specifies the QEMU machine type. +Specify the QEMU machine. `--memory` `[current=]` :: @@ -1640,7 +1640,7 @@ Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly. -`--vmstatestorage` `` :: +`--vmstatestorage` `` :: Default storage for VM state volumes/files. @@ -1667,7 +1667,7 @@ Fetch config values from given snapshot. *qm shutdown* `` `[OPTIONS]` Shutdown virtual machine. This is similar to pressing the power button on a -physical machine.This will send an ACPI event for the guest OS, which +physical machine. This will send an ACPI event for the guest OS, which should then proceed to a clean shutdown. ``: ` (100 - 999999999)` :: @@ -1722,9 +1722,9 @@ The (unique) ID of the VM. Override QEMU's -cpu argument with the given string. -`--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` :: +`--machine` `[[type=]] [,viommu=]` :: -Specifies the QEMU machine type. +Specify the QEMU machine. `--migratedfrom` `` :: @@ -1768,8 +1768,8 @@ Verbose output format *qm stop* `` `[OPTIONS]` -Stop virtual machine. The qemu process will exit immediately. Thisis akin -to pulling the power plug of a running computer and may damage the VM data +Stop virtual machine. The qemu process will exit immediately. This is akin +to pulling the power plug of a running computer and may damage the VM data. ``: ` (100 - 999999999)` :: @@ -1783,6 +1783,10 @@ Do not deactivate storage volumes. The cluster node name. +`--overrule-shutdown` `` ('default =' `0`):: + +Try to abort active 'qmshutdown' tasks before stopping. + `--skiplock` `` :: Ignore locks - only root is allowed to use this option. @@ -1803,7 +1807,7 @@ The (unique) ID of the VM. Ignore locks - only root is allowed to use this option. -`--statestorage` `` :: +`--statestorage` `` :: The storage for the VM state + diff --git a/qm.conf.5-opts.adoc b/qm.conf.5-opts.adoc index 616d4ca..f0425c0 100644 --- a/qm.conf.5-opts.adoc +++ b/qm.conf.5-opts.adoc @@ -525,10 +525,18 @@ Set the real time clock (RTC) to local time. This is enabled by default if the ` Lock/unlock the VM. -`machine`: `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` :: +`machine`: `[[type=]] [,viommu=]` :: + +Specify the QEMU machine. + +`type`=`` ;; Specifies the QEMU machine type. +`viommu`=`` ;; + +Enable and set guest vIOMMU variant (Intel vIOMMU needs q35 to be set as machine type). + `memory`: `[current=]` :: Memory properties. @@ -1423,7 +1431,7 @@ Write error action. 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. Note that auto-creation only works when done through API/CLI create or update methods, but not when manually editing the config file. -`vmstatestorage`: `` :: +`vmstatestorage`: `` :: Default storage for VM state volumes/files. diff --git a/qmrestore.1-synopsis.adoc b/qmrestore.1-synopsis.adoc index 5d808b0..cf2792c 100644 --- a/qmrestore.1-synopsis.adoc +++ b/qmrestore.1-synopsis.adoc @@ -28,7 +28,7 @@ Start the VM immediately from the backup and restore in background. PBS only. Add the VM to the specified pool. -`--storage` `` :: +`--storage` `` :: Default storage. diff --git a/vzdump.1-synopsis.adoc b/vzdump.1-synopsis.adoc index dbed2b3..375d23a 100644 --- a/vzdump.1-synopsis.adoc +++ b/vzdump.1-synopsis.adoc @@ -32,6 +32,10 @@ Exclude specified guest systems (assumes --all) Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory. +`--fleecing` `[[enabled=]<1|0>] [,storage=]` :: + +Options for backup fleecing (VM only). + `--ionice` ` (0 - 8)` ('default =' `7`):: Set IO priority when using the BFQ scheduler. For snapshot and suspend mode backups of VMs, this only affects the compressor. A value of 8 means the idle priority is used, otherwise the best-effort priority is used with the specified value. @@ -128,7 +132,7 @@ Stop running backup jobs on this host. Maximal time to wait until a guest system is stopped (minutes). -`--storage` `` :: +`--storage` `` :: Store resulting file to this storage. diff --git a/vzdump.conf.5-opts.adoc b/vzdump.conf.5-opts.adoc index 3ef6e97..eef13d9 100644 --- a/vzdump.conf.5-opts.adoc +++ b/vzdump.conf.5-opts.adoc @@ -14,6 +14,18 @@ Store resulting files to specified directory. Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory. +`fleecing`: `[[enabled=]<1|0>] [,storage=]` :: + +Options for backup fleecing (VM only). + +`enabled`=`` ('default =' `0`);; + +Enable backup fleecing. Cache backup data from blocks where new guest writes happen on specified storage instead of copying them directly to the backup target. This can help guest IO performance and even prevent hangs, at the cost of requiring more storage space. + +`storage`=`` ;; + +Use this storage to storage fleecing images. For efficient space usage, it's best to use a local storage that supports discard and either thin provisioning or sparse files. + `ionice`: ` (0 - 8)` ('default =' `7`):: Set IO priority when using the BFQ scheduler. For snapshot and suspend mode backups of VMs, this only affects the compressor. A value of 8 means the idle priority is used, otherwise the best-effort priority is used with the specified value. @@ -130,7 +142,7 @@ Exclude temporary files and logs. Maximal time to wait until a guest system is stopped (minutes). -`storage`: `` :: +`storage`: `` :: Store resulting file to this storage.