From 7af2edf96aacf8fe51bd7728a2457d7185b777b5 Mon Sep 17 00:00:00 2001 From: Thomas Lamprecht Date: Thu, 28 Apr 2022 21:24:22 +0200 Subject: [PATCH] update static/schema information Signed-off-by: Thomas Lamprecht --- api-viewer/apidata.js | 433 +++++++++++++++++++++++++++++++------ datacenter.cfg.5-opts.adoc | 12 + ha-resources-opts.adoc | 2 +- pct.1-synopsis.adoc | 6 +- pct.conf.5-opts.adoc | 2 +- pveceph.1-synopsis.adoc | 12 +- pvesm.1-synopsis.adoc | 8 + pveum.1-synopsis.adoc | 12 +- qm.1-synopsis.adoc | 60 ++--- qm.conf.5-opts.adoc | 38 +++- vzdump.1-synopsis.adoc | 12 + vzdump.conf.5-opts.adoc | 12 + 12 files changed, 488 insertions(+), 121 deletions(-) diff --git a/api-viewer/apidata.js b/api-viewer/apidata.js index 781c4c8..cbaba3a 100644 --- a/api-viewer/apidata.js +++ b/api-viewer/apidata.js @@ -3692,6 +3692,13 @@ const apiSchema = [ "type" : "string", "typetext" : "" }, + "notes-template" : { + "description" : "Template string for generating notes for the backup(s). It can contain variables which will be replaced by their values. Currently supported are {{cluster}}, {{guestname}}, {{node}}, and {{vmid}}, but more might be added in the future.", + "optional" : 1, + "requires" : "storage", + "type" : "string", + "typetext" : "" + }, "pigz" : { "default" : 0, "description" : "Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count.", @@ -3705,6 +3712,13 @@ const apiSchema = [ "type" : "string", "typetext" : "" }, + "protected" : { + "description" : "If true, mark backup(s) as protected.", + "optional" : 1, + "requires" : "storage", + "type" : "boolean", + "typetext" : "" + }, "prune-backups" : { "default" : "keep-all=1", "description" : "Use these retention options instead of those from the storage configuration.", @@ -4003,6 +4017,13 @@ const apiSchema = [ "type" : "string", "typetext" : "" }, + "notes-template" : { + "description" : "Template string for generating notes for the backup(s). It can contain variables which will be replaced by their values. Currently supported are {{cluster}}, {{guestname}}, {{node}}, and {{vmid}}, but more might be added in the future.", + "optional" : 1, + "requires" : "storage", + "type" : "string", + "typetext" : "" + }, "pigz" : { "default" : 0, "description" : "Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count.", @@ -4016,6 +4037,13 @@ const apiSchema = [ "type" : "string", "typetext" : "" }, + "protected" : { + "description" : "If true, mark backup(s) as protected.", + "optional" : 1, + "requires" : "storage", + "type" : "boolean", + "typetext" : "" + }, "prune-backups" : { "default" : "keep-all=1", "description" : "Use these retention options instead of those from the storage configuration.", @@ -6991,6 +7019,12 @@ const apiSchema = [ "type" : "string", "typetext" : "" }, + "bridge-disable-mac-learning" : { + "description" : "Disable auto mac learning.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, "controller" : { "description" : "Frr router name", "optional" : 1, @@ -7265,6 +7299,12 @@ const apiSchema = [ "type" : "string", "typetext" : "" }, + "bridge-disable-mac-learning" : { + "description" : "Disable auto mac learning.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, "controller" : { "description" : "Frr router name", "optional" : 1, @@ -8757,6 +8797,30 @@ const apiSchema = [ "type" : "boolean", "typetext" : "" }, + "next-id" : { + "description" : "Control the range for the free VMID auto-selection pool.", + "format" : { + "lower" : { + "default" : 100, + "description" : "Lower, inclusive boundary for free next-id API range.", + "max" : 999999999, + "min" : 100, + "optional" : 1, + "type" : "integer" + }, + "upper" : { + "default" : 1000000, + "description" : "Upper, inclusive boundary for free next-id API range.", + "max" : 999999999, + "min" : 100, + "optional" : 1, + "type" : "integer" + } + }, + "optional" : 1, + "type" : "string", + "typetext" : "[lower=] [,upper=]" + }, "u2f" : { "description" : "u2f", "format" : { @@ -12033,6 +12097,13 @@ const apiSchema = [ "type" : "string", "typetext" : "" }, + "encode" : { + "default" : 1, + "description" : "If set, the content will be encoded as base64 (required by QEMU).Otherwise the content needs to be encoded beforehand - defaults to true.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, "file" : { "description" : "The path to the file.", "type" : "string", @@ -12553,7 +12624,7 @@ const apiSchema = [ "default" : "cgroup v1: 1024, cgroup v2: 100", "description" : "CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2.", "maximum" : 262144, - "minimum" : 2, + "minimum" : 1, "optional" : 1, "type" : "integer", "verbose_description" : "CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to weights of all the other running VMs." @@ -12569,7 +12640,7 @@ const apiSchema = [ "type" : "string" }, "efidisk0" : { - "description" : "Configure a Disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead.", + "description" : "Configure a Disk for storing EFI vars.", "format" : { "efitype" : { "default" : "2m", @@ -12658,7 +12729,7 @@ const apiSchema = [ "type" : "string" }, "ide[n]" : { - "description" : "Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.", + "description" : "Use volume as IDE hard disk or CD-ROM (n is 0 to 3).", "format" : { "aio" : { "description" : "AIO type to use.", @@ -13015,7 +13086,7 @@ const apiSchema = [ }, "keyboard" : { "default" : null, - "description" : "Keyboard layout for VNC server. The default is read from the'/etc/pve/datacenter.cfg' configuration file. It should not be necessary to set it.", + "description" : "Keyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS.", "enum" : [ "de", "de-ch", @@ -13118,9 +13189,9 @@ const apiSchema = [ "format" : { "bridge" : { "description" : "Bridge to attach the network device to. The Proxmox VE standard bridge\nis called 'vmbr0'.\n\nIf you do not specify a bridge, we create a kvm user (NATed) network\ndevice, which provides DHCP and DNS services. The following addresses\nare used:\n\n 10.0.2.2 Gateway\n 10.0.2.3 DNS Server\n 10.0.2.4 SMB Server\n\nThe DHCP server assign addresses to the guest starting from 10.0.2.15.\n", + "format" : "pve-bridge-id", "format_description" : "bridge", "optional" : 1, - "pattern" : "[-_.\\w\\d]+", "type" : "string" }, "e1000" : { @@ -13373,7 +13444,7 @@ const apiSchema = [ "type" : "string" }, "sata[n]" : { - "description" : "Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.", + "description" : "Use volume as SATA hard disk or CD-ROM (n is 0 to 5).", "format" : { "aio" : { "description" : "AIO type to use.", @@ -13690,7 +13761,7 @@ const apiSchema = [ "type" : "string" }, "scsi[n]" : { - "description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.", + "description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 30).", "format" : { "aio" : { "description" : "AIO type to use.", @@ -14154,7 +14225,7 @@ const apiSchema = [ "type" : "boolean" }, "tpmstate0" : { - "description" : "Configure a Disk for storing TPM state. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default size of 4 MiB will always be used instead. The format is also fixed to 'raw'.", + "description" : "Configure a Disk for storing TPM state. The format is fixed to 'raw'.", "format" : { "file" : { "default_key" : 1, @@ -14258,6 +14329,7 @@ const apiSchema = [ "serial3", "std", "virtio", + "virtio-gl", "vmware" ], "optional" : 1, @@ -14269,7 +14341,7 @@ const apiSchema = [ "verbose_description" : "Configure the VGA Hardware. If you want to use high resolution modes (>= 1280x1024x16) you may need to increase the vga memory option. Since QEMU 2.9 the default VGA display type is 'std' for all OS types besides some Windows versions (XP and older) which use 'cirrus'. The 'qxl' option enables the SPICE display server. For win* OS you can select how many independent displays you want, Linux guests can add displays them self.\nYou can also run without any graphic card, using a serial device as terminal." }, "virtio[n]" : { - "description" : "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.", + "description" : "Use volume as VIRTIO hard disk (n is 0 to 15).", "format" : { "aio" : { "description" : "AIO type to use.", @@ -14808,10 +14880,10 @@ const apiSchema = [ "default" : "cgroup v1: 1024, cgroup v2: 100", "description" : "CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2.", "maximum" : 262144, - "minimum" : 2, + "minimum" : 1, "optional" : 1, "type" : "integer", - "typetext" : " (2 - 262144)", + "typetext" : " (1 - 262144)", "verbose_description" : "CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to weights of all the other running VMs." }, "delete" : { @@ -14836,7 +14908,7 @@ const apiSchema = [ "typetext" : "" }, "efidisk0" : { - "description" : "Configure a Disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead.", + "description" : "Configure a Disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume.", "format" : { "efitype" : { "default" : "2m", @@ -14869,6 +14941,13 @@ const apiSchema = [ "optional" : 1, "type" : "string" }, + "import-from" : { + "description" : "Create a new disk, importing from this source (volume ID or absolute path). When an absolute path is specified, it's up to you to ensure that the source is not actively used by another process during the import!", + "format" : "pve-volume-id-or-absolute-path", + "format_description" : "source volume", + "optional" : 1, + "type" : "string" + }, "pre-enrolled-keys" : { "default" : 0, "description" : "Use am EFI vars template with distribution-specific and Microsoft Standard keys enrolled, if used with 'efitype=4m'. Note that this will enable Secure Boot by default, though it can still be turned off from within the VM.", @@ -14888,7 +14967,7 @@ const apiSchema = [ }, "optional" : 1, "type" : "string", - "typetext" : "[file=] [,efitype=<2m|4m>] [,format=] [,pre-enrolled-keys=<1|0>] [,size=]" + "typetext" : "[file=] [,efitype=<2m|4m>] [,format=] [,import-from=] [,pre-enrolled-keys=<1|0>] [,size=]" }, "force" : { "description" : "Force physical removal. Without this, we simple remove the disk from the config file and create an additional configuration entry called 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause physical removal.", @@ -14915,7 +14994,7 @@ const apiSchema = [ "format" : "pve-qm-hostpci", "optional" : 1, "type" : "string", - "typetext" : "[host=] [,legacy-igd=<1|0>] [,mdev=] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=] [,x-vga=<1|0>]", + "typetext" : "[host=] [,device-id=] [,legacy-igd=<1|0>] [,mdev=] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=] [,sub-device-id=] [,sub-vendor-id=] [,vendor-id=] [,x-vga=<1|0>]", "verbose_description" : "Map host PCI devices into guest.\n\nNOTE: This option allows direct access to host hardware. So it is no longer\npossible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n" }, "hotplug" : { @@ -14937,7 +15016,7 @@ const apiSchema = [ "type" : "string" }, "ide[n]" : { - "description" : "Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.", + "description" : "Use volume as IDE hard disk or CD-ROM (n is 0 to 3). 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.", "format" : { "aio" : { "description" : "AIO type to use.", @@ -15056,6 +15135,13 @@ const apiSchema = [ "optional" : 1, "type" : "integer" }, + "import-from" : { + "description" : "Create a new disk, importing from this source (volume ID or absolute path). When an absolute path is specified, it's up to you to ensure that the source is not actively used by another process during the import!", + "format" : "pve-volume-id-or-absolute-path", + "format_description" : "source volume", + "optional" : 1, + "type" : "string" + }, "iops" : { "description" : "Maximum r/w I/O in operations per second.", "format_description" : "iops", @@ -15260,7 +15346,7 @@ const apiSchema = [ }, "optional" : 1, "type" : "string", - "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]" + "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,import-from=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]" }, "ipconfig[n]" : { "description" : "cloud-init: Specify IP addresses and gateways for the corresponding interface.\n\nIP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.\n\nThe special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit\ngateway should be provided.\nFor IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires\ncloud-init 19.4 or newer.\n\nIf cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using\ndhcp on IPv4.\n", @@ -15298,7 +15384,7 @@ const apiSchema = [ }, "keyboard" : { "default" : null, - "description" : "Keyboard layout for VNC server. The default is read from the'/etc/pve/datacenter.cfg' configuration file. It should not be necessary to set it.", + "description" : "Keyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS.", "enum" : [ "de", "de-ch", @@ -15408,9 +15494,9 @@ const apiSchema = [ "format" : { "bridge" : { "description" : "Bridge to attach the network device to. The Proxmox VE standard bridge\nis called 'vmbr0'.\n\nIf you do not specify a bridge, we create a kvm user (NATed) network\ndevice, which provides DHCP and DNS services. The following addresses\nare used:\n\n 10.0.2.2 Gateway\n 10.0.2.3 DNS Server\n 10.0.2.4 SMB Server\n\nThe DHCP server assign addresses to the guest starting from 10.0.2.15.\n", + "format" : "pve-bridge-id", "format_description" : "bridge", "optional" : 1, - "pattern" : "[-_.\\w\\d]+", "type" : "string" }, "e1000" : { @@ -15683,7 +15769,7 @@ const apiSchema = [ "typetext" : "[source=] [,max_bytes=] [,period=]" }, "sata[n]" : { - "description" : "Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.", + "description" : "Use volume as SATA hard disk or CD-ROM (n is 0 to 5). 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.", "format" : { "aio" : { "description" : "AIO type to use.", @@ -15802,6 +15888,13 @@ const apiSchema = [ "optional" : 1, "type" : "integer" }, + "import-from" : { + "description" : "Create a new disk, importing from this source (volume ID or absolute path). When an absolute path is specified, it's up to you to ensure that the source is not actively used by another process during the import!", + "format" : "pve-volume-id-or-absolute-path", + "format_description" : "source volume", + "optional" : 1, + "type" : "string" + }, "iops" : { "description" : "Maximum r/w I/O in operations per second.", "format_description" : "iops", @@ -15998,10 +16091,10 @@ const apiSchema = [ }, "optional" : 1, "type" : "string", - "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]" + "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,import-from=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]" }, "scsi[n]" : { - "description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.", + "description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). 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.", "format" : { "aio" : { "description" : "AIO type to use.", @@ -16120,6 +16213,13 @@ const apiSchema = [ "optional" : 1, "type" : "integer" }, + "import-from" : { + "description" : "Create a new disk, importing from this source (volume ID or absolute path). When an absolute path is specified, it's up to you to ensure that the source is not actively used by another process during the import!", + "format" : "pve-volume-id-or-absolute-path", + "format_description" : "source volume", + "optional" : 1, + "type" : "string" + }, "iops" : { "description" : "Maximum r/w I/O in operations per second.", "format_description" : "iops", @@ -16338,7 +16438,7 @@ const apiSchema = [ }, "optional" : 1, "type" : "string", - "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,replicate=<1|0>] [,rerror=] [,ro=<1|0>] [,scsiblock=<1|0>] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]" + "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,import-from=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,replicate=<1|0>] [,rerror=] [,ro=<1|0>] [,scsiblock=<1|0>] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]" }, "scsihw" : { "default" : "lsi", @@ -16483,7 +16583,7 @@ const apiSchema = [ "typetext" : "" }, "tpmstate0" : { - "description" : "Configure a Disk for storing TPM state. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default size of 4 MiB will always be used instead. The format is also fixed to 'raw'.", + "description" : "Configure a Disk for storing TPM state. The format is fixed to 'raw'. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and 4 MiB will be used instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume.", "format" : { "file" : { "default_key" : 1, @@ -16492,6 +16592,13 @@ const apiSchema = [ "format_description" : "volume", "type" : "string" }, + "import-from" : { + "description" : "Create a new disk, importing from this source (volume ID or absolute path). When an absolute path is specified, it's up to you to ensure that the source is not actively used by another process during the import!", + "format" : "pve-volume-id-or-absolute-path", + "format_description" : "source volume", + "optional" : 1, + "type" : "string" + }, "size" : { "description" : "Disk size. This is purely informational and has no effect.", "format" : "disk-size", @@ -16515,7 +16622,7 @@ const apiSchema = [ }, "optional" : 1, "type" : "string", - "typetext" : "[file=] [,size=] [,version=]" + "typetext" : "[file=] [,import-from=] [,size=] [,version=]" }, "unused[n]" : { "description" : "Reference to unused volumes. This is used internally, and should not be modified manually.", @@ -16591,6 +16698,7 @@ const apiSchema = [ "serial3", "std", "virtio", + "virtio-gl", "vmware" ], "optional" : 1, @@ -16603,7 +16711,7 @@ const apiSchema = [ "verbose_description" : "Configure the VGA Hardware. If you want to use high resolution modes (>= 1280x1024x16) you may need to increase the vga memory option. Since QEMU 2.9 the default VGA display type is 'std' for all OS types besides some Windows versions (XP and older) which use 'cirrus'. The 'qxl' option enables the SPICE display server. For win* OS you can select how many independent displays you want, Linux guests can add displays them self.\nYou can also run without any graphic card, using a serial device as terminal." }, "virtio[n]" : { - "description" : "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.", + "description" : "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.", "format" : { "aio" : { "description" : "AIO type to use.", @@ -16722,6 +16830,13 @@ const apiSchema = [ "optional" : 1, "type" : "integer" }, + "import-from" : { + "description" : "Create a new disk, importing from this source (volume ID or absolute path). When an absolute path is specified, it's up to you to ensure that the source is not actively used by another process during the import!", + "format" : "pve-volume-id-or-absolute-path", + "format_description" : "source volume", + "optional" : 1, + "type" : "string" + }, "iops" : { "description" : "Maximum r/w I/O in operations per second.", "format_description" : "iops", @@ -16916,7 +17031,7 @@ const apiSchema = [ }, "optional" : 1, "type" : "string", - "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,ro=<1|0>] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" + "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,import-from=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,ro=<1|0>] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" }, "vmgenid" : { "default" : "1 (autogenerated)", @@ -17167,10 +17282,10 @@ const apiSchema = [ "default" : "cgroup v1: 1024, cgroup v2: 100", "description" : "CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2.", "maximum" : 262144, - "minimum" : 2, + "minimum" : 1, "optional" : 1, "type" : "integer", - "typetext" : " (2 - 262144)", + "typetext" : " (1 - 262144)", "verbose_description" : "CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to weights of all the other running VMs." }, "delete" : { @@ -17195,7 +17310,7 @@ const apiSchema = [ "typetext" : "" }, "efidisk0" : { - "description" : "Configure a Disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead.", + "description" : "Configure a Disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume.", "format" : { "efitype" : { "default" : "2m", @@ -17228,6 +17343,13 @@ const apiSchema = [ "optional" : 1, "type" : "string" }, + "import-from" : { + "description" : "Create a new disk, importing from this source (volume ID or absolute path). When an absolute path is specified, it's up to you to ensure that the source is not actively used by another process during the import!", + "format" : "pve-volume-id-or-absolute-path", + "format_description" : "source volume", + "optional" : 1, + "type" : "string" + }, "pre-enrolled-keys" : { "default" : 0, "description" : "Use am EFI vars template with distribution-specific and Microsoft Standard keys enrolled, if used with 'efitype=4m'. Note that this will enable Secure Boot by default, though it can still be turned off from within the VM.", @@ -17247,7 +17369,7 @@ const apiSchema = [ }, "optional" : 1, "type" : "string", - "typetext" : "[file=] [,efitype=<2m|4m>] [,format=] [,pre-enrolled-keys=<1|0>] [,size=]" + "typetext" : "[file=] [,efitype=<2m|4m>] [,format=] [,import-from=] [,pre-enrolled-keys=<1|0>] [,size=]" }, "force" : { "description" : "Force physical removal. Without this, we simple remove the disk from the config file and create an additional configuration entry called 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause physical removal.", @@ -17274,7 +17396,7 @@ const apiSchema = [ "format" : "pve-qm-hostpci", "optional" : 1, "type" : "string", - "typetext" : "[host=] [,legacy-igd=<1|0>] [,mdev=] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=] [,x-vga=<1|0>]", + "typetext" : "[host=] [,device-id=] [,legacy-igd=<1|0>] [,mdev=] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=] [,sub-device-id=] [,sub-vendor-id=] [,vendor-id=] [,x-vga=<1|0>]", "verbose_description" : "Map host PCI devices into guest.\n\nNOTE: This option allows direct access to host hardware. So it is no longer\npossible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n" }, "hotplug" : { @@ -17296,7 +17418,7 @@ const apiSchema = [ "type" : "string" }, "ide[n]" : { - "description" : "Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.", + "description" : "Use volume as IDE hard disk or CD-ROM (n is 0 to 3). 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.", "format" : { "aio" : { "description" : "AIO type to use.", @@ -17415,6 +17537,13 @@ const apiSchema = [ "optional" : 1, "type" : "integer" }, + "import-from" : { + "description" : "Create a new disk, importing from this source (volume ID or absolute path). When an absolute path is specified, it's up to you to ensure that the source is not actively used by another process during the import!", + "format" : "pve-volume-id-or-absolute-path", + "format_description" : "source volume", + "optional" : 1, + "type" : "string" + }, "iops" : { "description" : "Maximum r/w I/O in operations per second.", "format_description" : "iops", @@ -17619,7 +17748,7 @@ const apiSchema = [ }, "optional" : 1, "type" : "string", - "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]" + "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,import-from=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]" }, "ipconfig[n]" : { "description" : "cloud-init: Specify IP addresses and gateways for the corresponding interface.\n\nIP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.\n\nThe special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit\ngateway should be provided.\nFor IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires\ncloud-init 19.4 or newer.\n\nIf cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using\ndhcp on IPv4.\n", @@ -17657,7 +17786,7 @@ const apiSchema = [ }, "keyboard" : { "default" : null, - "description" : "Keyboard layout for VNC server. The default is read from the'/etc/pve/datacenter.cfg' configuration file. It should not be necessary to set it.", + "description" : "Keyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS.", "enum" : [ "de", "de-ch", @@ -17767,9 +17896,9 @@ const apiSchema = [ "format" : { "bridge" : { "description" : "Bridge to attach the network device to. The Proxmox VE standard bridge\nis called 'vmbr0'.\n\nIf you do not specify a bridge, we create a kvm user (NATed) network\ndevice, which provides DHCP and DNS services. The following addresses\nare used:\n\n 10.0.2.2 Gateway\n 10.0.2.3 DNS Server\n 10.0.2.4 SMB Server\n\nThe DHCP server assign addresses to the guest starting from 10.0.2.15.\n", + "format" : "pve-bridge-id", "format_description" : "bridge", "optional" : 1, - "pattern" : "[-_.\\w\\d]+", "type" : "string" }, "e1000" : { @@ -18042,7 +18171,7 @@ const apiSchema = [ "typetext" : "[source=] [,max_bytes=] [,period=]" }, "sata[n]" : { - "description" : "Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.", + "description" : "Use volume as SATA hard disk or CD-ROM (n is 0 to 5). 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.", "format" : { "aio" : { "description" : "AIO type to use.", @@ -18161,6 +18290,13 @@ const apiSchema = [ "optional" : 1, "type" : "integer" }, + "import-from" : { + "description" : "Create a new disk, importing from this source (volume ID or absolute path). When an absolute path is specified, it's up to you to ensure that the source is not actively used by another process during the import!", + "format" : "pve-volume-id-or-absolute-path", + "format_description" : "source volume", + "optional" : 1, + "type" : "string" + }, "iops" : { "description" : "Maximum r/w I/O in operations per second.", "format_description" : "iops", @@ -18357,10 +18493,10 @@ const apiSchema = [ }, "optional" : 1, "type" : "string", - "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]" + "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,import-from=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]" }, "scsi[n]" : { - "description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.", + "description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). 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.", "format" : { "aio" : { "description" : "AIO type to use.", @@ -18479,6 +18615,13 @@ const apiSchema = [ "optional" : 1, "type" : "integer" }, + "import-from" : { + "description" : "Create a new disk, importing from this source (volume ID or absolute path). When an absolute path is specified, it's up to you to ensure that the source is not actively used by another process during the import!", + "format" : "pve-volume-id-or-absolute-path", + "format_description" : "source volume", + "optional" : 1, + "type" : "string" + }, "iops" : { "description" : "Maximum r/w I/O in operations per second.", "format_description" : "iops", @@ -18697,7 +18840,7 @@ const apiSchema = [ }, "optional" : 1, "type" : "string", - "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,replicate=<1|0>] [,rerror=] [,ro=<1|0>] [,scsiblock=<1|0>] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]" + "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,import-from=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,replicate=<1|0>] [,rerror=] [,ro=<1|0>] [,scsiblock=<1|0>] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]" }, "scsihw" : { "default" : "lsi", @@ -18842,7 +18985,7 @@ const apiSchema = [ "typetext" : "" }, "tpmstate0" : { - "description" : "Configure a Disk for storing TPM state. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default size of 4 MiB will always be used instead. The format is also fixed to 'raw'.", + "description" : "Configure a Disk for storing TPM state. The format is fixed to 'raw'. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and 4 MiB will be used instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume.", "format" : { "file" : { "default_key" : 1, @@ -18851,6 +18994,13 @@ const apiSchema = [ "format_description" : "volume", "type" : "string" }, + "import-from" : { + "description" : "Create a new disk, importing from this source (volume ID or absolute path). When an absolute path is specified, it's up to you to ensure that the source is not actively used by another process during the import!", + "format" : "pve-volume-id-or-absolute-path", + "format_description" : "source volume", + "optional" : 1, + "type" : "string" + }, "size" : { "description" : "Disk size. This is purely informational and has no effect.", "format" : "disk-size", @@ -18874,7 +19024,7 @@ const apiSchema = [ }, "optional" : 1, "type" : "string", - "typetext" : "[file=] [,size=] [,version=]" + "typetext" : "[file=] [,import-from=] [,size=] [,version=]" }, "unused[n]" : { "description" : "Reference to unused volumes. This is used internally, and should not be modified manually.", @@ -18950,6 +19100,7 @@ const apiSchema = [ "serial3", "std", "virtio", + "virtio-gl", "vmware" ], "optional" : 1, @@ -18962,7 +19113,7 @@ const apiSchema = [ "verbose_description" : "Configure the VGA Hardware. If you want to use high resolution modes (>= 1280x1024x16) you may need to increase the vga memory option. Since QEMU 2.9 the default VGA display type is 'std' for all OS types besides some Windows versions (XP and older) which use 'cirrus'. The 'qxl' option enables the SPICE display server. For win* OS you can select how many independent displays you want, Linux guests can add displays them self.\nYou can also run without any graphic card, using a serial device as terminal." }, "virtio[n]" : { - "description" : "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.", + "description" : "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.", "format" : { "aio" : { "description" : "AIO type to use.", @@ -19081,6 +19232,13 @@ const apiSchema = [ "optional" : 1, "type" : "integer" }, + "import-from" : { + "description" : "Create a new disk, importing from this source (volume ID or absolute path). When an absolute path is specified, it's up to you to ensure that the source is not actively used by another process during the import!", + "format" : "pve-volume-id-or-absolute-path", + "format_description" : "source volume", + "optional" : 1, + "type" : "string" + }, "iops" : { "description" : "Maximum r/w I/O in operations per second.", "format_description" : "iops", @@ -19275,7 +19433,7 @@ const apiSchema = [ }, "optional" : 1, "type" : "string", - "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,ro=<1|0>] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" + "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,import-from=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,ro=<1|0>] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" }, "vmgenid" : { "default" : "1 (autogenerated)", @@ -22789,10 +22947,10 @@ const apiSchema = [ "default" : "cgroup v1: 1024, cgroup v2: 100", "description" : "CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2.", "maximum" : 262144, - "minimum" : 2, + "minimum" : 1, "optional" : 1, "type" : "integer", - "typetext" : " (2 - 262144)", + "typetext" : " (1 - 262144)", "verbose_description" : "CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to weights of all the other running VMs." }, "description" : { @@ -22803,7 +22961,7 @@ const apiSchema = [ "typetext" : "" }, "efidisk0" : { - "description" : "Configure a Disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead.", + "description" : "Configure a Disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume.", "format" : { "efitype" : { "default" : "2m", @@ -22836,6 +22994,13 @@ const apiSchema = [ "optional" : 1, "type" : "string" }, + "import-from" : { + "description" : "Create a new disk, importing from this source (volume ID or absolute path). When an absolute path is specified, it's up to you to ensure that the source is not actively used by another process during the import!", + "format" : "pve-volume-id-or-absolute-path", + "format_description" : "source volume", + "optional" : 1, + "type" : "string" + }, "pre-enrolled-keys" : { "default" : 0, "description" : "Use am EFI vars template with distribution-specific and Microsoft Standard keys enrolled, if used with 'efitype=4m'. Note that this will enable Secure Boot by default, though it can still be turned off from within the VM.", @@ -22855,7 +23020,7 @@ const apiSchema = [ }, "optional" : 1, "type" : "string", - "typetext" : "[file=] [,efitype=<2m|4m>] [,format=] [,pre-enrolled-keys=<1|0>] [,size=]" + "typetext" : "[file=] [,efitype=<2m|4m>] [,format=] [,import-from=] [,pre-enrolled-keys=<1|0>] [,size=]" }, "force" : { "description" : "Allow to overwrite existing VM.", @@ -22882,7 +23047,7 @@ const apiSchema = [ "format" : "pve-qm-hostpci", "optional" : 1, "type" : "string", - "typetext" : "[host=] [,legacy-igd=<1|0>] [,mdev=] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=] [,x-vga=<1|0>]", + "typetext" : "[host=] [,device-id=] [,legacy-igd=<1|0>] [,mdev=] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=] [,sub-device-id=] [,sub-vendor-id=] [,vendor-id=] [,x-vga=<1|0>]", "verbose_description" : "Map host PCI devices into guest.\n\nNOTE: This option allows direct access to host hardware. So it is no longer\npossible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n" }, "hotplug" : { @@ -22904,7 +23069,7 @@ const apiSchema = [ "type" : "string" }, "ide[n]" : { - "description" : "Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.", + "description" : "Use volume as IDE hard disk or CD-ROM (n is 0 to 3). 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.", "format" : { "aio" : { "description" : "AIO type to use.", @@ -23023,6 +23188,13 @@ const apiSchema = [ "optional" : 1, "type" : "integer" }, + "import-from" : { + "description" : "Create a new disk, importing from this source (volume ID or absolute path). When an absolute path is specified, it's up to you to ensure that the source is not actively used by another process during the import!", + "format" : "pve-volume-id-or-absolute-path", + "format_description" : "source volume", + "optional" : 1, + "type" : "string" + }, "iops" : { "description" : "Maximum r/w I/O in operations per second.", "format_description" : "iops", @@ -23227,7 +23399,7 @@ const apiSchema = [ }, "optional" : 1, "type" : "string", - "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]" + "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,import-from=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]" }, "ipconfig[n]" : { "description" : "cloud-init: Specify IP addresses and gateways for the corresponding interface.\n\nIP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.\n\nThe special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit\ngateway should be provided.\nFor IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires\ncloud-init 19.4 or newer.\n\nIf cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using\ndhcp on IPv4.\n", @@ -23265,7 +23437,7 @@ const apiSchema = [ }, "keyboard" : { "default" : null, - "description" : "Keyboard layout for VNC server. The default is read from the'/etc/pve/datacenter.cfg' configuration file. It should not be necessary to set it.", + "description" : "Keyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS.", "enum" : [ "de", "de-ch", @@ -23382,9 +23554,9 @@ const apiSchema = [ "format" : { "bridge" : { "description" : "Bridge to attach the network device to. The Proxmox VE standard bridge\nis called 'vmbr0'.\n\nIf you do not specify a bridge, we create a kvm user (NATed) network\ndevice, which provides DHCP and DNS services. The following addresses\nare used:\n\n 10.0.2.2 Gateway\n 10.0.2.3 DNS Server\n 10.0.2.4 SMB Server\n\nThe DHCP server assign addresses to the guest starting from 10.0.2.15.\n", + "format" : "pve-bridge-id", "format_description" : "bridge", "optional" : 1, - "pattern" : "[-_.\\w\\d]+", "type" : "string" }, "e1000" : { @@ -23657,7 +23829,7 @@ const apiSchema = [ "typetext" : "[source=] [,max_bytes=] [,period=]" }, "sata[n]" : { - "description" : "Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.", + "description" : "Use volume as SATA hard disk or CD-ROM (n is 0 to 5). 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.", "format" : { "aio" : { "description" : "AIO type to use.", @@ -23776,6 +23948,13 @@ const apiSchema = [ "optional" : 1, "type" : "integer" }, + "import-from" : { + "description" : "Create a new disk, importing from this source (volume ID or absolute path). When an absolute path is specified, it's up to you to ensure that the source is not actively used by another process during the import!", + "format" : "pve-volume-id-or-absolute-path", + "format_description" : "source volume", + "optional" : 1, + "type" : "string" + }, "iops" : { "description" : "Maximum r/w I/O in operations per second.", "format_description" : "iops", @@ -23972,10 +24151,10 @@ const apiSchema = [ }, "optional" : 1, "type" : "string", - "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]" + "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,import-from=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]" }, "scsi[n]" : { - "description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.", + "description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). 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.", "format" : { "aio" : { "description" : "AIO type to use.", @@ -24094,6 +24273,13 @@ const apiSchema = [ "optional" : 1, "type" : "integer" }, + "import-from" : { + "description" : "Create a new disk, importing from this source (volume ID or absolute path). When an absolute path is specified, it's up to you to ensure that the source is not actively used by another process during the import!", + "format" : "pve-volume-id-or-absolute-path", + "format_description" : "source volume", + "optional" : 1, + "type" : "string" + }, "iops" : { "description" : "Maximum r/w I/O in operations per second.", "format_description" : "iops", @@ -24312,7 +24498,7 @@ const apiSchema = [ }, "optional" : 1, "type" : "string", - "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,replicate=<1|0>] [,rerror=] [,ro=<1|0>] [,scsiblock=<1|0>] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]" + "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,import-from=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,replicate=<1|0>] [,rerror=] [,ro=<1|0>] [,scsiblock=<1|0>] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]" }, "scsihw" : { "default" : "lsi", @@ -24465,7 +24651,7 @@ const apiSchema = [ "typetext" : "" }, "tpmstate0" : { - "description" : "Configure a Disk for storing TPM state. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default size of 4 MiB will always be used instead. The format is also fixed to 'raw'.", + "description" : "Configure a Disk for storing TPM state. The format is fixed to 'raw'. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and 4 MiB will be used instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume.", "format" : { "file" : { "default_key" : 1, @@ -24474,6 +24660,13 @@ const apiSchema = [ "format_description" : "volume", "type" : "string" }, + "import-from" : { + "description" : "Create a new disk, importing from this source (volume ID or absolute path). When an absolute path is specified, it's up to you to ensure that the source is not actively used by another process during the import!", + "format" : "pve-volume-id-or-absolute-path", + "format_description" : "source volume", + "optional" : 1, + "type" : "string" + }, "size" : { "description" : "Disk size. This is purely informational and has no effect.", "format" : "disk-size", @@ -24497,7 +24690,7 @@ const apiSchema = [ }, "optional" : 1, "type" : "string", - "typetext" : "[file=] [,size=] [,version=]" + "typetext" : "[file=] [,import-from=] [,size=] [,version=]" }, "unique" : { "description" : "Assign a unique random ethernet address.", @@ -24580,6 +24773,7 @@ const apiSchema = [ "serial3", "std", "virtio", + "virtio-gl", "vmware" ], "optional" : 1, @@ -24592,7 +24786,7 @@ const apiSchema = [ "verbose_description" : "Configure the VGA Hardware. If you want to use high resolution modes (>= 1280x1024x16) you may need to increase the vga memory option. Since QEMU 2.9 the default VGA display type is 'std' for all OS types besides some Windows versions (XP and older) which use 'cirrus'. The 'qxl' option enables the SPICE display server. For win* OS you can select how many independent displays you want, Linux guests can add displays them self.\nYou can also run without any graphic card, using a serial device as terminal." }, "virtio[n]" : { - "description" : "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.", + "description" : "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.", "format" : { "aio" : { "description" : "AIO type to use.", @@ -24711,6 +24905,13 @@ const apiSchema = [ "optional" : 1, "type" : "integer" }, + "import-from" : { + "description" : "Create a new disk, importing from this source (volume ID or absolute path). When an absolute path is specified, it's up to you to ensure that the source is not actively used by another process during the import!", + "format" : "pve-volume-id-or-absolute-path", + "format_description" : "source volume", + "optional" : 1, + "type" : "string" + }, "iops" : { "description" : "Maximum r/w I/O in operations per second.", "format_description" : "iops", @@ -24905,7 +25106,7 @@ const apiSchema = [ }, "optional" : 1, "type" : "string", - "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,ro=<1|0>] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" + "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,import-from=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,ro=<1|0>] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" }, "vmgenid" : { "default" : "1 (autogenerated)", @@ -25359,6 +25560,7 @@ const apiSchema = [ "archlinux", "alpine", "gentoo", + "nixos", "unmanaged" ], "optional" : 1, @@ -25871,6 +26073,7 @@ const apiSchema = [ "archlinux", "alpine", "gentoo", + "nixos", "unmanaged" ], "optional" : 1, @@ -31624,6 +31827,7 @@ const apiSchema = [ "archlinux", "alpine", "gentoo", + "nixos", "unmanaged" ], "optional" : 1, @@ -32762,6 +32966,13 @@ const apiSchema = [ "type" : "string", "typetext" : "" }, + "remove_ecprofile" : { + "default" : 1, + "description" : "Remove the erasure code profile. Defaults to true, if applicable.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, "remove_storages" : { "default" : 0, "description" : "Remove all pveceph-managed storages configured for this pool", @@ -33210,14 +33421,14 @@ const apiSchema = [ }, "POST" : { "allowtoken" : 1, - "description" : "Create POOL", + "description" : "Create Ceph pool", "method" : "POST", "name" : "createpool", "parameters" : { "additionalProperties" : 0, "properties" : { "add_storages" : { - "description" : "Configure VM and CT storage using the new pool.", + "description" : "Configure VM and CT storage using the new pool. Always enabled for erasure coded pools.", "optional" : 1, "type" : "boolean", "typetext" : "" @@ -33241,6 +33452,41 @@ const apiSchema = [ "type" : "string", "typetext" : "" }, + "erasure-coding" : { + "format" : { + "device-class" : { + "description" : "CRUSH device class. Will create an erasure coded pool plus a replicated pool for metadata.", + "format_description" : "class", + "optional" : 1, + "type" : "string" + }, + "failure-domain" : { + "description" : "CRUSH failure domain. Default is 'host'. Will create an erasure coded pool plus a replicated pool for metadata.", + "format_description" : "domain", + "optional" : 1, + "type" : "string" + }, + "k" : { + "description" : "Number of data chunks. Will create an erasure coded pool plus a replicated pool for metadata.", + "minimum" : 1, + "type" : "integer" + }, + "m" : { + "description" : "Number of coding chunks. Will create an erasure coded pool plus a replicated pool for metadata.", + "minimum" : 1, + "type" : "integer" + }, + "profile" : { + "description" : "Override the erasure code (EC) profile to use. Will create an erasure coded pool plus a replicated pool for metadata.", + "format_description" : "profile", + "optional" : 1, + "type" : "string" + } + }, + "optional" : 1, + "type" : "string", + "typetext" : "k= ,m= [,device-class=] [,failure-domain=] [,profile=]" + }, "min_size" : { "default" : 2, "description" : "Minimum number of replicas per object", @@ -34044,6 +34290,12 @@ const apiSchema = [ "optional" : 1, "type" : "string" }, + "notes-template" : { + "description" : "Template string for generating notes for the backup(s). It can contain variables which will be replaced by their values. Currently supported are {{cluster}}, {{guestname}}, {{node}}, and {{vmid}}, but more might be added in the future.", + "optional" : 1, + "requires" : "storage", + "type" : "string" + }, "pigz" : { "default" : 0, "description" : "Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count.", @@ -34055,6 +34307,12 @@ const apiSchema = [ "optional" : 1, "type" : "string" }, + "protected" : { + "description" : "If true, mark backup(s) as protected.", + "optional" : 1, + "requires" : "storage", + "type" : "boolean" + }, "prune-backups" : { "default" : "keep-all=1", "description" : "Use these retention options instead of those from the storage configuration.", @@ -34285,6 +34543,13 @@ const apiSchema = [ "type" : "string", "typetext" : "" }, + "notes-template" : { + "description" : "Template string for generating notes for the backup(s). It can contain variables which will be replaced by their values. Currently supported are {{cluster}}, {{guestname}}, {{node}}, and {{vmid}}, but more might be added in the future.", + "optional" : 1, + "requires" : "storage", + "type" : "string", + "typetext" : "" + }, "pigz" : { "default" : 0, "description" : "Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count.", @@ -34298,6 +34563,13 @@ const apiSchema = [ "type" : "string", "typetext" : "" }, + "protected" : { + "description" : "If true, mark backup(s) as protected.", + "optional" : 1, + "requires" : "storage", + "type" : "boolean", + "typetext" : "" + }, "prune-backups" : { "default" : "keep-all=1", "description" : "Use these retention options instead of those from the storage configuration.", @@ -42938,8 +43210,8 @@ const apiSchema = [ "default" : "login", "description" : "Run specific command or default to login.", "enum" : [ - "upgrade", "ceph_install", + "upgrade", "login" ], "optional" : 1, @@ -43034,8 +43306,8 @@ const apiSchema = [ "default" : "login", "description" : "Run specific command or default to login.", "enum" : [ - "upgrade", "ceph_install", + "upgrade", "login" ], "optional" : 1, @@ -43160,8 +43432,8 @@ const apiSchema = [ "default" : "login", "description" : "Run specific command or default to login.", "enum" : [ - "upgrade", "ceph_install", + "upgrade", "login" ], "optional" : 1, @@ -44235,6 +44507,14 @@ const apiSchema = [ "type" : "string", "typetext" : "" }, + "max-protected-backups" : { + "default" : "Unlimited for users with Datastore.Allocate privilege, 5 for other users", + "description" : "Maximal number of protected backups per guest. Use '-1' for unlimited.", + "minimum" : -1, + "optional" : 1, + "type" : "integer", + "typetext" : " (-1 - N)" + }, "maxfiles" : { "description" : "Deprecated: use 'prune-backups' instead. Maximal number of backup files per VM. Use '0' for unlimited.", "minimum" : 0, @@ -44731,6 +45011,14 @@ const apiSchema = [ "type" : "string", "typetext" : "" }, + "max-protected-backups" : { + "default" : "Unlimited for users with Datastore.Allocate privilege, 5 for other users", + "description" : "Maximal number of protected backups per guest. Use '-1' for unlimited.", + "minimum" : -1, + "optional" : 1, + "type" : "integer", + "typetext" : " (-1 - N)" + }, "maxfiles" : { "description" : "Deprecated: use 'prune-backups' instead. Maximal number of backup files per VM. Use '0' for unlimited.", "minimum" : 0, @@ -46648,13 +46936,13 @@ const apiSchema = [ "typetext" : "" }, "full" : { - "description" : "If set, uses the LDAP Directory as source of truth, deleting users or groups not returned from the sync. Otherwise only syncs information which is not already present, and does not deletes or modifies anything else.", + "description" : "DEPRECATED: use 'remove-vanished' instead. If set, uses the LDAP Directory as source of truth, deleting users or groups not returned from the sync and removing all locally modified properties of synced users. If not set, only syncs information which is present in the synced data, and does not delete or modify anything else.", "optional" : "1", "type" : "boolean", "typetext" : "" }, "purge" : { - "description" : "Remove ACLs for users or groups which were removed from the config during a sync.", + "description" : "DEPRECATED: use 'remove-vanished' instead. Remove ACLs for users or groups which were removed from the config during a sync.", "optional" : "1", "type" : "boolean", "typetext" : "" @@ -46666,6 +46954,13 @@ const apiSchema = [ "type" : "string", "typetext" : "" }, + "remove-vanished" : { + "description" : "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.", + "optional" : "1", + "pattern" : "(?:(?:acl|properties|entry);)*(?:acl|properties|entry)", + "type" : "string", + "typetext" : "[acl];[properties];[entry]" + }, "scope" : { "description" : "Select what to sync.", "enum" : [ @@ -47010,7 +47305,7 @@ const apiSchema = [ "format" : "realm-sync-options", "optional" : 1, "type" : "string", - "typetext" : "[enable-new=<1|0>] [,full=<1|0>] [,purge=<1|0>] [,scope=]" + "typetext" : "[enable-new=<1|0>] [,full=<1|0>] [,purge=<1|0>] [,remove-vanished=[acl];[properties];[entry]] [,scope=]" }, "sync_attributes" : { "description" : "Comma separated list of key=value pairs for specifying which LDAP attributes map to which PVE user field. For example, to map the LDAP attribute 'mail' to PVEs 'email', write 'email=mail'. By default, each PVE user field is represented by an LDAP attribute of the same name.", @@ -47341,7 +47636,7 @@ const apiSchema = [ "format" : "realm-sync-options", "optional" : 1, "type" : "string", - "typetext" : "[enable-new=<1|0>] [,full=<1|0>] [,purge=<1|0>] [,scope=]" + "typetext" : "[enable-new=<1|0>] [,full=<1|0>] [,purge=<1|0>] [,remove-vanished=[acl];[properties];[entry]] [,scope=]" }, "sync_attributes" : { "description" : "Comma separated list of key=value pairs for specifying which LDAP attributes map to which PVE user field. For example, to map the LDAP attribute 'mail' to PVEs 'email', write 'email=mail'. By default, each PVE user field is represented by an LDAP attribute of the same name.", diff --git a/datacenter.cfg.5-opts.adoc b/datacenter.cfg.5-opts.adoc index 2755edf..bcc7f75 100644 --- a/datacenter.cfg.5-opts.adoc +++ b/datacenter.cfg.5-opts.adoc @@ -84,6 +84,18 @@ Migration traffic is encrypted using an SSH tunnel by default. On secure, comple Migration is secure using SSH tunnel by default. For secure private networks you can disable it to speed up migration. Deprecated, use the 'migration' property instead! +`next-id`: `[lower=] [,upper=]` :: + +Control the range for the free VMID auto-selection pool. + +`lower`=`` ('default =' `100`);; + +Lower, inclusive boundary for free next-id API range. + +`upper`=`` ('default =' `1000000`);; + +Upper, inclusive boundary for free next-id API range. + `u2f`: `[appid=] [,origin=]` :: u2f diff --git a/ha-resources-opts.adoc b/ha-resources-opts.adoc index c0aaf19..29a4479 100644 --- a/ha-resources-opts.adoc +++ b/ha-resources-opts.adoc @@ -41,7 +41,7 @@ of the `error` state. `ignored`;; + The resource gets removed from the manager status and so the CRM and the LRM do -not touch the resource anymore. All {pve} API calls affecting this resource +not touch the resource anymore. All \{pve\} API calls affecting this resource will be executed, directly bypassing the HA stack. CRM commands will be thrown away while there source is in this state. The resource will not get relocated on node failures. diff --git a/pct.1-synopsis.adoc b/pct.1-synopsis.adoc index b756e15..4c82a59 100644 --- a/pct.1-synopsis.adoc +++ b/pct.1-synopsis.adoc @@ -172,7 +172,7 @@ Specifies network interfaces for the container. Specifies whether a VM will be started during system bootup. -`--ostype` `` :: +`--ostype` `` :: OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/.common.conf. Value 'unmanaged' can be used to skip and OS specific setup. @@ -661,7 +661,7 @@ Specifies network interfaces for the container. Specifies whether a VM will be started during system bootup. -`--ostype` `` :: +`--ostype` `` :: OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/.common.conf. Value 'unmanaged' can be used to skip and OS specific setup. @@ -843,7 +843,7 @@ Specifies network interfaces for the container. Specifies whether a VM will be started during system bootup. -`--ostype` `` :: +`--ostype` `` :: OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/.common.conf. Value 'unmanaged' can be used to skip and OS specific setup. diff --git a/pct.conf.5-opts.adoc b/pct.conf.5-opts.adoc index 0362c4f..c9a4fa3 100644 --- a/pct.conf.5-opts.adoc +++ b/pct.conf.5-opts.adoc @@ -190,7 +190,7 @@ Network interface type. Specifies whether a VM will be started during system bootup. -`ostype`: `` :: +`ostype`: `` :: OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/.common.conf. Value 'unmanaged' can be used to skip and OS specific setup. diff --git a/pveceph.1-synopsis.adoc b/pveceph.1-synopsis.adoc index b3fa281..47857fd 100644 --- a/pveceph.1-synopsis.adoc +++ b/pveceph.1-synopsis.adoc @@ -236,7 +236,7 @@ If set, we remove partition table entries. *pveceph pool create* `` `[OPTIONS]` -Create POOL +Create Ceph pool ``: `` :: @@ -244,7 +244,7 @@ The name of the pool. It must be unique. `--add_storages` `` :: -Configure VM and CT storage using the new pool. +Configure VM and CT storage using the new pool. Always enabled for erasure coded pools. `--application` `` ('default =' `rbd`):: @@ -254,6 +254,10 @@ The application of the pool. The rule to use for mapping object placement in the cluster. +`--erasure-coding` `k= ,m= [,device-class=] [,failure-domain=] [,profile=]` :: + +no description available + `--min_size` ` (1 - 7)` ('default =' `2`):: Minimum number of replicas per object @@ -294,6 +298,10 @@ The name of the pool. It must be unique. If true, destroys pool even if in use +`--remove_ecprofile` `` ('default =' `1`):: + +Remove the erasure code profile. Defaults to true, if applicable. + `--remove_storages` `` ('default =' `0`):: Remove all pveceph-managed storages configured for this pool diff --git a/pvesm.1-synopsis.adoc b/pvesm.1-synopsis.adoc index 0c1f369..f7fc499 100644 --- a/pvesm.1-synopsis.adoc +++ b/pvesm.1-synopsis.adoc @@ -106,6 +106,10 @@ target portal group for Linux LIO targets Base64-encoded, PEM-formatted public RSA key. Used to encrypt a copy of the encryption-key which will be added to each encrypted backup. +`--max-protected-backups` ` (-1 - N)` ('default =' `Unlimited for users with Datastore.Allocate privilege, 5 for other users`):: + +Maximal number of protected backups per guest. Use '-1' for unlimited. + `--maxfiles` ` (0 - N)` :: Deprecated: use 'prune-backups' instead. Maximal number of backup files per VM. Use '0' for unlimited. @@ -650,6 +654,10 @@ target portal group for Linux LIO targets Base64-encoded, PEM-formatted public RSA key. Used to encrypt a copy of the encryption-key which will be added to each encrypted backup. +`--max-protected-backups` ` (-1 - N)` ('default =' `Unlimited for users with Datastore.Allocate privilege, 5 for other users`):: + +Maximal number of protected backups per guest. Use '-1' for unlimited. + `--maxfiles` ` (0 - N)` :: Deprecated: use 'prune-backups' instead. Maximal number of backup files per VM. Use '0' for unlimited. diff --git a/pveum.1-synopsis.adoc b/pveum.1-synopsis.adoc index 3b38a9f..6c28043 100644 --- a/pveum.1-synopsis.adoc +++ b/pveum.1-synopsis.adoc @@ -304,7 +304,7 @@ Fallback Server IP address (or DNS name) LDAPS TLS/SSL version. It's not recommended to use version older than 1.2! -`--sync-defaults-options` `[enable-new=<1|0>] [,full=<1|0>] [,purge=<1|0>] [,scope=]` :: +`--sync-defaults-options` `[enable-new=<1|0>] [,full=<1|0>] [,purge=<1|0>] [,remove-vanished=[acl];[properties];[entry]] [,scope=]` :: The default options for behavior of synchronizations. @@ -476,7 +476,7 @@ Fallback Server IP address (or DNS name) LDAPS TLS/SSL version. It's not recommended to use version older than 1.2! -`--sync-defaults-options` `[enable-new=<1|0>] [,full=<1|0>] [,purge=<1|0>] [,scope=]` :: +`--sync-defaults-options` `[enable-new=<1|0>] [,full=<1|0>] [,purge=<1|0>] [,remove-vanished=[acl];[properties];[entry]] [,scope=]` :: The default options for behavior of synchronizations. @@ -520,11 +520,15 @@ Enable newly synced users immediately. `--full` `` :: -If set, uses the LDAP Directory as source of truth, deleting users or groups not returned from the sync. Otherwise only syncs information which is not already present, and does not deletes or modifies anything else. +DEPRECATED: use 'remove-vanished' instead. If set, uses the LDAP Directory as source of truth, deleting users or groups not returned from the sync and removing all locally modified properties of synced users. If not set, only syncs information which is present in the synced data, and does not delete or modify anything else. `--purge` `` :: -Remove ACLs for users or groups which were removed from the config during a sync. +DEPRECATED: use 'remove-vanished' instead. Remove ACLs for users or groups which were removed from the config during a sync. + +`--remove-vanished` `[acl];[properties];[entry]` :: + +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. `--scope` `` :: diff --git a/qm.1-synopsis.adoc b/qm.1-synopsis.adoc index 233f5c5..d64493d 100644 --- a/qm.1-synopsis.adoc +++ b/qm.1-synopsis.adoc @@ -187,7 +187,7 @@ Emulated CPU type. Limit of CPU usage. -`--cpuunits` ` (2 - 262144)` ('default =' `cgroup v1: 1024, cgroup v2: 100`):: +`--cpuunits` ` (1 - 262144)` ('default =' `cgroup v1: 1024, cgroup v2: 100`):: CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2. @@ -195,9 +195,9 @@ CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2. Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file. -`--efidisk0` `[file=] [,efitype=<2m|4m>] [,format=] [,pre-enrolled-keys=<1|0>] [,size=]` :: +`--efidisk0` `[file=] [,efitype=<2m|4m>] [,format=] [,import-from=] [,pre-enrolled-keys=<1|0>] [,size=]` :: -Configure a Disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. +Configure a Disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. `--force` `` :: @@ -213,7 +213,7 @@ Freeze CPU at startup (use 'c' monitor command to start execution). Script that will be executed during various steps in the vms lifetime. -`--hostpci[n]` `[host=] [,legacy-igd=<1|0>] [,mdev=] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=] [,x-vga=<1|0>]` :: +`--hostpci[n]` `[host=] [,device-id=] [,legacy-igd=<1|0>] [,mdev=] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=] [,sub-device-id=] [,sub-vendor-id=] [,vendor-id=] [,x-vga=<1|0>]` :: Map host PCI devices into guest. @@ -225,9 +225,9 @@ Selectively enable hotplug features. This is a comma separated list of hotplug f Enable/disable hugepages memory. -`--ide[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: +`--ide[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,import-from=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: -Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. +Use volume as IDE hard disk or CD-ROM (n is 0 to 3). 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. `--ipconfig[n]` `[gw=] [,gw6=] [,ip=] [,ip6=]` :: @@ -253,7 +253,7 @@ Use together with hugepages. If enabled, hugepages will not not be deleted after `--keyboard` `` :: -Keyboard layout for VNC server. The default is read from the'/etc/pve/datacenter.cfg' configuration file. It should not be necessary to set it. +Keyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS. `--kvm` `` ('default =' `1`):: @@ -339,13 +339,13 @@ Allow reboot. If set to '0' the VM exit on reboot. Configure a VirtIO-based Random Number Generator. -`--sata[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: +`--sata[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,import-from=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: -Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. +Use volume as SATA hard disk or CD-ROM (n is 0 to 5). 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. -`--scsi[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,replicate=<1|0>] [,rerror=] [,ro=<1|0>] [,scsiblock=<1|0>] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: +`--scsi[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,import-from=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,replicate=<1|0>] [,rerror=] [,ro=<1|0>] [,scsiblock=<1|0>] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: -Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. +Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). 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. `--scsihw` `` ('default =' `lsi`):: @@ -417,9 +417,9 @@ Enable/disable time drift fix. Enable/disable Template. -`--tpmstate0` `[file=] [,size=] [,version=]` :: +`--tpmstate0` `[file=] [,import-from=] [,size=] [,version=]` :: -Configure a Disk for storing TPM state. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default size of 4 MiB will always be used instead. The format is also fixed to 'raw'. +Configure a Disk for storing TPM state. The format is fixed to 'raw'. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and 4 MiB will be used instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. `--unique` `` :: @@ -443,9 +443,9 @@ Number of hotplugged vcpus. Configure the VGA hardware. -`--virtio[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,ro=<1|0>] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: +`--virtio[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,import-from=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,ro=<1|0>] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: -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 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. `--vmgenid` `` ('default =' `1 (autogenerated)`):: @@ -938,7 +938,7 @@ Emulated CPU type. Limit of CPU usage. -`--cpuunits` ` (2 - 262144)` ('default =' `cgroup v1: 1024, cgroup v2: 100`):: +`--cpuunits` ` (1 - 262144)` ('default =' `cgroup v1: 1024, cgroup v2: 100`):: CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2. @@ -954,9 +954,9 @@ Description for the VM. Shown in the web-interface VM's summary. This is saved a Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. -`--efidisk0` `[file=] [,efitype=<2m|4m>] [,format=] [,pre-enrolled-keys=<1|0>] [,size=]` :: +`--efidisk0` `[file=] [,efitype=<2m|4m>] [,format=] [,import-from=] [,pre-enrolled-keys=<1|0>] [,size=]` :: -Configure a Disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. +Configure a Disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. `--force` `` :: @@ -972,7 +972,7 @@ Freeze CPU at startup (use 'c' monitor command to start execution). Script that will be executed during various steps in the vms lifetime. -`--hostpci[n]` `[host=] [,legacy-igd=<1|0>] [,mdev=] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=] [,x-vga=<1|0>]` :: +`--hostpci[n]` `[host=] [,device-id=] [,legacy-igd=<1|0>] [,mdev=] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=] [,sub-device-id=] [,sub-vendor-id=] [,vendor-id=] [,x-vga=<1|0>]` :: Map host PCI devices into guest. @@ -984,9 +984,9 @@ Selectively enable hotplug features. This is a comma separated list of hotplug f Enable/disable hugepages memory. -`--ide[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: +`--ide[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,import-from=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: -Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. +Use volume as IDE hard disk or CD-ROM (n is 0 to 3). 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. `--ipconfig[n]` `[gw=] [,gw6=] [,ip=] [,ip6=]` :: @@ -1012,7 +1012,7 @@ Use together with hugepages. If enabled, hugepages will not not be deleted after `--keyboard` `` :: -Keyboard layout for VNC server. The default is read from the'/etc/pve/datacenter.cfg' configuration file. It should not be necessary to set it. +Keyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS. `--kvm` `` ('default =' `1`):: @@ -1092,13 +1092,13 @@ Revert a pending change. Configure a VirtIO-based Random Number Generator. -`--sata[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: +`--sata[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,import-from=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: -Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. +Use volume as SATA hard disk or CD-ROM (n is 0 to 5). 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. -`--scsi[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,replicate=<1|0>] [,rerror=] [,ro=<1|0>] [,scsiblock=<1|0>] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: +`--scsi[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,import-from=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,replicate=<1|0>] [,rerror=] [,ro=<1|0>] [,scsiblock=<1|0>] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: -Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. +Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). 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. `--scsihw` `` ('default =' `lsi`):: @@ -1166,9 +1166,9 @@ Enable/disable time drift fix. Enable/disable Template. -`--tpmstate0` `[file=] [,size=] [,version=]` :: +`--tpmstate0` `[file=] [,import-from=] [,size=] [,version=]` :: -Configure a Disk for storing TPM state. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default size of 4 MiB will always be used instead. The format is also fixed to 'raw'. +Configure a Disk for storing TPM state. The format is fixed to 'raw'. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and 4 MiB will be used instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. `--unused[n]` `[file=]` :: @@ -1186,9 +1186,9 @@ Number of hotplugged vcpus. Configure the VGA hardware. -`--virtio[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,ro=<1|0>] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: +`--virtio[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,import-from=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,ro=<1|0>] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: -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 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. `--vmgenid` `` ('default =' `1 (autogenerated)`):: diff --git a/qm.conf.5-opts.adoc b/qm.conf.5-opts.adoc index 3548c2e..a56dc5d 100644 --- a/qm.conf.5-opts.adoc +++ b/qm.conf.5-opts.adoc @@ -131,7 +131,7 @@ Emulated CPU type. Can be default or custom name (custom model names must be pre `flags`=`<+FLAG[;-FLAG...]>` ;; -List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Custom CPU models can specify any flag supported by QEMU/KVM, VM-specific flags must be from the following set for security reasons: pcid, spec-ctrl, ibpb, ssbd, virt-ssbd, amd-ssbd, amd-no-ssb, pdpe1gb, md-clear, hv-tlbflush, hv-evmcs, aes. +List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Custom CPU models can specify any flag supported by QEMU/KVM, VM-specific flags must be from the following set for security reasons: pcid, spec-ctrl, ibpb, ssbd, virt-ssbd, amd-ssbd, amd-no-ssb, pdpe1gb, md-clear, hv-tlbflush, hv-evmcs, aes `hidden`=`` ('default =' `0`);; @@ -155,7 +155,7 @@ Limit of CPU usage. + NOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit. -`cpuunits`: ` (2 - 262144)` ('default =' `cgroup v1: 1024, cgroup v2: 100`):: +`cpuunits`: ` (1 - 262144)` ('default =' `cgroup v1: 1024, cgroup v2: 100`):: CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to weights of all the other running VMs. @@ -165,7 +165,7 @@ Description for the VM. Shown in the web-interface VM's summary. This is saved a `efidisk0`: `[file=] [,efitype=<2m|4m>] [,format=] [,pre-enrolled-keys=<1|0>] [,size=]` :: -Configure a Disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. +Configure a Disk for storing EFI vars. `efitype`=`<2m | 4m>` ('default =' `2m`);; @@ -195,7 +195,7 @@ Freeze CPU at startup (use 'c' monitor command to start execution). Script that will be executed during various steps in the vms lifetime. -`hostpci[n]`: `[host=] [,legacy-igd=<1|0>] [,mdev=] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=] [,x-vga=<1|0>]` :: +`hostpci[n]`: `[host=] [,device-id=] [,legacy-igd=<1|0>] [,mdev=] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=] [,sub-device-id=] [,sub-vendor-id=] [,vendor-id=] [,x-vga=<1|0>]` :: Map host PCI devices into guest. + @@ -204,6 +204,10 @@ possible to migrate such machines - use with special care. + CAUTION: Experimental! User reported problems with this option. +`device-id`=`` ;; + +Override PCI device ID visible to guest + `host`=`` ;; Host PCI device pass through. The PCI ID of a host's PCI device or a list @@ -235,6 +239,18 @@ Specify whether or not the device's ROM will be visible in the guest's memory ma Custom pci device rom filename (must be located in /usr/share/kvm/). +`sub-device-id`=`` ;; + +Override PCI subsystem device ID visible to guest + +`sub-vendor-id`=`` ;; + +Override PCI subsystem vendor ID visible to guest + +`vendor-id`=`` ;; + +Override PCI vendor ID visible to guest + `x-vga`=`` ('default =' `0`);; Enable vfio-vga device support. @@ -249,7 +265,7 @@ Enable/disable hugepages memory. `ide[n]`: `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: -Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. +Use volume as IDE hard disk or CD-ROM (n is 0 to 3). `aio`=`` ;; @@ -477,7 +493,7 @@ Use together with hugepages. If enabled, hugepages will not not be deleted after `keyboard`: `` :: -Keyboard layout for VNC server. The default is read from the'/etc/pve/datacenter.cfg' configuration file. It should not be necessary to set it. +Keyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS. `kvm`: `` ('default =' `1`):: @@ -655,7 +671,7 @@ The file on the host to gather entropy from. In most cases '/dev/urandom' should `sata[n]`: `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: -Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. +Use volume as SATA hard disk or CD-ROM (n is 0 to 5). `aio`=`` ;; @@ -829,7 +845,7 @@ The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'. `scsi[n]`: `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,replicate=<1|0>] [,rerror=] [,ro=<1|0>] [,scsiblock=<1|0>] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: -Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. +Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). `aio`=`` ;; @@ -1130,7 +1146,7 @@ Enable/disable Template. `tpmstate0`: `[file=] [,size=] [,version=]` :: -Configure a Disk for storing TPM state. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default size of 4 MiB will always be used instead. The format is also fixed to 'raw'. +Configure a Disk for storing TPM state. The format is fixed to 'raw'. `file`=`` ;; @@ -1188,13 +1204,13 @@ You can also run without any graphic card, using a serial device as terminal. Sets the VGA memory (in MiB). Has no effect with serial display. -`type`=`` ('default =' `std`);; +`type`=`` ('default =' `std`);; Select the VGA type. `virtio[n]`: `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,ro=<1|0>] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: -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 volume as VIRTIO hard disk (n is 0 to 15). `aio`=`` ;; diff --git a/vzdump.1-synopsis.adoc b/vzdump.1-synopsis.adoc index 369daae..1654299 100644 --- a/vzdump.1-synopsis.adoc +++ b/vzdump.1-synopsis.adoc @@ -60,6 +60,12 @@ Backup mode. Only run if executed on this node. +`--notes-template` `` :: + +Template string for generating notes for the backup(s). It can contain variables which will be replaced by their values. Currently supported are \{\{cluster\}\}, \{\{guestname\}\}, \{\{node\}\}, and \{\{vmid\}\}, but more might be added in the future. ++ +NOTE: Requires option(s): `storage` + `--pigz` `` ('default =' `0`):: Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count. @@ -68,6 +74,12 @@ Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread Backup all known guest systems included in the specified pool. +`--protected` `` :: + +If true, mark backup(s) as protected. ++ +NOTE: Requires option(s): `storage` + `--prune-backups` `[keep-all=<1|0>] [,keep-daily=] [,keep-hourly=] [,keep-last=] [,keep-monthly=] [,keep-weekly=] [,keep-yearly=]` ('default =' `keep-all=1`):: Use these retention options instead of those from the storage configuration. diff --git a/vzdump.conf.5-opts.adoc b/vzdump.conf.5-opts.adoc index f7f0578..0f4dde9 100644 --- a/vzdump.conf.5-opts.adoc +++ b/vzdump.conf.5-opts.adoc @@ -38,6 +38,12 @@ Deprecated: use 'prune-backups' instead. Maximal number of backup files per gues Backup mode. +`notes-template`: `` :: + +Template string for generating notes for the backup(s). It can contain variables which will be replaced by their values. Currently supported are \{\{cluster\}\}, \{\{guestname\}\}, \{\{node\}\}, and \{\{vmid\}\}, but more might be added in the future. ++ +NOTE: Requires option(s): `storage` + `pigz`: `` ('default =' `0`):: Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count. @@ -46,6 +52,12 @@ Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread Backup all known guest systems included in the specified pool. +`protected`: `` :: + +If true, mark backup(s) as protected. ++ +NOTE: Requires option(s): `storage` + `prune-backups`: `[keep-all=<1|0>] [,keep-daily=] [,keep-hourly=] [,keep-last=] [,keep-monthly=] [,keep-weekly=] [,keep-yearly=]` ('default =' `keep-all=1`):: Use these retention options instead of those from the storage configuration.