- "description" : "The VM configuration.",
- "properties" : {
- "acpi" : {
- "default" : 1,
- "description" : "Enable/disable ACPI.",
- "optional" : 1,
- "type" : "boolean"
- },
- "affinity" : {
- "description" : "List of host cores used to execute guest processes, for example: 0,5,8-11",
- "format" : "pve-cpuset",
- "optional" : 1,
- "type" : "string"
- },
- "agent" : {
- "description" : "Enable/disable communication with the QEMU Guest Agent and its properties.",
- "format" : {
- "enabled" : {
- "default" : 0,
- "default_key" : 1,
- "description" : "Enable/disable communication with a QEMU Guest Agent (QGA) running in the VM.",
- "type" : "boolean"
- },
- "freeze-fs-on-backup" : {
- "default" : 1,
- "description" : "Freeze/thaw guest filesystems on backup for consistency.",
- "optional" : 1,
- "type" : "boolean"
- },
- "fstrim_cloned_disks" : {
- "default" : 0,
- "description" : "Run fstrim after moving a disk or migrating the VM.",
- "optional" : 1,
- "type" : "boolean"
- },
- "type" : {
- "default" : "virtio",
- "description" : "Select the agent type",
- "enum" : [
- "virtio",
- "isa"
- ],
- "optional" : 1,
- "type" : "string"
- }
- },
- "optional" : 1,
- "type" : "string"
- },
- "arch" : {
- "description" : "Virtual processor architecture. Defaults to the host.",
- "enum" : [
- "x86_64",
- "aarch64"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "args" : {
- "description" : "Arbitrary arguments passed to kvm.",
- "optional" : 1,
- "type" : "string",
- "verbose_description" : "Arbitrary arguments passed to kvm, for example:\n\nargs: -no-reboot -no-hpet\n\nNOTE: this option is for experts only.\n"
- },
- "audio0" : {
- "description" : "Configure a audio device, useful in combination with QXL/Spice.",
- "format" : {
- "device" : {
- "description" : "Configure an audio device.",
- "enum" : [
- "ich9-intel-hda",
- "intel-hda",
- "AC97"
- ],
- "type" : "string"
- },
- "driver" : {
- "default" : "spice",
- "description" : "Driver backend for the audio device.",
- "enum" : [
- "spice",
- "none"
- ],
- "optional" : 1,
- "type" : "string"
- }
- },
- "optional" : 1,
- "type" : "string"
- },
- "autostart" : {
- "default" : 0,
- "description" : "Automatic restart after crash (currently ignored).",
- "optional" : 1,
- "type" : "boolean"
- },
- "balloon" : {
- "description" : "Amount of target RAM for the VM in MiB. Using zero disables the ballon driver.",
- "minimum" : 0,
- "optional" : 1,
- "type" : "integer"
- },
- "bios" : {
- "default" : "seabios",
- "description" : "Select BIOS implementation.",
- "enum" : [
- "seabios",
- "ovmf"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "boot" : {
- "description" : "Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated.",
- "format" : "pve-qm-boot",
- "optional" : 1,
- "type" : "string"
- },
- "bootdisk" : {
- "description" : "Enable booting from specified disk. Deprecated: Use 'boot: order=foo;bar' instead.",
- "format" : "pve-qm-bootdisk",
- "optional" : 1,
- "pattern" : "(ide|sata|scsi|virtio)\\d+",
- "type" : "string"
- },
- "cdrom" : {
- "description" : "This is an alias for option -ide2",
- "format" : "pve-qm-ide",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<volume>"
- },
- "cicustom" : {
- "description" : "cloud-init: Specify custom files to replace the automatically generated ones at start.",
- "format" : "pve-qm-cicustom",
- "optional" : 1,
- "type" : "string"
- },
- "cipassword" : {
- "description" : "cloud-init: Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords.",
- "optional" : 1,
- "type" : "string"
- },
- "citype" : {
- "description" : "Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows.",
- "enum" : [
- "configdrive2",
- "nocloud",
- "opennebula"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "ciuser" : {
- "description" : "cloud-init: User name to change ssh keys and password for instead of the image's configured default user.",
- "optional" : 1,
- "type" : "string"
- },
- "cores" : {
- "default" : 1,
- "description" : "The number of cores per socket.",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "cpu" : {
- "description" : "Emulated CPU type.",
- "format" : "pve-vm-cpu-conf",
- "optional" : 1,
- "type" : "string"
- },
- "cpulimit" : {
- "default" : 0,
- "description" : "Limit of CPU usage.",
- "maximum" : 128,
- "minimum" : 0,
- "optional" : 1,
- "type" : "number",
- "verbose_description" : "Limit of CPU usage.\n\nNOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit."
- },
- "cpuunits" : {
- "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" : 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."
- },
- "description" : {
- "description" : "Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file.",
- "maxLength" : 8192,
- "optional" : 1,
- "type" : "string"
- },
- "digest" : {
- "description" : "SHA1 digest of configuration file. This can be used to prevent concurrent modifications.",
- "type" : "string"
- },
- "efidisk0" : {
- "description" : "Configure a disk for storing EFI vars.",
- "format" : {
- "efitype" : {
- "default" : "2m",
- "description" : "Size and type of the OVMF EFI vars. '4m' is newer and recommended, and required for Secure Boot. For backwards compatibility, '2m' is used if not otherwise specified. Ignored for VMs with arch=aarc64 (ARM).",
- "enum" : [
- "2m",
- "4m"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "file" : {
- "default_key" : 1,
- "description" : "The drive's backing volume.",
- "format" : "pve-volume-id-or-qm-path",
- "format_description" : "volume",
- "type" : "string"
- },
- "format" : {
- "description" : "The drive's backing file's data format.",
- "enum" : [
- "raw",
- "cow",
- "qcow",
- "qed",
- "qcow2",
- "vmdk",
- "cloop"
- ],
- "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.",
- "optional" : 1,
- "type" : "boolean"
- },
- "size" : {
- "description" : "Disk size. This is purely informational and has no effect.",
- "format" : "disk-size",
- "format_description" : "DiskSize",
- "optional" : 1,
- "type" : "string"
- },
- "volume" : {
- "alias" : "file"
- }
- },
- "optional" : 1,
- "type" : "string"
- },
- "freeze" : {
- "description" : "Freeze CPU at startup (use 'c' monitor command to start execution).",
- "optional" : 1,
- "type" : "boolean"
- },
- "hookscript" : {
- "description" : "Script that will be executed during various steps in the vms lifetime.",
- "format" : "pve-volume-id",
- "optional" : 1,
- "type" : "string"
- },
- "hostpci[n]" : {
- "description" : "Map host PCI devices into guest.",
- "format" : "pve-qm-hostpci",
- "optional" : 1,
- "type" : "string",
- "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" : {
- "default" : "network,disk,usb",
- "description" : "Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory', 'usb' and 'cloudinit'. Use '0' to disable hotplug completely. Using '1' as value is an alias for the default `network,disk,usb`. USB hotplugging is possible for guests with machine version >= 7.1 and ostype l26 or windows > 7.",
- "format" : "pve-hotplug-features",
- "optional" : 1,
- "type" : "string"
- },
- "hugepages" : {
- "description" : "Enable/disable hugepages memory.",
- "enum" : [
- "any",
- "2",
- "1024"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "ide[n]" : {
- "description" : "Use volume as IDE hard disk or CD-ROM (n is 0 to 3).",
- "format" : {
- "aio" : {
- "description" : "AIO type to use.",
- "enum" : [
- "native",
- "threads",
- "io_uring"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "backup" : {
- "description" : "Whether the drive should be included when making backups.",
- "optional" : 1,
- "type" : "boolean"
- },
- "bps" : {
- "description" : "Maximum r/w speed in bytes per second.",
- "format_description" : "bps",
- "optional" : 1,
- "type" : "integer"
- },
- "bps_max_length" : {
- "description" : "Maximum length of I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "bps_rd" : {
- "description" : "Maximum read speed in bytes per second.",
- "format_description" : "bps",
- "optional" : 1,
- "type" : "integer"
- },
- "bps_rd_length" : {
- "alias" : "bps_rd_max_length"
- },
- "bps_rd_max_length" : {
- "description" : "Maximum length of read I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "bps_wr" : {
- "description" : "Maximum write speed in bytes per second.",
- "format_description" : "bps",
- "optional" : 1,
- "type" : "integer"
- },
- "bps_wr_length" : {
- "alias" : "bps_wr_max_length"
- },
- "bps_wr_max_length" : {
- "description" : "Maximum length of write I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "cache" : {
- "description" : "The drive's cache mode",
- "enum" : [
- "none",
- "writethrough",
- "writeback",
- "unsafe",
- "directsync"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "cyls" : {
- "description" : "Force the drive's physical geometry to have a specific cylinder count.",
- "optional" : 1,
- "type" : "integer"
- },
- "detect_zeroes" : {
- "description" : "Controls whether to detect and try to optimize writes of zeroes.",
- "optional" : 1,
- "type" : "boolean"
- },
- "discard" : {
- "description" : "Controls whether to pass discard/trim requests to the underlying storage.",
- "enum" : [
- "ignore",
- "on"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "file" : {
- "default_key" : 1,
- "description" : "The drive's backing volume.",
- "format" : "pve-volume-id-or-qm-path",
- "format_description" : "volume",
- "type" : "string"
- },
- "format" : {
- "description" : "The drive's backing file's data format.",
- "enum" : [
- "raw",
- "cow",
- "qcow",
- "qed",
- "qcow2",
- "vmdk",
- "cloop"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "heads" : {
- "description" : "Force the drive's physical geometry to have a specific head count.",
- "optional" : 1,
- "type" : "integer"
- },
- "iops" : {
- "description" : "Maximum r/w I/O in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_max" : {
- "description" : "Maximum unthrottled r/w I/O pool in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_max_length" : {
- "description" : "Maximum length of I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "iops_rd" : {
- "description" : "Maximum read I/O in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_rd_length" : {
- "alias" : "iops_rd_max_length"
- },
- "iops_rd_max" : {
- "description" : "Maximum unthrottled read I/O pool in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_rd_max_length" : {
- "description" : "Maximum length of read I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "iops_wr" : {
- "description" : "Maximum write I/O in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_wr_length" : {
- "alias" : "iops_wr_max_length"
- },
- "iops_wr_max" : {
- "description" : "Maximum unthrottled write I/O pool in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_wr_max_length" : {
- "description" : "Maximum length of write I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "mbps" : {
- "description" : "Maximum r/w speed in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_max" : {
- "description" : "Maximum unthrottled r/w pool in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_rd" : {
- "description" : "Maximum read speed in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_rd_max" : {
- "description" : "Maximum unthrottled read pool in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_wr" : {
- "description" : "Maximum write speed in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_wr_max" : {
- "description" : "Maximum unthrottled write pool in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "media" : {
- "default" : "disk",
- "description" : "The drive's media type.",
- "enum" : [
- "cdrom",
- "disk"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "model" : {
- "description" : "The drive's reported model name, url-encoded, up to 40 bytes long.",
- "format" : "urlencoded",
- "format_description" : "model",
- "maxLength" : 120,
- "optional" : 1,
- "type" : "string"
- },
- "replicate" : {
- "default" : 1,
- "description" : "Whether the drive should considered for replication jobs.",
- "optional" : 1,
- "type" : "boolean"
- },
- "rerror" : {
- "description" : "Read error action.",
- "enum" : [
- "ignore",
- "report",
- "stop"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "secs" : {
- "description" : "Force the drive's physical geometry to have a specific sector count.",
- "optional" : 1,
- "type" : "integer"
- },
- "serial" : {
- "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long.",
- "format" : "urlencoded",
- "format_description" : "serial",
- "maxLength" : 60,
- "optional" : 1,
- "type" : "string"
- },
- "shared" : {
- "default" : 0,
- "description" : "Mark this locally-managed volume as available on all nodes",
- "optional" : 1,
- "type" : "boolean",
- "verbose_description" : "Mark this locally-managed volume as available on all nodes.\n\nWARNING: This option does not share the volume automatically, it assumes it is shared already!"
- },
- "size" : {
- "description" : "Disk size. This is purely informational and has no effect.",
- "format" : "disk-size",
- "format_description" : "DiskSize",
- "optional" : 1,
- "type" : "string"
- },
- "snapshot" : {
- "description" : "Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.",
- "optional" : 1,
- "type" : "boolean"
- },
- "ssd" : {
- "description" : "Whether to expose this drive as an SSD, rather than a rotational hard disk.",
- "optional" : 1,
- "type" : "boolean"
- },
- "trans" : {
- "description" : "Force disk geometry bios translation mode.",
- "enum" : [
- "none",
- "lba",
- "auto"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "volume" : {
- "alias" : "file"
- },
- "werror" : {
- "description" : "Write error action.",
- "enum" : [
- "enospc",
- "ignore",
- "report",
- "stop"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "wwn" : {
- "description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.",
- "format_description" : "wwn",
- "optional" : 1,
- "pattern" : "(?^:^(0x)[0-9a-fA-F]{16})",
- "type" : "string"
- }
- },
- "optional" : 1,
- "type" : "string"
- },
- "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",
- "format" : "pve-qm-ipconfig",
- "optional" : 1,
- "type" : "string"
- },
- "ivshmem" : {
- "description" : "Inter-VM shared memory. Useful for direct communication between VMs, or to the host.",
- "format" : {
- "name" : {
- "description" : "The name of the file. Will be prefixed with 'pve-shm-'. Default is the VMID. Will be deleted when the VM is stopped.",
- "format_description" : "string",
- "optional" : 1,
- "pattern" : "[a-zA-Z0-9\\-]+",
- "type" : "string"
- },
- "size" : {
- "description" : "The size of the file in MB.",
- "minimum" : 1,
- "type" : "integer"
- }
- },
- "optional" : 1,
- "type" : "string"
- },
- "keephugepages" : {
- "default" : 0,
- "description" : "Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts.",
- "optional" : 1,
- "type" : "boolean"
- },
- "keyboard" : {
- "default" : null,
- "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",
- "da",
- "en-gb",
- "en-us",
- "es",
- "fi",
- "fr",
- "fr-be",
- "fr-ca",
- "fr-ch",
- "hu",
- "is",
- "it",
- "ja",
- "lt",
- "mk",
- "nl",
- "no",
- "pl",
- "pt",
- "pt-br",
- "sv",
- "sl",
- "tr"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "kvm" : {
- "default" : 1,
- "description" : "Enable/disable KVM hardware virtualization.",
- "optional" : 1,
- "type" : "boolean"
- },
- "localtime" : {
- "description" : "Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS.",
- "optional" : 1,
- "type" : "boolean"
- },
- "lock" : {
- "description" : "Lock/unlock the VM.",
- "enum" : [
- "backup",
- "clone",
- "create",
- "migrate",
- "rollback",
- "snapshot",
- "snapshot-delete",
- "suspending",
- "suspended"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "machine" : {
- "description" : "Specifies the QEMU machine type.",
- "maxLength" : 40,
- "optional" : 1,
- "pattern" : "(pc|pc(-i440fx)?-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|q35|pc-q35-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|virt(?:-\\d+(\\.\\d+)+)?(\\+pve\\d+)?)",
- "type" : "string"
- },
- "memory" : {
- "default" : 512,
- "description" : "Amount of RAM for the VM in MiB. This is the maximum available memory when you use the balloon device.",
- "minimum" : 16,
- "optional" : 1,
- "type" : "integer"
- },
- "migrate_downtime" : {
- "default" : 0.1,
- "description" : "Set maximum tolerated downtime (in seconds) for migrations.",
- "minimum" : 0,
- "optional" : 1,
- "type" : "number"
- },
- "migrate_speed" : {
- "default" : 0,
- "description" : "Set maximum speed (in MB/s) for migrations. Value 0 is no limit.",
- "minimum" : 0,
- "optional" : 1,
- "type" : "integer"
- },
- "name" : {
- "description" : "Set a name for the VM. Only used on the configuration web interface.",
- "format" : "dns-name",
- "optional" : 1,
- "type" : "string"
- },
- "nameserver" : {
- "description" : "cloud-init: Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.",
- "format" : "address-list",
- "optional" : 1,
- "type" : "string"
- },
- "net[n]" : {
- "description" : "Specify network devices.",
- "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,
- "type" : "string"
- },
- "e1000" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "e1000-82540em" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "e1000-82544gc" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "e1000-82545em" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "e1000e" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "firewall" : {
- "description" : "Whether this interface should be protected by the firewall.",
- "optional" : 1,
- "type" : "boolean"
- },
- "i82551" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "i82557b" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "i82559er" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "link_down" : {
- "description" : "Whether this interface should be disconnected (like pulling the plug).",
- "optional" : 1,
- "type" : "boolean"
- },
- "macaddr" : {
- "description" : "MAC address. That address must be unique withing your network. This is automatically generated if not specified.",
- "format" : "mac-addr",
- "format_description" : "XX:XX:XX:XX:XX:XX",
- "optional" : 1,
- "type" : "string",
- "verbose_description" : "A common MAC address with the I/G (Individual/Group) bit not set."
- },
- "model" : {
- "default_key" : 1,
- "description" : "Network Card Model. The 'virtio' model provides the best performance with very low CPU overhead. If your guest does not support this driver, it is usually best to use 'e1000'.",
- "enum" : [
- "e1000",
- "e1000-82540em",
- "e1000-82544gc",
- "e1000-82545em",
- "e1000e",
- "i82551",
- "i82557b",
- "i82559er",
- "ne2k_isa",
- "ne2k_pci",
- "pcnet",
- "rtl8139",
- "virtio",
- "vmxnet3"
- ],
- "type" : "string"
- },
- "mtu" : {
- "description" : "Force MTU, for VirtIO only. Set to '1' to use the bridge MTU",
- "maximum" : 65520,
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "ne2k_isa" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "ne2k_pci" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "pcnet" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "queues" : {
- "description" : "Number of packet queues to be used on the device.",
- "maximum" : 64,
- "minimum" : 0,
- "optional" : 1,
- "type" : "integer"
- },
- "rate" : {
- "description" : "Rate limit in mbps (megabytes per second) as floating point number.",
- "minimum" : 0,
- "optional" : 1,
- "type" : "number"
- },
- "rtl8139" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "tag" : {
- "description" : "VLAN tag to apply to packets on this interface.",
- "maximum" : 4094,
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "trunks" : {
- "description" : "VLAN trunks to pass through this interface.",
- "format_description" : "vlanid[;vlanid...]",
- "optional" : 1,
- "pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)",
- "type" : "string"
- },
- "virtio" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "vmxnet3" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- }
- },
- "optional" : 1,
- "type" : "string"
- },
- "numa" : {
- "default" : 0,
- "description" : "Enable/disable NUMA.",
- "optional" : 1,
- "type" : "boolean"
- },
- "numa[n]" : {
- "description" : "NUMA topology.",
- "format" : {
- "cpus" : {
- "description" : "CPUs accessing this NUMA node.",
- "format_description" : "id[-id];...",
- "pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)",
- "type" : "string"
- },
- "hostnodes" : {
- "description" : "Host NUMA nodes to use.",
- "format_description" : "id[-id];...",
- "optional" : 1,
- "pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)",
- "type" : "string"
- },
- "memory" : {
- "description" : "Amount of memory this NUMA node provides.",
- "optional" : 1,
- "type" : "number"
- },
- "policy" : {
- "description" : "NUMA allocation policy.",
- "enum" : [
- "preferred",
- "bind",
- "interleave"
- ],
- "optional" : 1,
- "type" : "string"
- }
- },
- "optional" : 1,
- "type" : "string"
- },
- "onboot" : {
- "default" : 0,
- "description" : "Specifies whether a VM will be started during system bootup.",
- "optional" : 1,
- "type" : "boolean"
- },
- "ostype" : {
- "description" : "Specify guest operating system.",
- "enum" : [
- "other",
- "wxp",
- "w2k",
- "w2k3",
- "w2k8",
- "wvista",
- "win7",
- "win8",
- "win10",
- "win11",
- "l24",
- "l26",
- "solaris"
- ],
- "optional" : 1,
- "type" : "string",
- "verbose_description" : "Specify guest operating system. This is used to enable special\noptimization/features for specific operating systems:\n\n[horizontal]\nother;; unspecified OS\nwxp;; Microsoft Windows XP\nw2k;; Microsoft Windows 2000\nw2k3;; Microsoft Windows 2003\nw2k8;; Microsoft Windows 2008\nwvista;; Microsoft Windows Vista\nwin7;; Microsoft Windows 7\nwin8;; Microsoft Windows 8/2012/2012r2\nwin10;; Microsoft Windows 10/2016/2019\nwin11;; Microsoft Windows 11/2022\nl24;; Linux 2.4 Kernel\nl26;; Linux 2.6 - 6.X Kernel\nsolaris;; Solaris/OpenSolaris/OpenIndiania kernel\n"
- },
- "parallel[n]" : {
- "description" : "Map host parallel devices (n is 0 to 2).",
- "optional" : 1,
- "pattern" : "/dev/parport\\d+|/dev/usb/lp\\d+",
- "type" : "string",
- "verbose_description" : "Map host parallel devices (n is 0 to 2).\n\nNOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such\nmachines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n"
- },
- "protection" : {
- "default" : 0,
- "description" : "Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.",
- "optional" : 1,
- "type" : "boolean"
- },
- "reboot" : {
- "default" : 1,
- "description" : "Allow reboot. If set to '0' the VM exit on reboot.",
- "optional" : 1,
- "type" : "boolean"
- },
- "rng0" : {
- "description" : "Configure a VirtIO-based Random Number Generator.",
- "format" : {
- "max_bytes" : {
- "default" : 1024,
- "description" : "Maximum bytes of entropy allowed to get injected into the guest every 'period' milliseconds. Prefer a lower value when using '/dev/random' as source. Use `0` to disable limiting (potentially dangerous!).",
- "optional" : 1,
- "type" : "integer"
- },
- "period" : {
- "default" : 1000,
- "description" : "Every 'period' milliseconds the entropy-injection quota is reset, allowing the guest to retrieve another 'max_bytes' of entropy.",
- "optional" : 1,
- "type" : "integer"
- },
- "source" : {
- "default_key" : 1,
- "description" : "The file on the host to gather entropy from. In most cases '/dev/urandom' should be preferred over '/dev/random' to avoid entropy-starvation issues on the host. Using urandom does *not* decrease security in any meaningful way, as it's still seeded from real entropy, and the bytes provided will most likely be mixed with real entropy on the guest as well. '/dev/hwrng' can be used to pass through a hardware RNG from the host.",
- "enum" : [
- "/dev/urandom",
- "/dev/random",
- "/dev/hwrng"
- ],
- "type" : "string"
- }
- },
- "optional" : 1,
- "type" : "string"
- },
- "sata[n]" : {
- "description" : "Use volume as SATA hard disk or CD-ROM (n is 0 to 5).",
- "format" : {
- "aio" : {
- "description" : "AIO type to use.",
- "enum" : [
- "native",
- "threads",
- "io_uring"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "backup" : {
- "description" : "Whether the drive should be included when making backups.",
- "optional" : 1,
- "type" : "boolean"
- },
- "bps" : {
- "description" : "Maximum r/w speed in bytes per second.",
- "format_description" : "bps",
- "optional" : 1,
- "type" : "integer"
- },
- "bps_max_length" : {
- "description" : "Maximum length of I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "bps_rd" : {
- "description" : "Maximum read speed in bytes per second.",
- "format_description" : "bps",
- "optional" : 1,
- "type" : "integer"
- },
- "bps_rd_length" : {
- "alias" : "bps_rd_max_length"
- },
- "bps_rd_max_length" : {
- "description" : "Maximum length of read I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "bps_wr" : {
- "description" : "Maximum write speed in bytes per second.",
- "format_description" : "bps",
- "optional" : 1,
- "type" : "integer"
- },
- "bps_wr_length" : {
- "alias" : "bps_wr_max_length"
- },
- "bps_wr_max_length" : {
- "description" : "Maximum length of write I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "cache" : {
- "description" : "The drive's cache mode",
- "enum" : [
- "none",
- "writethrough",
- "writeback",
- "unsafe",
- "directsync"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "cyls" : {
- "description" : "Force the drive's physical geometry to have a specific cylinder count.",
- "optional" : 1,
- "type" : "integer"
- },
- "detect_zeroes" : {
- "description" : "Controls whether to detect and try to optimize writes of zeroes.",
- "optional" : 1,
- "type" : "boolean"
- },
- "discard" : {
- "description" : "Controls whether to pass discard/trim requests to the underlying storage.",
- "enum" : [
- "ignore",
- "on"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "file" : {
- "default_key" : 1,
- "description" : "The drive's backing volume.",
- "format" : "pve-volume-id-or-qm-path",
- "format_description" : "volume",
- "type" : "string"
- },
- "format" : {
- "description" : "The drive's backing file's data format.",
- "enum" : [
- "raw",
- "cow",
- "qcow",
- "qed",
- "qcow2",
- "vmdk",
- "cloop"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "heads" : {
- "description" : "Force the drive's physical geometry to have a specific head count.",
- "optional" : 1,
- "type" : "integer"
- },
- "iops" : {
- "description" : "Maximum r/w I/O in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_max" : {
- "description" : "Maximum unthrottled r/w I/O pool in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_max_length" : {
- "description" : "Maximum length of I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "iops_rd" : {
- "description" : "Maximum read I/O in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_rd_length" : {
- "alias" : "iops_rd_max_length"
- },
- "iops_rd_max" : {
- "description" : "Maximum unthrottled read I/O pool in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_rd_max_length" : {
- "description" : "Maximum length of read I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "iops_wr" : {
- "description" : "Maximum write I/O in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_wr_length" : {
- "alias" : "iops_wr_max_length"
- },
- "iops_wr_max" : {
- "description" : "Maximum unthrottled write I/O pool in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_wr_max_length" : {
- "description" : "Maximum length of write I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "mbps" : {
- "description" : "Maximum r/w speed in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_max" : {
- "description" : "Maximum unthrottled r/w pool in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_rd" : {
- "description" : "Maximum read speed in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_rd_max" : {
- "description" : "Maximum unthrottled read pool in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_wr" : {
- "description" : "Maximum write speed in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_wr_max" : {
- "description" : "Maximum unthrottled write pool in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "media" : {
- "default" : "disk",
- "description" : "The drive's media type.",
- "enum" : [
- "cdrom",
- "disk"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "replicate" : {
- "default" : 1,
- "description" : "Whether the drive should considered for replication jobs.",
- "optional" : 1,
- "type" : "boolean"
- },
- "rerror" : {
- "description" : "Read error action.",
- "enum" : [
- "ignore",
- "report",
- "stop"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "secs" : {
- "description" : "Force the drive's physical geometry to have a specific sector count.",
- "optional" : 1,
- "type" : "integer"
- },
- "serial" : {
- "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long.",
- "format" : "urlencoded",
- "format_description" : "serial",
- "maxLength" : 60,
- "optional" : 1,
- "type" : "string"
- },
- "shared" : {
- "default" : 0,
- "description" : "Mark this locally-managed volume as available on all nodes",
- "optional" : 1,
- "type" : "boolean",
- "verbose_description" : "Mark this locally-managed volume as available on all nodes.\n\nWARNING: This option does not share the volume automatically, it assumes it is shared already!"
- },
- "size" : {
- "description" : "Disk size. This is purely informational and has no effect.",
- "format" : "disk-size",
- "format_description" : "DiskSize",
- "optional" : 1,
- "type" : "string"
- },
- "snapshot" : {
- "description" : "Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.",
- "optional" : 1,
- "type" : "boolean"
- },
- "ssd" : {
- "description" : "Whether to expose this drive as an SSD, rather than a rotational hard disk.",
- "optional" : 1,
- "type" : "boolean"
- },
- "trans" : {
- "description" : "Force disk geometry bios translation mode.",
- "enum" : [
- "none",
- "lba",
- "auto"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "volume" : {
- "alias" : "file"
- },
- "werror" : {
- "description" : "Write error action.",
- "enum" : [
- "enospc",
- "ignore",
- "report",
- "stop"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "wwn" : {
- "description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.",
- "format_description" : "wwn",
- "optional" : 1,
- "pattern" : "(?^:^(0x)[0-9a-fA-F]{16})",
- "type" : "string"
- }
- },
- "optional" : 1,
- "type" : "string"
- },
- "scsi[n]" : {
- "description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 30).",
- "format" : {
- "aio" : {
- "description" : "AIO type to use.",
- "enum" : [
- "native",
- "threads",
- "io_uring"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "backup" : {
- "description" : "Whether the drive should be included when making backups.",
- "optional" : 1,
- "type" : "boolean"
- },
- "bps" : {
- "description" : "Maximum r/w speed in bytes per second.",
- "format_description" : "bps",
- "optional" : 1,
- "type" : "integer"
- },
- "bps_max_length" : {
- "description" : "Maximum length of I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "bps_rd" : {
- "description" : "Maximum read speed in bytes per second.",
- "format_description" : "bps",
- "optional" : 1,
- "type" : "integer"
- },
- "bps_rd_length" : {
- "alias" : "bps_rd_max_length"
- },
- "bps_rd_max_length" : {
- "description" : "Maximum length of read I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "bps_wr" : {
- "description" : "Maximum write speed in bytes per second.",
- "format_description" : "bps",
- "optional" : 1,
- "type" : "integer"
- },
- "bps_wr_length" : {
- "alias" : "bps_wr_max_length"
- },
- "bps_wr_max_length" : {
- "description" : "Maximum length of write I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "cache" : {
- "description" : "The drive's cache mode",
- "enum" : [
- "none",
- "writethrough",
- "writeback",
- "unsafe",
- "directsync"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "cyls" : {
- "description" : "Force the drive's physical geometry to have a specific cylinder count.",
- "optional" : 1,
- "type" : "integer"
- },
- "detect_zeroes" : {
- "description" : "Controls whether to detect and try to optimize writes of zeroes.",
- "optional" : 1,
- "type" : "boolean"
- },
- "discard" : {
- "description" : "Controls whether to pass discard/trim requests to the underlying storage.",
- "enum" : [
- "ignore",
- "on"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "file" : {
- "default_key" : 1,
- "description" : "The drive's backing volume.",
- "format" : "pve-volume-id-or-qm-path",
- "format_description" : "volume",
- "type" : "string"
- },
- "format" : {
- "description" : "The drive's backing file's data format.",
- "enum" : [
- "raw",
- "cow",
- "qcow",
- "qed",
- "qcow2",
- "vmdk",
- "cloop"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "heads" : {
- "description" : "Force the drive's physical geometry to have a specific head count.",
- "optional" : 1,
- "type" : "integer"
- },
- "iops" : {
- "description" : "Maximum r/w I/O in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_max" : {
- "description" : "Maximum unthrottled r/w I/O pool in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_max_length" : {
- "description" : "Maximum length of I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "iops_rd" : {
- "description" : "Maximum read I/O in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_rd_length" : {
- "alias" : "iops_rd_max_length"
- },
- "iops_rd_max" : {
- "description" : "Maximum unthrottled read I/O pool in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_rd_max_length" : {
- "description" : "Maximum length of read I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "iops_wr" : {
- "description" : "Maximum write I/O in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_wr_length" : {
- "alias" : "iops_wr_max_length"
- },
- "iops_wr_max" : {
- "description" : "Maximum unthrottled write I/O pool in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_wr_max_length" : {
- "description" : "Maximum length of write I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "iothread" : {
- "description" : "Whether to use iothreads for this drive",
- "optional" : 1,
- "type" : "boolean"
- },
- "mbps" : {
- "description" : "Maximum r/w speed in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_max" : {
- "description" : "Maximum unthrottled r/w pool in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_rd" : {
- "description" : "Maximum read speed in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_rd_max" : {
- "description" : "Maximum unthrottled read pool in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_wr" : {
- "description" : "Maximum write speed in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_wr_max" : {
- "description" : "Maximum unthrottled write pool in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "media" : {
- "default" : "disk",
- "description" : "The drive's media type.",
- "enum" : [
- "cdrom",
- "disk"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "queues" : {
- "description" : "Number of queues.",
- "minimum" : 2,
- "optional" : 1,
- "type" : "integer"
- },
- "replicate" : {
- "default" : 1,
- "description" : "Whether the drive should considered for replication jobs.",
- "optional" : 1,
- "type" : "boolean"
- },
- "rerror" : {
- "description" : "Read error action.",
- "enum" : [
- "ignore",
- "report",
- "stop"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "ro" : {
- "description" : "Whether the drive is read-only.",
- "optional" : 1,
- "type" : "boolean"
- },
- "scsiblock" : {
- "default" : 0,
- "description" : "whether to use scsi-block for full passthrough of host block device\n\nWARNING: can lead to I/O errors in combination with low memory or high memory fragmentation on host",
- "optional" : 1,
- "type" : "boolean"
- },
- "secs" : {
- "description" : "Force the drive's physical geometry to have a specific sector count.",
- "optional" : 1,
- "type" : "integer"
- },
- "serial" : {
- "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long.",
- "format" : "urlencoded",
- "format_description" : "serial",
- "maxLength" : 60,
- "optional" : 1,
- "type" : "string"
- },
- "shared" : {
- "default" : 0,
- "description" : "Mark this locally-managed volume as available on all nodes",
- "optional" : 1,
- "type" : "boolean",
- "verbose_description" : "Mark this locally-managed volume as available on all nodes.\n\nWARNING: This option does not share the volume automatically, it assumes it is shared already!"
- },
- "size" : {
- "description" : "Disk size. This is purely informational and has no effect.",
- "format" : "disk-size",
- "format_description" : "DiskSize",
- "optional" : 1,
- "type" : "string"
- },
- "snapshot" : {
- "description" : "Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.",
- "optional" : 1,
- "type" : "boolean"
- },
- "ssd" : {
- "description" : "Whether to expose this drive as an SSD, rather than a rotational hard disk.",
- "optional" : 1,
- "type" : "boolean"
- },
- "trans" : {
- "description" : "Force disk geometry bios translation mode.",
- "enum" : [
- "none",
- "lba",
- "auto"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "volume" : {
- "alias" : "file"
- },
- "werror" : {
- "description" : "Write error action.",
- "enum" : [
- "enospc",
- "ignore",
- "report",
- "stop"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "wwn" : {
- "description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.",
- "format_description" : "wwn",
- "optional" : 1,
- "pattern" : "(?^:^(0x)[0-9a-fA-F]{16})",
- "type" : "string"
- }
- },
- "optional" : 1,
- "type" : "string"
- },
- "scsihw" : {
- "default" : "lsi",
- "description" : "SCSI controller model",
- "enum" : [
- "lsi",
- "lsi53c810",
- "virtio-scsi-pci",
- "virtio-scsi-single",
- "megasas",
- "pvscsi"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "searchdomain" : {
- "description" : "cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.",
- "optional" : 1,
- "type" : "string"
- },
- "serial[n]" : {
- "description" : "Create a serial device inside the VM (n is 0 to 3)",
- "optional" : 1,
- "pattern" : "(/dev/.+|socket)",
- "type" : "string",
- "verbose_description" : "Create a serial device inside the VM (n is 0 to 3), and pass through a\nhost serial device (i.e. /dev/ttyS0), or create a unix socket on the\nhost side (use 'qm terminal' to open a terminal connection).\n\nNOTE: If you pass through a host serial device, it is no longer possible to migrate such machines -\nuse with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n"
- },
- "shares" : {
- "default" : 1000,
- "description" : "Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning. Auto-ballooning is done by pvestatd.",
- "maximum" : 50000,
- "minimum" : 0,
- "optional" : 1,
- "type" : "integer"
- },
- "smbios1" : {
- "description" : "Specify SMBIOS type 1 fields.",
- "format" : "pve-qm-smbios1",
- "maxLength" : 512,
- "optional" : 1,
- "type" : "string"
- },
- "smp" : {
- "default" : 1,
- "description" : "The number of CPUs. Please use option -sockets instead.",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "sockets" : {
- "default" : 1,
- "description" : "The number of CPU sockets.",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "spice_enhancements" : {
- "description" : "Configure additional enhancements for SPICE.",
- "format" : {
- "foldersharing" : {
- "default" : "0",
- "description" : "Enable folder sharing via SPICE. Needs Spice-WebDAV daemon installed in the VM.",
- "optional" : 1,
- "type" : "boolean"
- },
- "videostreaming" : {
- "default" : "off",
- "description" : "Enable video streaming. Uses compression for detected video streams.",
- "enum" : [
- "off",
- "all",
- "filter"
- ],
- "optional" : 1,
- "type" : "string"
- }
- },
- "optional" : 1,
- "type" : "string"
- },
- "sshkeys" : {
- "description" : "cloud-init: Setup public SSH keys (one key per line, OpenSSH format).",
- "format" : "urlencoded",
- "optional" : 1,
- "type" : "string"
- },
- "startdate" : {
- "default" : "now",
- "description" : "Set the initial date of the real time clock. Valid format for date are:'now' or '2006-06-17T16:01:21' or '2006-06-17'.",
- "optional" : 1,
- "pattern" : "(now|\\d{4}-\\d{1,2}-\\d{1,2}(T\\d{1,2}:\\d{1,2}:\\d{1,2})?)",
- "type" : "string",
- "typetext" : "(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)"
- },
- "startup" : {
- "description" : "Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.",
- "format" : "pve-startup-order",
- "optional" : 1,
- "type" : "string",
- "typetext" : "[[order=]\\d+] [,up=\\d+] [,down=\\d+] "
- },
- "tablet" : {
- "default" : 1,
- "description" : "Enable/disable the USB tablet device.",
- "optional" : 1,
- "type" : "boolean",
- "verbose_description" : "Enable/disable the USB tablet device. This device is usually needed to allow absolute mouse positioning with VNC. Else the mouse runs out of sync with normal VNC clients. If you're running lots of console-only guests on one host, you may consider disabling this to save some context switches. This is turned off by default if you use spice (`qm set <vmid> --vga qxl`)."
- },
- "tags" : {
- "description" : "Tags of the VM. This is only meta information.",
- "format" : "pve-tag-list",
- "optional" : 1,
- "type" : "string"
- },
- "tdf" : {
- "default" : 0,
- "description" : "Enable/disable time drift fix.",
- "optional" : 1,
- "type" : "boolean"
- },
- "template" : {
- "default" : 0,
- "description" : "Enable/disable Template.",
- "optional" : 1,
- "type" : "boolean"
- },
- "tpmstate0" : {
- "description" : "Configure a Disk for storing TPM state. The format is fixed to 'raw'.",
- "format" : {
- "file" : {
- "default_key" : 1,
- "description" : "The drive's backing volume.",
- "format" : "pve-volume-id-or-qm-path",
- "format_description" : "volume",
- "type" : "string"
- },
- "size" : {
- "description" : "Disk size. This is purely informational and has no effect.",
- "format" : "disk-size",
- "format_description" : "DiskSize",
- "optional" : 1,
- "type" : "string"
- },
- "version" : {
- "default" : "v2.0",
- "description" : "The TPM interface version. v2.0 is newer and should be preferred. Note that this cannot be changed later on.",
- "enum" : [
- "v1.2",
- "v2.0"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "volume" : {
- "alias" : "file"
- }
- },
- "optional" : 1,
- "type" : "string"
- },
- "unused[n]" : {
- "description" : "Reference to unused volumes. This is used internally, and should not be modified manually.",
- "format" : {
- "file" : {
- "default_key" : 1,
- "description" : "The drive's backing volume.",
- "format" : "pve-volume-id",
- "format_description" : "volume",
- "type" : "string"
- },
- "volume" : {
- "alias" : "file"
- }
- },
- "optional" : 1,
- "type" : "string"
- },
- "usb[n]" : {
- "description" : "Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14).",
- "format" : {
- "host" : {
- "default_key" : 1,
- "description" : "The Host USB device or port or the value 'spice'. HOSTUSBDEVICE syntax is:\n\n 'bus-port(.port)*' (decimal numbers) or\n 'vendor_id:product_id' (hexadeciaml numbers) or\n 'spice'\n\nYou can use the 'lsusb -t' command to list existing usb devices.\n\nNOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such\nmachines - use with special care.\n\nThe value 'spice' can be used to add a usb redirection devices for spice.\n",
- "format" : "pve-qm-usb-device",
- "format_description" : "HOSTUSBDEVICE|spice",
- "type" : "string"
- },
- "usb3" : {
- "default" : 0,
- "description" : "Specifies whether if given host option is a USB3 device or port. For modern guests (machine version >= 7.1 and ostype l26 and windows > 7), this flag is irrelevant (all devices are plugged into a xhci controller).",
- "optional" : 1,
- "type" : "boolean"
- }
- },
- "optional" : 1,
- "type" : "string"
- },
- "vcpus" : {
- "default" : 0,
- "description" : "Number of hotplugged vcpus.",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "vga" : {
- "description" : "Configure the VGA hardware.",
- "format" : {
- "memory" : {
- "description" : "Sets the VGA memory (in MiB). Has no effect with serial display.",
- "maximum" : 512,
- "minimum" : 4,
- "optional" : 1,
- "type" : "integer"
- },
- "type" : {
- "default" : "std",
- "default_key" : 1,
- "description" : "Select the VGA type.",
- "enum" : [
- "cirrus",
- "qxl",
- "qxl2",
- "qxl3",
- "qxl4",
- "none",
- "serial0",
- "serial1",
- "serial2",
- "serial3",
- "std",
- "virtio",
- "virtio-gl",
- "vmware"
- ],
- "optional" : 1,
- "type" : "string"
- }
- },
- "optional" : 1,
- "type" : "string",
- "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).",
- "format" : {
- "aio" : {
- "description" : "AIO type to use.",
- "enum" : [
- "native",
- "threads",
- "io_uring"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "backup" : {
- "description" : "Whether the drive should be included when making backups.",
- "optional" : 1,
- "type" : "boolean"
- },
- "bps" : {
- "description" : "Maximum r/w speed in bytes per second.",
- "format_description" : "bps",
- "optional" : 1,
- "type" : "integer"
- },
- "bps_max_length" : {
- "description" : "Maximum length of I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "bps_rd" : {
- "description" : "Maximum read speed in bytes per second.",
- "format_description" : "bps",
- "optional" : 1,
- "type" : "integer"
- },
- "bps_rd_length" : {
- "alias" : "bps_rd_max_length"
- },
- "bps_rd_max_length" : {
- "description" : "Maximum length of read I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "bps_wr" : {
- "description" : "Maximum write speed in bytes per second.",
- "format_description" : "bps",
- "optional" : 1,
- "type" : "integer"
- },
- "bps_wr_length" : {
- "alias" : "bps_wr_max_length"
- },
- "bps_wr_max_length" : {
- "description" : "Maximum length of write I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "cache" : {
- "description" : "The drive's cache mode",
- "enum" : [
- "none",
- "writethrough",
- "writeback",
- "unsafe",
- "directsync"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "cyls" : {
- "description" : "Force the drive's physical geometry to have a specific cylinder count.",
- "optional" : 1,
- "type" : "integer"
- },
- "detect_zeroes" : {
- "description" : "Controls whether to detect and try to optimize writes of zeroes.",
- "optional" : 1,
- "type" : "boolean"
- },
- "discard" : {
- "description" : "Controls whether to pass discard/trim requests to the underlying storage.",
- "enum" : [
- "ignore",
- "on"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "file" : {
- "default_key" : 1,
- "description" : "The drive's backing volume.",
- "format" : "pve-volume-id-or-qm-path",
- "format_description" : "volume",
- "type" : "string"
- },
- "format" : {
- "description" : "The drive's backing file's data format.",
- "enum" : [
- "raw",
- "cow",
- "qcow",
- "qed",
- "qcow2",
- "vmdk",
- "cloop"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "heads" : {
- "description" : "Force the drive's physical geometry to have a specific head count.",
- "optional" : 1,
- "type" : "integer"
- },
- "iops" : {
- "description" : "Maximum r/w I/O in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_max" : {
- "description" : "Maximum unthrottled r/w I/O pool in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_max_length" : {
- "description" : "Maximum length of I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "iops_rd" : {
- "description" : "Maximum read I/O in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_rd_length" : {
- "alias" : "iops_rd_max_length"
- },
- "iops_rd_max" : {
- "description" : "Maximum unthrottled read I/O pool in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_rd_max_length" : {
- "description" : "Maximum length of read I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "iops_wr" : {
- "description" : "Maximum write I/O in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_wr_length" : {
- "alias" : "iops_wr_max_length"
- },
- "iops_wr_max" : {
- "description" : "Maximum unthrottled write I/O pool in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_wr_max_length" : {
- "description" : "Maximum length of write I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "iothread" : {
- "description" : "Whether to use iothreads for this drive",
- "optional" : 1,
- "type" : "boolean"
- },
- "mbps" : {
- "description" : "Maximum r/w speed in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_max" : {
- "description" : "Maximum unthrottled r/w pool in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_rd" : {
- "description" : "Maximum read speed in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_rd_max" : {
- "description" : "Maximum unthrottled read pool in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_wr" : {
- "description" : "Maximum write speed in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_wr_max" : {
- "description" : "Maximum unthrottled write pool in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "media" : {
- "default" : "disk",
- "description" : "The drive's media type.",
- "enum" : [
- "cdrom",
- "disk"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "replicate" : {
- "default" : 1,
- "description" : "Whether the drive should considered for replication jobs.",
- "optional" : 1,
- "type" : "boolean"
- },
- "rerror" : {
- "description" : "Read error action.",
- "enum" : [
- "ignore",
- "report",
- "stop"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "ro" : {
- "description" : "Whether the drive is read-only.",
- "optional" : 1,
- "type" : "boolean"
- },
- "secs" : {
- "description" : "Force the drive's physical geometry to have a specific sector count.",
- "optional" : 1,
- "type" : "integer"
- },
- "serial" : {
- "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long.",
- "format" : "urlencoded",
- "format_description" : "serial",
- "maxLength" : 60,
- "optional" : 1,
- "type" : "string"
- },
- "shared" : {
- "default" : 0,
- "description" : "Mark this locally-managed volume as available on all nodes",
- "optional" : 1,
- "type" : "boolean",
- "verbose_description" : "Mark this locally-managed volume as available on all nodes.\n\nWARNING: This option does not share the volume automatically, it assumes it is shared already!"
- },
- "size" : {
- "description" : "Disk size. This is purely informational and has no effect.",
- "format" : "disk-size",
- "format_description" : "DiskSize",
- "optional" : 1,
- "type" : "string"
- },
- "snapshot" : {
- "description" : "Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.",
- "optional" : 1,
- "type" : "boolean"
- },
- "trans" : {
- "description" : "Force disk geometry bios translation mode.",
- "enum" : [
- "none",
- "lba",
- "auto"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "volume" : {
- "alias" : "file"
- },
- "werror" : {
- "description" : "Write error action.",
- "enum" : [
- "enospc",
- "ignore",
- "report",
- "stop"
- ],
- "optional" : 1,
- "type" : "string"
- }
- },
- "optional" : 1,
- "type" : "string"
- },
- "vmgenid" : {
- "default" : "1 (autogenerated)",
- "description" : "Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly.",
- "format_description" : "UUID",
- "optional" : 1,
- "pattern" : "(?:[a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}|[01])",
- "type" : "string",
- "verbose_description" : "The VM generation ID (vmgenid) device exposes a 128-bit integer value identifier to the guest OS. This allows to notify the guest operating system when the virtual machine is executed with a different configuration (e.g. snapshot execution or creation from a template). The guest operating system notices the change, and is then able to react as appropriate by marking its copies of distributed databases as dirty, re-initializing its random number generator, etc.\nNote that auto-creation only works when done through API/CLI create or update methods, but not when manually editing the config file."
- },
- "vmstatestorage" : {
- "description" : "Default storage for VM state volumes/files.",
- "format" : "pve-storage-id",
- "optional" : 1,
- "type" : "string"
- },
- "watchdog" : {
- "description" : "Create a virtual hardware watchdog device.",
- "format" : "pve-qm-watchdog",
- "optional" : 1,
- "type" : "string",
- "verbose_description" : "Create a virtual hardware watchdog device. Once enabled (by a guest action), the watchdog must be periodically polled by an agent inside the guest or else the watchdog will reset the guest (or execute the respective action specified)"
- }
- },
- "type" : "object"
- }
- },
- "POST" : {
- "allowtoken" : 1,
- "description" : "Set virtual machine options (asynchrounous API).",
- "method" : "POST",
- "name" : "update_vm_async",
- "parameters" : {
- "additionalProperties" : 0,
- "properties" : {
- "acpi" : {
- "default" : 1,
- "description" : "Enable/disable ACPI.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "affinity" : {
- "description" : "List of host cores used to execute guest processes, for example: 0,5,8-11",
- "format" : "pve-cpuset",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "agent" : {
- "description" : "Enable/disable communication with the QEMU Guest Agent and its properties.",
- "format" : {
- "enabled" : {
- "default" : 0,
- "default_key" : 1,
- "description" : "Enable/disable communication with a QEMU Guest Agent (QGA) running in the VM.",
- "type" : "boolean"
- },
- "freeze-fs-on-backup" : {
- "default" : 1,
- "description" : "Freeze/thaw guest filesystems on backup for consistency.",
- "optional" : 1,
- "type" : "boolean"
- },
- "fstrim_cloned_disks" : {
- "default" : 0,
- "description" : "Run fstrim after moving a disk or migrating the VM.",
- "optional" : 1,
- "type" : "boolean"
- },
- "type" : {
- "default" : "virtio",
- "description" : "Select the agent type",
- "enum" : [
- "virtio",
- "isa"
- ],
- "optional" : 1,
- "type" : "string"
- }
- },
- "optional" : 1,
- "type" : "string",
- "typetext" : "[enabled=]<1|0> [,freeze-fs-on-backup=<1|0>] [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]"
- },
- "arch" : {
- "description" : "Virtual processor architecture. Defaults to the host.",
- "enum" : [
- "x86_64",
- "aarch64"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "args" : {
- "description" : "Arbitrary arguments passed to kvm.",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>",
- "verbose_description" : "Arbitrary arguments passed to kvm, for example:\n\nargs: -no-reboot -no-hpet\n\nNOTE: this option is for experts only.\n"
- },
- "audio0" : {
- "description" : "Configure a audio device, useful in combination with QXL/Spice.",
- "format" : {
- "device" : {
- "description" : "Configure an audio device.",
- "enum" : [
- "ich9-intel-hda",
- "intel-hda",
- "AC97"
- ],
- "type" : "string"
- },
- "driver" : {
- "default" : "spice",
- "description" : "Driver backend for the audio device.",
- "enum" : [
- "spice",
- "none"
- ],
- "optional" : 1,
- "type" : "string"
- }
- },
- "optional" : 1,
- "type" : "string",
- "typetext" : "device=<ich9-intel-hda|intel-hda|AC97> [,driver=<spice|none>]"
- },
- "autostart" : {
- "default" : 0,
- "description" : "Automatic restart after crash (currently ignored).",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "background_delay" : {
- "description" : "Time to wait for the task to finish. We return 'null' if the task finish within that time.",
- "maximum" : 30,
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - 30)"
- },
- "balloon" : {
- "description" : "Amount of target RAM for the VM in MiB. Using zero disables the ballon driver.",
- "minimum" : 0,
- "optional" : 1,
- "type" : "integer",
- "typetext" : "<integer> (0 - N)"
- },
- "bios" : {
- "default" : "seabios",
- "description" : "Select BIOS implementation.",
- "enum" : [
- "seabios",
- "ovmf"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "boot" : {
- "description" : "Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated.",
- "format" : "pve-qm-boot",
- "optional" : 1,
- "type" : "string",
- "typetext" : "[[legacy=]<[acdn]{1,4}>] [,order=<device[;device...]>]"
- },
- "bootdisk" : {
- "description" : "Enable booting from specified disk. Deprecated: Use 'boot: order=foo;bar' instead.",
- "format" : "pve-qm-bootdisk",
- "optional" : 1,
- "pattern" : "(ide|sata|scsi|virtio)\\d+",
- "type" : "string"
- },
- "cdrom" : {
- "description" : "This is an alias for option -ide2",
- "format" : "pve-qm-ide",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<volume>"
- },
- "cicustom" : {
- "description" : "cloud-init: Specify custom files to replace the automatically generated ones at start.",
- "format" : "pve-qm-cicustom",
- "optional" : 1,
- "type" : "string",
- "typetext" : "[meta=<volume>] [,network=<volume>] [,user=<volume>] [,vendor=<volume>]"
- },
- "cipassword" : {
- "description" : "cloud-init: Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords.",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "citype" : {
- "description" : "Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows.",
- "enum" : [
- "configdrive2",
- "nocloud",
- "opennebula"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "ciuser" : {
- "description" : "cloud-init: User name to change ssh keys and password for instead of the image's configured default user.",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "cores" : {
- "default" : 1,
- "description" : "The number of cores per socket.",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- },
- "cpu" : {
- "description" : "Emulated CPU type.",
- "format" : "pve-vm-cpu-conf",
- "optional" : 1,
- "type" : "string",
- "typetext" : "[[cputype=]<string>] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>] [,phys-bits=<8-64|host>] [,reported-model=<enum>]"
- },
- "cpulimit" : {
- "default" : 0,
- "description" : "Limit of CPU usage.",
- "maximum" : 128,
- "minimum" : 0,
- "optional" : 1,
- "type" : "number",
- "typetext" : "<number> (0 - 128)",
- "verbose_description" : "Limit of CPU usage.\n\nNOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit."
- },
- "cpuunits" : {
- "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" : 1,
- "optional" : 1,
- "type" : "integer",
- "typetext" : "<integer> (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" : {
- "description" : "A list of settings you want to delete.",
- "format" : "pve-configid-list",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "description" : {
- "description" : "Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file.",
- "maxLength" : 8192,
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "digest" : {
- "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
- "maxLength" : 40,
- "optional" : 1,
- "type" : "string",
- "typetext" : "<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. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume.",
- "format" : {
- "efitype" : {
- "default" : "2m",
- "description" : "Size and type of the OVMF EFI vars. '4m' is newer and recommended, and required for Secure Boot. For backwards compatibility, '2m' is used if not otherwise specified. Ignored for VMs with arch=aarc64 (ARM).",
- "enum" : [
- "2m",
- "4m"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "file" : {
- "default_key" : 1,
- "description" : "The drive's backing volume.",
- "format" : "pve-volume-id-or-qm-path",
- "format_description" : "volume",
- "type" : "string"
- },
- "format" : {
- "description" : "The drive's backing file's data format.",
- "enum" : [
- "raw",
- "cow",
- "qcow",
- "qed",
- "qcow2",
- "vmdk",
- "cloop"
- ],
- "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.",
- "optional" : 1,
- "type" : "boolean"
- },
- "size" : {
- "description" : "Disk size. This is purely informational and has no effect.",
- "format" : "disk-size",
- "format_description" : "DiskSize",
- "optional" : 1,
- "type" : "string"
- },
- "volume" : {
- "alias" : "file"
- }
- },
- "optional" : 1,
- "type" : "string",
- "typetext" : "[file=]<volume> [,efitype=<2m|4m>] [,format=<enum>] [,import-from=<source volume>] [,pre-enrolled-keys=<1|0>] [,size=<DiskSize>]"
- },
- "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.",
- "optional" : 1,
- "requires" : "delete",
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "freeze" : {
- "description" : "Freeze CPU at startup (use 'c' monitor command to start execution).",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "hookscript" : {
- "description" : "Script that will be executed during various steps in the vms lifetime.",
- "format" : "pve-volume-id",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "hostpci[n]" : {
- "description" : "Map host PCI devices into guest.",
- "format" : "pve-qm-hostpci",
- "optional" : 1,
- "type" : "string",
- "typetext" : "[host=]<HOSTPCIID[;HOSTPCIID2...]> [,device-id=<hex id>] [,legacy-igd=<1|0>] [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,sub-device-id=<hex id>] [,sub-vendor-id=<hex id>] [,vendor-id=<hex 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" : {
- "default" : "network,disk,usb",
- "description" : "Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory', 'usb' and 'cloudinit'. Use '0' to disable hotplug completely. Using '1' as value is an alias for the default `network,disk,usb`. USB hotplugging is possible for guests with machine version >= 7.1 and ostype l26 or windows > 7.",
- "format" : "pve-hotplug-features",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "hugepages" : {
- "description" : "Enable/disable hugepages memory.",
- "enum" : [
- "any",
- "2",
- "1024"
- ],
- "optional" : 1,
- "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. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume.",
- "format" : {
- "aio" : {
- "description" : "AIO type to use.",
- "enum" : [
- "native",
- "threads",
- "io_uring"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "backup" : {
- "description" : "Whether the drive should be included when making backups.",
- "optional" : 1,
- "type" : "boolean"
- },
- "bps" : {
- "description" : "Maximum r/w speed in bytes per second.",
- "format_description" : "bps",
- "optional" : 1,
- "type" : "integer"
- },
- "bps_max_length" : {
- "description" : "Maximum length of I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "bps_rd" : {
- "description" : "Maximum read speed in bytes per second.",
- "format_description" : "bps",
- "optional" : 1,
- "type" : "integer"
- },
- "bps_rd_length" : {
- "alias" : "bps_rd_max_length"
- },
- "bps_rd_max_length" : {
- "description" : "Maximum length of read I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "bps_wr" : {
- "description" : "Maximum write speed in bytes per second.",
- "format_description" : "bps",
- "optional" : 1,
- "type" : "integer"
- },
- "bps_wr_length" : {
- "alias" : "bps_wr_max_length"
- },
- "bps_wr_max_length" : {
- "description" : "Maximum length of write I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "cache" : {
- "description" : "The drive's cache mode",
- "enum" : [
- "none",
- "writethrough",
- "writeback",
- "unsafe",
- "directsync"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "cyls" : {
- "description" : "Force the drive's physical geometry to have a specific cylinder count.",
- "optional" : 1,
- "type" : "integer"
- },
- "detect_zeroes" : {
- "description" : "Controls whether to detect and try to optimize writes of zeroes.",
- "optional" : 1,
- "type" : "boolean"
- },
- "discard" : {
- "description" : "Controls whether to pass discard/trim requests to the underlying storage.",
- "enum" : [
- "ignore",
- "on"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "file" : {
- "default_key" : 1,
- "description" : "The drive's backing volume.",
- "format" : "pve-volume-id-or-qm-path",
- "format_description" : "volume",
- "type" : "string"
- },
- "format" : {
- "description" : "The drive's backing file's data format.",
- "enum" : [
- "raw",
- "cow",
- "qcow",
- "qed",
- "qcow2",
- "vmdk",
- "cloop"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "heads" : {
- "description" : "Force the drive's physical geometry to have a specific head count.",
- "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",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_max" : {
- "description" : "Maximum unthrottled r/w I/O pool in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_max_length" : {
- "description" : "Maximum length of I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "iops_rd" : {
- "description" : "Maximum read I/O in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_rd_length" : {
- "alias" : "iops_rd_max_length"
- },
- "iops_rd_max" : {
- "description" : "Maximum unthrottled read I/O pool in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_rd_max_length" : {
- "description" : "Maximum length of read I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "iops_wr" : {
- "description" : "Maximum write I/O in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_wr_length" : {
- "alias" : "iops_wr_max_length"
- },
- "iops_wr_max" : {
- "description" : "Maximum unthrottled write I/O pool in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_wr_max_length" : {
- "description" : "Maximum length of write I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "mbps" : {
- "description" : "Maximum r/w speed in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_max" : {
- "description" : "Maximum unthrottled r/w pool in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_rd" : {
- "description" : "Maximum read speed in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_rd_max" : {
- "description" : "Maximum unthrottled read pool in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_wr" : {
- "description" : "Maximum write speed in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_wr_max" : {
- "description" : "Maximum unthrottled write pool in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "media" : {
- "default" : "disk",
- "description" : "The drive's media type.",
- "enum" : [
- "cdrom",
- "disk"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "model" : {
- "description" : "The drive's reported model name, url-encoded, up to 40 bytes long.",
- "format" : "urlencoded",
- "format_description" : "model",
- "maxLength" : 120,
- "optional" : 1,
- "type" : "string"
- },
- "replicate" : {
- "default" : 1,
- "description" : "Whether the drive should considered for replication jobs.",
- "optional" : 1,
- "type" : "boolean"
- },
- "rerror" : {
- "description" : "Read error action.",
- "enum" : [
- "ignore",
- "report",
- "stop"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "secs" : {
- "description" : "Force the drive's physical geometry to have a specific sector count.",
- "optional" : 1,
- "type" : "integer"
- },
- "serial" : {
- "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long.",
- "format" : "urlencoded",
- "format_description" : "serial",
- "maxLength" : 60,
- "optional" : 1,
- "type" : "string"
- },
- "shared" : {
- "default" : 0,
- "description" : "Mark this locally-managed volume as available on all nodes",
- "optional" : 1,
- "type" : "boolean",
- "verbose_description" : "Mark this locally-managed volume as available on all nodes.\n\nWARNING: This option does not share the volume automatically, it assumes it is shared already!"
- },
- "size" : {
- "description" : "Disk size. This is purely informational and has no effect.",
- "format" : "disk-size",
- "format_description" : "DiskSize",
- "optional" : 1,
- "type" : "string"
- },
- "snapshot" : {
- "description" : "Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.",
- "optional" : 1,
- "type" : "boolean"
- },
- "ssd" : {
- "description" : "Whether to expose this drive as an SSD, rather than a rotational hard disk.",
- "optional" : 1,
- "type" : "boolean"
- },
- "trans" : {
- "description" : "Force disk geometry bios translation mode.",
- "enum" : [
- "none",
- "lba",
- "auto"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "volume" : {
- "alias" : "file"
- },
- "werror" : {
- "description" : "Write error action.",
- "enum" : [
- "enospc",
- "ignore",
- "report",
- "stop"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "wwn" : {
- "description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.",
- "format_description" : "wwn",
- "optional" : 1,
- "pattern" : "(?^:^(0x)[0-9a-fA-F]{16})",
- "type" : "string"
- }
- },
- "optional" : 1,
- "type" : "string",
- "typetext" : "[file=]<volume> [,aio=<native|threads|io_uring>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,import-from=<source volume>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]"
- },
- "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",
- "format" : "pve-qm-ipconfig",
- "optional" : 1,
- "type" : "string",
- "typetext" : "[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]"
- },
- "ivshmem" : {
- "description" : "Inter-VM shared memory. Useful for direct communication between VMs, or to the host.",
- "format" : {
- "name" : {
- "description" : "The name of the file. Will be prefixed with 'pve-shm-'. Default is the VMID. Will be deleted when the VM is stopped.",
- "format_description" : "string",
- "optional" : 1,
- "pattern" : "[a-zA-Z0-9\\-]+",
- "type" : "string"
- },
- "size" : {
- "description" : "The size of the file in MB.",
- "minimum" : 1,
- "type" : "integer"
- }
- },
- "optional" : 1,
- "type" : "string",
- "typetext" : "size=<integer> [,name=<string>]"
- },
- "keephugepages" : {
- "default" : 0,
- "description" : "Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "keyboard" : {
- "default" : null,
- "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",
- "da",
- "en-gb",
- "en-us",
- "es",
- "fi",
- "fr",
- "fr-be",
- "fr-ca",
- "fr-ch",
- "hu",
- "is",
- "it",
- "ja",
- "lt",
- "mk",
- "nl",
- "no",
- "pl",
- "pt",
- "pt-br",
- "sv",
- "sl",
- "tr"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "kvm" : {
- "default" : 1,
- "description" : "Enable/disable KVM hardware virtualization.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "localtime" : {
- "description" : "Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "lock" : {
- "description" : "Lock/unlock the VM.",
- "enum" : [
- "backup",
- "clone",
- "create",
- "migrate",
- "rollback",
- "snapshot",
- "snapshot-delete",
- "suspending",
- "suspended"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "machine" : {
- "description" : "Specifies the QEMU machine type.",
- "maxLength" : 40,
- "optional" : 1,
- "pattern" : "(pc|pc(-i440fx)?-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|q35|pc-q35-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|virt(?:-\\d+(\\.\\d+)+)?(\\+pve\\d+)?)",
- "type" : "string"
- },
- "memory" : {
- "default" : 512,
- "description" : "Amount of RAM for the VM in MiB. This is the maximum available memory when you use the balloon device.",
- "minimum" : 16,
- "optional" : 1,
- "type" : "integer",
- "typetext" : "<integer> (16 - N)"
- },
- "migrate_downtime" : {
- "default" : 0.1,
- "description" : "Set maximum tolerated downtime (in seconds) for migrations.",
- "minimum" : 0,
- "optional" : 1,
- "type" : "number",
- "typetext" : "<number> (0 - N)"
- },
- "migrate_speed" : {
- "default" : 0,
- "description" : "Set maximum speed (in MB/s) for migrations. Value 0 is no limit.",
- "minimum" : 0,
- "optional" : 1,
- "type" : "integer",
- "typetext" : "<integer> (0 - N)"
- },
- "name" : {
- "description" : "Set a name for the VM. Only used on the configuration web interface.",
- "format" : "dns-name",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "nameserver" : {
- "description" : "cloud-init: Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.",
- "format" : "address-list",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "net[n]" : {
- "description" : "Specify network devices.",
- "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,
- "type" : "string"
- },
- "e1000" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "e1000-82540em" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "e1000-82544gc" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "e1000-82545em" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "e1000e" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "firewall" : {
- "description" : "Whether this interface should be protected by the firewall.",
- "optional" : 1,
- "type" : "boolean"
- },
- "i82551" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "i82557b" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "i82559er" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "link_down" : {
- "description" : "Whether this interface should be disconnected (like pulling the plug).",
- "optional" : 1,
- "type" : "boolean"
- },
- "macaddr" : {
- "description" : "MAC address. That address must be unique withing your network. This is automatically generated if not specified.",
- "format" : "mac-addr",
- "format_description" : "XX:XX:XX:XX:XX:XX",
- "optional" : 1,
- "type" : "string",
- "verbose_description" : "A common MAC address with the I/G (Individual/Group) bit not set."
- },
- "model" : {
- "default_key" : 1,
- "description" : "Network Card Model. The 'virtio' model provides the best performance with very low CPU overhead. If your guest does not support this driver, it is usually best to use 'e1000'.",
- "enum" : [
- "e1000",
- "e1000-82540em",
- "e1000-82544gc",
- "e1000-82545em",
- "e1000e",
- "i82551",
- "i82557b",
- "i82559er",
- "ne2k_isa",
- "ne2k_pci",
- "pcnet",
- "rtl8139",
- "virtio",
- "vmxnet3"
- ],
- "type" : "string"
- },
- "mtu" : {
- "description" : "Force MTU, for VirtIO only. Set to '1' to use the bridge MTU",
- "maximum" : 65520,
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "ne2k_isa" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "ne2k_pci" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "pcnet" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "queues" : {
- "description" : "Number of packet queues to be used on the device.",
- "maximum" : 64,
- "minimum" : 0,
- "optional" : 1,
- "type" : "integer"
- },
- "rate" : {
- "description" : "Rate limit in mbps (megabytes per second) as floating point number.",
- "minimum" : 0,
- "optional" : 1,
- "type" : "number"
- },
- "rtl8139" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "tag" : {
- "description" : "VLAN tag to apply to packets on this interface.",
- "maximum" : 4094,
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "trunks" : {
- "description" : "VLAN trunks to pass through this interface.",
- "format_description" : "vlanid[;vlanid...]",
- "optional" : 1,
- "pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)",
- "type" : "string"
- },
- "virtio" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "vmxnet3" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- }
- },
- "optional" : 1,
- "type" : "string",
- "typetext" : "[model=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,mtu=<integer>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]"
- },
- "node" : {
- "description" : "The cluster node name.",
- "format" : "pve-node",
- "type" : "string",
- "typetext" : "<string>"
- },
- "numa" : {
- "default" : 0,
- "description" : "Enable/disable NUMA.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "numa[n]" : {
- "description" : "NUMA topology.",
- "format" : {
- "cpus" : {
- "description" : "CPUs accessing this NUMA node.",
- "format_description" : "id[-id];...",
- "pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)",
- "type" : "string"
- },
- "hostnodes" : {
- "description" : "Host NUMA nodes to use.",
- "format_description" : "id[-id];...",
- "optional" : 1,
- "pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)",
- "type" : "string"
- },
- "memory" : {
- "description" : "Amount of memory this NUMA node provides.",
- "optional" : 1,
- "type" : "number"
- },
- "policy" : {
- "description" : "NUMA allocation policy.",
- "enum" : [
- "preferred",
- "bind",
- "interleave"
- ],
- "optional" : 1,
- "type" : "string"
- }
- },
- "optional" : 1,
- "type" : "string",
- "typetext" : "cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]"
- },
- "onboot" : {
- "default" : 0,
- "description" : "Specifies whether a VM will be started during system bootup.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "ostype" : {
- "description" : "Specify guest operating system.",
- "enum" : [
- "other",
- "wxp",
- "w2k",
- "w2k3",
- "w2k8",
- "wvista",
- "win7",
- "win8",
- "win10",
- "win11",
- "l24",
- "l26",
- "solaris"
- ],
- "optional" : 1,
- "type" : "string",
- "verbose_description" : "Specify guest operating system. This is used to enable special\noptimization/features for specific operating systems:\n\n[horizontal]\nother;; unspecified OS\nwxp;; Microsoft Windows XP\nw2k;; Microsoft Windows 2000\nw2k3;; Microsoft Windows 2003\nw2k8;; Microsoft Windows 2008\nwvista;; Microsoft Windows Vista\nwin7;; Microsoft Windows 7\nwin8;; Microsoft Windows 8/2012/2012r2\nwin10;; Microsoft Windows 10/2016/2019\nwin11;; Microsoft Windows 11/2022\nl24;; Linux 2.4 Kernel\nl26;; Linux 2.6 - 6.X Kernel\nsolaris;; Solaris/OpenSolaris/OpenIndiania kernel\n"
- },
- "parallel[n]" : {
- "description" : "Map host parallel devices (n is 0 to 2).",
- "optional" : 1,
- "pattern" : "/dev/parport\\d+|/dev/usb/lp\\d+",
- "type" : "string",
- "verbose_description" : "Map host parallel devices (n is 0 to 2).\n\nNOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such\nmachines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n"
- },
- "protection" : {
- "default" : 0,
- "description" : "Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "reboot" : {
- "default" : 1,
- "description" : "Allow reboot. If set to '0' the VM exit on reboot.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "revert" : {
- "description" : "Revert a pending change.",
- "format" : "pve-configid-list",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "rng0" : {
- "description" : "Configure a VirtIO-based Random Number Generator.",
- "format" : {
- "max_bytes" : {
- "default" : 1024,
- "description" : "Maximum bytes of entropy allowed to get injected into the guest every 'period' milliseconds. Prefer a lower value when using '/dev/random' as source. Use `0` to disable limiting (potentially dangerous!).",
- "optional" : 1,
- "type" : "integer"
- },
- "period" : {
- "default" : 1000,
- "description" : "Every 'period' milliseconds the entropy-injection quota is reset, allowing the guest to retrieve another 'max_bytes' of entropy.",
- "optional" : 1,
- "type" : "integer"
- },
- "source" : {
- "default_key" : 1,
- "description" : "The file on the host to gather entropy from. In most cases '/dev/urandom' should be preferred over '/dev/random' to avoid entropy-starvation issues on the host. Using urandom does *not* decrease security in any meaningful way, as it's still seeded from real entropy, and the bytes provided will most likely be mixed with real entropy on the guest as well. '/dev/hwrng' can be used to pass through a hardware RNG from the host.",
- "enum" : [
- "/dev/urandom",
- "/dev/random",
- "/dev/hwrng"
- ],
- "type" : "string"
- }
- },
- "optional" : 1,
- "type" : "string",
- "typetext" : "[source=]</dev/urandom|/dev/random|/dev/hwrng> [,max_bytes=<integer>] [,period=<integer>]"
- },
- "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. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume.",
- "format" : {
- "aio" : {
- "description" : "AIO type to use.",
- "enum" : [
- "native",
- "threads",
- "io_uring"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "backup" : {
- "description" : "Whether the drive should be included when making backups.",
- "optional" : 1,
- "type" : "boolean"
- },
- "bps" : {
- "description" : "Maximum r/w speed in bytes per second.",
- "format_description" : "bps",
- "optional" : 1,
- "type" : "integer"
- },
- "bps_max_length" : {
- "description" : "Maximum length of I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "bps_rd" : {
- "description" : "Maximum read speed in bytes per second.",
- "format_description" : "bps",
- "optional" : 1,
- "type" : "integer"
- },
- "bps_rd_length" : {
- "alias" : "bps_rd_max_length"
- },
- "bps_rd_max_length" : {
- "description" : "Maximum length of read I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "bps_wr" : {
- "description" : "Maximum write speed in bytes per second.",
- "format_description" : "bps",
- "optional" : 1,
- "type" : "integer"
- },
- "bps_wr_length" : {
- "alias" : "bps_wr_max_length"
- },
- "bps_wr_max_length" : {
- "description" : "Maximum length of write I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "cache" : {
- "description" : "The drive's cache mode",
- "enum" : [
- "none",
- "writethrough",
- "writeback",
- "unsafe",
- "directsync"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "cyls" : {
- "description" : "Force the drive's physical geometry to have a specific cylinder count.",
- "optional" : 1,
- "type" : "integer"
- },
- "detect_zeroes" : {
- "description" : "Controls whether to detect and try to optimize writes of zeroes.",
- "optional" : 1,
- "type" : "boolean"
- },
- "discard" : {
- "description" : "Controls whether to pass discard/trim requests to the underlying storage.",
- "enum" : [
- "ignore",
- "on"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "file" : {
- "default_key" : 1,
- "description" : "The drive's backing volume.",
- "format" : "pve-volume-id-or-qm-path",
- "format_description" : "volume",
- "type" : "string"
- },
- "format" : {
- "description" : "The drive's backing file's data format.",
- "enum" : [
- "raw",
- "cow",
- "qcow",
- "qed",
- "qcow2",
- "vmdk",
- "cloop"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "heads" : {
- "description" : "Force the drive's physical geometry to have a specific head count.",
- "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",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_max" : {
- "description" : "Maximum unthrottled r/w I/O pool in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_max_length" : {
- "description" : "Maximum length of I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "iops_rd" : {
- "description" : "Maximum read I/O in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_rd_length" : {
- "alias" : "iops_rd_max_length"
- },
- "iops_rd_max" : {
- "description" : "Maximum unthrottled read I/O pool in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_rd_max_length" : {
- "description" : "Maximum length of read I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "iops_wr" : {
- "description" : "Maximum write I/O in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_wr_length" : {
- "alias" : "iops_wr_max_length"
- },
- "iops_wr_max" : {
- "description" : "Maximum unthrottled write I/O pool in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_wr_max_length" : {
- "description" : "Maximum length of write I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "mbps" : {
- "description" : "Maximum r/w speed in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_max" : {
- "description" : "Maximum unthrottled r/w pool in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_rd" : {
- "description" : "Maximum read speed in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_rd_max" : {
- "description" : "Maximum unthrottled read pool in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_wr" : {
- "description" : "Maximum write speed in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_wr_max" : {
- "description" : "Maximum unthrottled write pool in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "media" : {
- "default" : "disk",
- "description" : "The drive's media type.",
- "enum" : [
- "cdrom",
- "disk"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "replicate" : {
- "default" : 1,
- "description" : "Whether the drive should considered for replication jobs.",
- "optional" : 1,
- "type" : "boolean"
- },
- "rerror" : {
- "description" : "Read error action.",
- "enum" : [
- "ignore",
- "report",
- "stop"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "secs" : {
- "description" : "Force the drive's physical geometry to have a specific sector count.",
- "optional" : 1,
- "type" : "integer"
- },
- "serial" : {
- "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long.",
- "format" : "urlencoded",
- "format_description" : "serial",
- "maxLength" : 60,
- "optional" : 1,
- "type" : "string"
- },
- "shared" : {
- "default" : 0,
- "description" : "Mark this locally-managed volume as available on all nodes",
- "optional" : 1,
- "type" : "boolean",
- "verbose_description" : "Mark this locally-managed volume as available on all nodes.\n\nWARNING: This option does not share the volume automatically, it assumes it is shared already!"
- },
- "size" : {
- "description" : "Disk size. This is purely informational and has no effect.",
- "format" : "disk-size",
- "format_description" : "DiskSize",
- "optional" : 1,
- "type" : "string"
- },
- "snapshot" : {
- "description" : "Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.",
- "optional" : 1,
- "type" : "boolean"
- },
- "ssd" : {
- "description" : "Whether to expose this drive as an SSD, rather than a rotational hard disk.",
- "optional" : 1,
- "type" : "boolean"
- },
- "trans" : {
- "description" : "Force disk geometry bios translation mode.",
- "enum" : [
- "none",
- "lba",
- "auto"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "volume" : {
- "alias" : "file"
- },
- "werror" : {
- "description" : "Write error action.",
- "enum" : [
- "enospc",
- "ignore",
- "report",
- "stop"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "wwn" : {
- "description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.",
- "format_description" : "wwn",
- "optional" : 1,
- "pattern" : "(?^:^(0x)[0-9a-fA-F]{16})",
- "type" : "string"
- }
- },
- "optional" : 1,
- "type" : "string",
- "typetext" : "[file=]<volume> [,aio=<native|threads|io_uring>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,import-from=<source volume>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]"
- },
- "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. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume.",
- "format" : {
- "aio" : {
- "description" : "AIO type to use.",
- "enum" : [
- "native",
- "threads",
- "io_uring"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "backup" : {
- "description" : "Whether the drive should be included when making backups.",
- "optional" : 1,
- "type" : "boolean"
- },
- "bps" : {
- "description" : "Maximum r/w speed in bytes per second.",
- "format_description" : "bps",
- "optional" : 1,
- "type" : "integer"
- },
- "bps_max_length" : {
- "description" : "Maximum length of I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "bps_rd" : {
- "description" : "Maximum read speed in bytes per second.",
- "format_description" : "bps",
- "optional" : 1,
- "type" : "integer"
- },
- "bps_rd_length" : {
- "alias" : "bps_rd_max_length"
- },
- "bps_rd_max_length" : {
- "description" : "Maximum length of read I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "bps_wr" : {
- "description" : "Maximum write speed in bytes per second.",
- "format_description" : "bps",
- "optional" : 1,
- "type" : "integer"
- },
- "bps_wr_length" : {
- "alias" : "bps_wr_max_length"
- },
- "bps_wr_max_length" : {
- "description" : "Maximum length of write I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "cache" : {
- "description" : "The drive's cache mode",
- "enum" : [
- "none",
- "writethrough",
- "writeback",
- "unsafe",
- "directsync"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "cyls" : {
- "description" : "Force the drive's physical geometry to have a specific cylinder count.",
- "optional" : 1,
- "type" : "integer"
- },
- "detect_zeroes" : {
- "description" : "Controls whether to detect and try to optimize writes of zeroes.",
- "optional" : 1,
- "type" : "boolean"
- },
- "discard" : {
- "description" : "Controls whether to pass discard/trim requests to the underlying storage.",
- "enum" : [
- "ignore",
- "on"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "file" : {
- "default_key" : 1,
- "description" : "The drive's backing volume.",
- "format" : "pve-volume-id-or-qm-path",
- "format_description" : "volume",
- "type" : "string"
- },
- "format" : {
- "description" : "The drive's backing file's data format.",
- "enum" : [
- "raw",
- "cow",
- "qcow",
- "qed",
- "qcow2",
- "vmdk",
- "cloop"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "heads" : {
- "description" : "Force the drive's physical geometry to have a specific head count.",
- "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",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_max" : {
- "description" : "Maximum unthrottled r/w I/O pool in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_max_length" : {
- "description" : "Maximum length of I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "iops_rd" : {
- "description" : "Maximum read I/O in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_rd_length" : {
- "alias" : "iops_rd_max_length"
- },
- "iops_rd_max" : {
- "description" : "Maximum unthrottled read I/O pool in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_rd_max_length" : {
- "description" : "Maximum length of read I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "iops_wr" : {
- "description" : "Maximum write I/O in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_wr_length" : {
- "alias" : "iops_wr_max_length"
- },
- "iops_wr_max" : {
- "description" : "Maximum unthrottled write I/O pool in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_wr_max_length" : {
- "description" : "Maximum length of write I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "iothread" : {
- "description" : "Whether to use iothreads for this drive",
- "optional" : 1,
- "type" : "boolean"
- },
- "mbps" : {
- "description" : "Maximum r/w speed in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_max" : {
- "description" : "Maximum unthrottled r/w pool in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_rd" : {
- "description" : "Maximum read speed in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_rd_max" : {
- "description" : "Maximum unthrottled read pool in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_wr" : {
- "description" : "Maximum write speed in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_wr_max" : {
- "description" : "Maximum unthrottled write pool in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "media" : {
- "default" : "disk",
- "description" : "The drive's media type.",
- "enum" : [
- "cdrom",
- "disk"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "queues" : {
- "description" : "Number of queues.",
- "minimum" : 2,
- "optional" : 1,
- "type" : "integer"
- },
- "replicate" : {
- "default" : 1,
- "description" : "Whether the drive should considered for replication jobs.",
- "optional" : 1,
- "type" : "boolean"
- },
- "rerror" : {
- "description" : "Read error action.",
- "enum" : [
- "ignore",
- "report",
- "stop"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "ro" : {
- "description" : "Whether the drive is read-only.",
- "optional" : 1,
- "type" : "boolean"
- },
- "scsiblock" : {
- "default" : 0,
- "description" : "whether to use scsi-block for full passthrough of host block device\n\nWARNING: can lead to I/O errors in combination with low memory or high memory fragmentation on host",
- "optional" : 1,
- "type" : "boolean"
- },
- "secs" : {
- "description" : "Force the drive's physical geometry to have a specific sector count.",
- "optional" : 1,
- "type" : "integer"
- },
- "serial" : {
- "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long.",
- "format" : "urlencoded",
- "format_description" : "serial",
- "maxLength" : 60,
- "optional" : 1,
- "type" : "string"
- },
- "shared" : {
- "default" : 0,
- "description" : "Mark this locally-managed volume as available on all nodes",
- "optional" : 1,
- "type" : "boolean",
- "verbose_description" : "Mark this locally-managed volume as available on all nodes.\n\nWARNING: This option does not share the volume automatically, it assumes it is shared already!"
- },
- "size" : {
- "description" : "Disk size. This is purely informational and has no effect.",
- "format" : "disk-size",
- "format_description" : "DiskSize",
- "optional" : 1,
- "type" : "string"
- },
- "snapshot" : {
- "description" : "Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.",
- "optional" : 1,
- "type" : "boolean"
- },
- "ssd" : {
- "description" : "Whether to expose this drive as an SSD, rather than a rotational hard disk.",
- "optional" : 1,
- "type" : "boolean"
- },
- "trans" : {
- "description" : "Force disk geometry bios translation mode.",
- "enum" : [
- "none",
- "lba",
- "auto"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "volume" : {
- "alias" : "file"
- },
- "werror" : {
- "description" : "Write error action.",
- "enum" : [
- "enospc",
- "ignore",
- "report",
- "stop"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "wwn" : {
- "description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.",
- "format_description" : "wwn",
- "optional" : 1,
- "pattern" : "(?^:^(0x)[0-9a-fA-F]{16})",
- "type" : "string"
- }
- },
- "optional" : 1,
- "type" : "string",
- "typetext" : "[file=]<volume> [,aio=<native|threads|io_uring>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,import-from=<source volume>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<integer>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,ro=<1|0>] [,scsiblock=<1|0>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]"
- },
- "scsihw" : {
- "default" : "lsi",
- "description" : "SCSI controller model",
- "enum" : [
- "lsi",
- "lsi53c810",
- "virtio-scsi-pci",
- "virtio-scsi-single",
- "megasas",
- "pvscsi"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "searchdomain" : {
- "description" : "cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "serial[n]" : {
- "description" : "Create a serial device inside the VM (n is 0 to 3)",
- "optional" : 1,
- "pattern" : "(/dev/.+|socket)",
- "type" : "string",
- "verbose_description" : "Create a serial device inside the VM (n is 0 to 3), and pass through a\nhost serial device (i.e. /dev/ttyS0), or create a unix socket on the\nhost side (use 'qm terminal' to open a terminal connection).\n\nNOTE: If you pass through a host serial device, it is no longer possible to migrate such machines -\nuse with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n"
- },
- "shares" : {
- "default" : 1000,
- "description" : "Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning. Auto-ballooning is done by pvestatd.",
- "maximum" : 50000,
- "minimum" : 0,
- "optional" : 1,
- "type" : "integer",
- "typetext" : "<integer> (0 - 50000)"
- },
- "skiplock" : {
- "description" : "Ignore locks - only root is allowed to use this option.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "smbios1" : {
- "description" : "Specify SMBIOS type 1 fields.",
- "format" : "pve-qm-smbios1",
- "maxLength" : 512,
- "optional" : 1,
- "type" : "string",
- "typetext" : "[base64=<1|0>] [,family=<Base64 encoded string>] [,manufacturer=<Base64 encoded string>] [,product=<Base64 encoded string>] [,serial=<Base64 encoded string>] [,sku=<Base64 encoded string>] [,uuid=<UUID>] [,version=<Base64 encoded string>]"
- },
- "smp" : {
- "default" : 1,
- "description" : "The number of CPUs. Please use option -sockets instead.",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- },
- "sockets" : {
- "default" : 1,
- "description" : "The number of CPU sockets.",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- },
- "spice_enhancements" : {
- "description" : "Configure additional enhancements for SPICE.",
- "format" : {
- "foldersharing" : {
- "default" : "0",
- "description" : "Enable folder sharing via SPICE. Needs Spice-WebDAV daemon installed in the VM.",
- "optional" : 1,
- "type" : "boolean"
- },
- "videostreaming" : {
- "default" : "off",
- "description" : "Enable video streaming. Uses compression for detected video streams.",
- "enum" : [
- "off",
- "all",
- "filter"
- ],
- "optional" : 1,
- "type" : "string"
- }
- },
- "optional" : 1,
- "type" : "string",
- "typetext" : "[foldersharing=<1|0>] [,videostreaming=<off|all|filter>]"
- },
- "sshkeys" : {
- "description" : "cloud-init: Setup public SSH keys (one key per line, OpenSSH format).",
- "format" : "urlencoded",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "startdate" : {
- "default" : "now",
- "description" : "Set the initial date of the real time clock. Valid format for date are:'now' or '2006-06-17T16:01:21' or '2006-06-17'.",
- "optional" : 1,
- "pattern" : "(now|\\d{4}-\\d{1,2}-\\d{1,2}(T\\d{1,2}:\\d{1,2}:\\d{1,2})?)",
- "type" : "string",
- "typetext" : "(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)"
- },
- "startup" : {
- "description" : "Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.",
- "format" : "pve-startup-order",
- "optional" : 1,
- "type" : "string",
- "typetext" : "[[order=]\\d+] [,up=\\d+] [,down=\\d+] "
- },
- "tablet" : {
- "default" : 1,
- "description" : "Enable/disable the USB tablet device.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>",
- "verbose_description" : "Enable/disable the USB tablet device. This device is usually needed to allow absolute mouse positioning with VNC. Else the mouse runs out of sync with normal VNC clients. If you're running lots of console-only guests on one host, you may consider disabling this to save some context switches. This is turned off by default if you use spice (`qm set <vmid> --vga qxl`)."
- },
- "tags" : {
- "description" : "Tags of the VM. This is only meta information.",
- "format" : "pve-tag-list",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "tdf" : {
- "default" : 0,
- "description" : "Enable/disable time drift fix.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "template" : {
- "default" : 0,
- "description" : "Enable/disable Template.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "tpmstate0" : {
- "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,
- "description" : "The drive's backing volume.",
- "format" : "pve-volume-id-or-qm-path",
- "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",
- "format_description" : "DiskSize",
- "optional" : 1,
- "type" : "string"
- },
- "version" : {
- "default" : "v2.0",
- "description" : "The TPM interface version. v2.0 is newer and should be preferred. Note that this cannot be changed later on.",
- "enum" : [
- "v1.2",
- "v2.0"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "volume" : {
- "alias" : "file"
- }
- },
- "optional" : 1,
- "type" : "string",
- "typetext" : "[file=]<volume> [,import-from=<source volume>] [,size=<DiskSize>] [,version=<v1.2|v2.0>]"
- },
- "unused[n]" : {
- "description" : "Reference to unused volumes. This is used internally, and should not be modified manually.",
- "format" : {
- "file" : {
- "default_key" : 1,
- "description" : "The drive's backing volume.",
- "format" : "pve-volume-id",
- "format_description" : "volume",
- "type" : "string"
- },
- "volume" : {
- "alias" : "file"
- }
- },
- "optional" : 1,
- "type" : "string",
- "typetext" : "[file=]<volume>"
- },
- "usb[n]" : {
- "description" : "Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14).",
- "format" : {
- "host" : {
- "default_key" : 1,
- "description" : "The Host USB device or port or the value 'spice'. HOSTUSBDEVICE syntax is:\n\n 'bus-port(.port)*' (decimal numbers) or\n 'vendor_id:product_id' (hexadeciaml numbers) or\n 'spice'\n\nYou can use the 'lsusb -t' command to list existing usb devices.\n\nNOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such\nmachines - use with special care.\n\nThe value 'spice' can be used to add a usb redirection devices for spice.\n",
- "format" : "pve-qm-usb-device",
- "format_description" : "HOSTUSBDEVICE|spice",
- "type" : "string"
- },
- "usb3" : {
- "default" : 0,
- "description" : "Specifies whether if given host option is a USB3 device or port. For modern guests (machine version >= 7.1 and ostype l26 and windows > 7), this flag is irrelevant (all devices are plugged into a xhci controller).",
- "optional" : 1,
- "type" : "boolean"
- }
- },
- "optional" : 1,
- "type" : "string",
- "typetext" : "[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]"
- },
- "vcpus" : {
- "default" : 0,
- "description" : "Number of hotplugged vcpus.",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- },
- "vga" : {
- "description" : "Configure the VGA hardware.",
- "format" : {
- "memory" : {
- "description" : "Sets the VGA memory (in MiB). Has no effect with serial display.",
- "maximum" : 512,
- "minimum" : 4,
- "optional" : 1,
- "type" : "integer"
- },
- "type" : {
- "default" : "std",
- "default_key" : 1,
- "description" : "Select the VGA type.",
- "enum" : [
- "cirrus",
- "qxl",
- "qxl2",
- "qxl3",
- "qxl4",
- "none",
- "serial0",
- "serial1",
- "serial2",
- "serial3",
- "std",
- "virtio",
- "virtio-gl",
- "vmware"
- ],
- "optional" : 1,
- "type" : "string"
- }
- },
- "optional" : 1,
- "type" : "string",
- "typetext" : "[[type=]<enum>] [,memory=<integer>]",
- "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. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume.",
- "format" : {
- "aio" : {
- "description" : "AIO type to use.",
- "enum" : [
- "native",
- "threads",
- "io_uring"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "backup" : {
- "description" : "Whether the drive should be included when making backups.",
- "optional" : 1,
- "type" : "boolean"
- },
- "bps" : {
- "description" : "Maximum r/w speed in bytes per second.",
- "format_description" : "bps",
- "optional" : 1,
- "type" : "integer"
- },
- "bps_max_length" : {
- "description" : "Maximum length of I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "bps_rd" : {
- "description" : "Maximum read speed in bytes per second.",
- "format_description" : "bps",
- "optional" : 1,
- "type" : "integer"
- },
- "bps_rd_length" : {
- "alias" : "bps_rd_max_length"
- },
- "bps_rd_max_length" : {
- "description" : "Maximum length of read I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "bps_wr" : {
- "description" : "Maximum write speed in bytes per second.",
- "format_description" : "bps",
- "optional" : 1,
- "type" : "integer"
- },
- "bps_wr_length" : {
- "alias" : "bps_wr_max_length"
- },
- "bps_wr_max_length" : {
- "description" : "Maximum length of write I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "cache" : {
- "description" : "The drive's cache mode",
- "enum" : [
- "none",
- "writethrough",
- "writeback",
- "unsafe",
- "directsync"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "cyls" : {
- "description" : "Force the drive's physical geometry to have a specific cylinder count.",
- "optional" : 1,
- "type" : "integer"
- },
- "detect_zeroes" : {
- "description" : "Controls whether to detect and try to optimize writes of zeroes.",
- "optional" : 1,
- "type" : "boolean"
- },
- "discard" : {
- "description" : "Controls whether to pass discard/trim requests to the underlying storage.",
- "enum" : [
- "ignore",
- "on"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "file" : {
- "default_key" : 1,
- "description" : "The drive's backing volume.",
- "format" : "pve-volume-id-or-qm-path",
- "format_description" : "volume",
- "type" : "string"
- },
- "format" : {
- "description" : "The drive's backing file's data format.",
- "enum" : [
- "raw",
- "cow",
- "qcow",
- "qed",
- "qcow2",
- "vmdk",
- "cloop"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "heads" : {
- "description" : "Force the drive's physical geometry to have a specific head count.",
- "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",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_max" : {
- "description" : "Maximum unthrottled r/w I/O pool in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_max_length" : {
- "description" : "Maximum length of I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "iops_rd" : {
- "description" : "Maximum read I/O in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_rd_length" : {
- "alias" : "iops_rd_max_length"
- },
- "iops_rd_max" : {
- "description" : "Maximum unthrottled read I/O pool in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_rd_max_length" : {
- "description" : "Maximum length of read I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "iops_wr" : {
- "description" : "Maximum write I/O in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_wr_length" : {
- "alias" : "iops_wr_max_length"
- },
- "iops_wr_max" : {
- "description" : "Maximum unthrottled write I/O pool in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_wr_max_length" : {
- "description" : "Maximum length of write I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "iothread" : {
- "description" : "Whether to use iothreads for this drive",
- "optional" : 1,
- "type" : "boolean"
- },
- "mbps" : {
- "description" : "Maximum r/w speed in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_max" : {
- "description" : "Maximum unthrottled r/w pool in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_rd" : {
- "description" : "Maximum read speed in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_rd_max" : {
- "description" : "Maximum unthrottled read pool in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_wr" : {
- "description" : "Maximum write speed in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_wr_max" : {
- "description" : "Maximum unthrottled write pool in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "media" : {
- "default" : "disk",
- "description" : "The drive's media type.",
- "enum" : [
- "cdrom",
- "disk"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "replicate" : {
- "default" : 1,
- "description" : "Whether the drive should considered for replication jobs.",
- "optional" : 1,
- "type" : "boolean"
- },
- "rerror" : {
- "description" : "Read error action.",
- "enum" : [
- "ignore",
- "report",
- "stop"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "ro" : {
- "description" : "Whether the drive is read-only.",
- "optional" : 1,
- "type" : "boolean"
- },
- "secs" : {
- "description" : "Force the drive's physical geometry to have a specific sector count.",
- "optional" : 1,
- "type" : "integer"
- },
- "serial" : {
- "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long.",
- "format" : "urlencoded",
- "format_description" : "serial",
- "maxLength" : 60,
- "optional" : 1,
- "type" : "string"
- },
- "shared" : {
- "default" : 0,
- "description" : "Mark this locally-managed volume as available on all nodes",
- "optional" : 1,
- "type" : "boolean",
- "verbose_description" : "Mark this locally-managed volume as available on all nodes.\n\nWARNING: This option does not share the volume automatically, it assumes it is shared already!"
- },
- "size" : {
- "description" : "Disk size. This is purely informational and has no effect.",
- "format" : "disk-size",
- "format_description" : "DiskSize",
- "optional" : 1,
- "type" : "string"
- },
- "snapshot" : {
- "description" : "Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.",
- "optional" : 1,
- "type" : "boolean"
- },
- "trans" : {
- "description" : "Force disk geometry bios translation mode.",
- "enum" : [
- "none",
- "lba",
- "auto"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "volume" : {
- "alias" : "file"
- },
- "werror" : {
- "description" : "Write error action.",
- "enum" : [
- "enospc",
- "ignore",
- "report",
- "stop"
- ],
- "optional" : 1,
- "type" : "string"
- }
- },
- "optional" : 1,
- "type" : "string",
- "typetext" : "[file=]<volume> [,aio=<native|threads|io_uring>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,import-from=<source volume>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,ro=<1|0>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]"
- },
- "vmgenid" : {
- "default" : "1 (autogenerated)",
- "description" : "Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly.",
- "format_description" : "UUID",
- "optional" : 1,
- "pattern" : "(?:[a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}|[01])",
- "type" : "string",
- "verbose_description" : "The VM generation ID (vmgenid) device exposes a 128-bit integer value identifier to the guest OS. This allows to notify the guest operating system when the virtual machine is executed with a different configuration (e.g. snapshot execution or creation from a template). The guest operating system notices the change, and is then able to react as appropriate by marking its copies of distributed databases as dirty, re-initializing its random number generator, etc.\nNote that auto-creation only works when done through API/CLI create or update methods, but not when manually editing the config file."
- },
- "vmid" : {
- "description" : "The (unique) ID of the VM.",
- "format" : "pve-vmid",
- "minimum" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- },
- "vmstatestorage" : {
- "description" : "Default storage for VM state volumes/files.",
- "format" : "pve-storage-id",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "watchdog" : {
- "description" : "Create a virtual hardware watchdog device.",
- "format" : "pve-qm-watchdog",
- "optional" : 1,
- "type" : "string",
- "typetext" : "[[model=]<i6300esb|ib700>] [,action=<enum>]",
- "verbose_description" : "Create a virtual hardware watchdog device. Once enabled (by a guest action), the watchdog must be periodically polled by an agent inside the guest or else the watchdog will reset the guest (or execute the respective action specified)"
- }
- }
- },
- "permissions" : {
- "check" : [
- "perm",
- "/vms/{vmid}",
- [
- "VM.Config.Disk",
- "VM.Config.CDROM",
- "VM.Config.CPU",
- "VM.Config.Memory",
- "VM.Config.Network",
- "VM.Config.HWType",
- "VM.Config.Options",
- "VM.Config.Cloudinit"
- ],
- "any",
- 1
- ]
- },
- "protected" : 1,
- "proxyto" : "node",
- "returns" : {
- "optional" : 1,
- "type" : "string"
- }
- },
- "PUT" : {
- "allowtoken" : 1,
- "description" : "Set virtual machine options (synchrounous API) - You should consider using the POST method instead for any actions involving hotplug or storage allocation.",
- "method" : "PUT",
- "name" : "update_vm",
- "parameters" : {
- "additionalProperties" : 0,
- "properties" : {
- "acpi" : {
- "default" : 1,
- "description" : "Enable/disable ACPI.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "affinity" : {
- "description" : "List of host cores used to execute guest processes, for example: 0,5,8-11",
- "format" : "pve-cpuset",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "agent" : {
- "description" : "Enable/disable communication with the QEMU Guest Agent and its properties.",
- "format" : {
- "enabled" : {
- "default" : 0,
- "default_key" : 1,
- "description" : "Enable/disable communication with a QEMU Guest Agent (QGA) running in the VM.",
- "type" : "boolean"
- },
- "freeze-fs-on-backup" : {
- "default" : 1,
- "description" : "Freeze/thaw guest filesystems on backup for consistency.",
- "optional" : 1,
- "type" : "boolean"
- },
- "fstrim_cloned_disks" : {
- "default" : 0,
- "description" : "Run fstrim after moving a disk or migrating the VM.",
- "optional" : 1,
- "type" : "boolean"
- },
- "type" : {
- "default" : "virtio",
- "description" : "Select the agent type",
- "enum" : [
- "virtio",
- "isa"
- ],
- "optional" : 1,
- "type" : "string"
- }
- },
- "optional" : 1,
- "type" : "string",
- "typetext" : "[enabled=]<1|0> [,freeze-fs-on-backup=<1|0>] [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]"
- },
- "arch" : {
- "description" : "Virtual processor architecture. Defaults to the host.",
- "enum" : [
- "x86_64",
- "aarch64"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "args" : {
- "description" : "Arbitrary arguments passed to kvm.",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>",
- "verbose_description" : "Arbitrary arguments passed to kvm, for example:\n\nargs: -no-reboot -no-hpet\n\nNOTE: this option is for experts only.\n"
- },
- "audio0" : {
- "description" : "Configure a audio device, useful in combination with QXL/Spice.",
- "format" : {
- "device" : {
- "description" : "Configure an audio device.",
- "enum" : [
- "ich9-intel-hda",
- "intel-hda",
- "AC97"
- ],
- "type" : "string"
- },
- "driver" : {
- "default" : "spice",
- "description" : "Driver backend for the audio device.",
- "enum" : [
- "spice",
- "none"
- ],
- "optional" : 1,
- "type" : "string"
- }
- },
- "optional" : 1,
- "type" : "string",
- "typetext" : "device=<ich9-intel-hda|intel-hda|AC97> [,driver=<spice|none>]"
- },
- "autostart" : {
- "default" : 0,
- "description" : "Automatic restart after crash (currently ignored).",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "balloon" : {
- "description" : "Amount of target RAM for the VM in MiB. Using zero disables the ballon driver.",
- "minimum" : 0,
- "optional" : 1,
- "type" : "integer",
- "typetext" : "<integer> (0 - N)"
- },
- "bios" : {
- "default" : "seabios",
- "description" : "Select BIOS implementation.",
- "enum" : [
- "seabios",
- "ovmf"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "boot" : {
- "description" : "Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated.",
- "format" : "pve-qm-boot",
- "optional" : 1,
- "type" : "string",
- "typetext" : "[[legacy=]<[acdn]{1,4}>] [,order=<device[;device...]>]"
- },
- "bootdisk" : {
- "description" : "Enable booting from specified disk. Deprecated: Use 'boot: order=foo;bar' instead.",
- "format" : "pve-qm-bootdisk",
- "optional" : 1,
- "pattern" : "(ide|sata|scsi|virtio)\\d+",
- "type" : "string"
- },
- "cdrom" : {
- "description" : "This is an alias for option -ide2",
- "format" : "pve-qm-ide",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<volume>"
- },
- "cicustom" : {
- "description" : "cloud-init: Specify custom files to replace the automatically generated ones at start.",
- "format" : "pve-qm-cicustom",
- "optional" : 1,
- "type" : "string",
- "typetext" : "[meta=<volume>] [,network=<volume>] [,user=<volume>] [,vendor=<volume>]"
- },
- "cipassword" : {
- "description" : "cloud-init: Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords.",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "citype" : {
- "description" : "Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows.",
- "enum" : [
- "configdrive2",
- "nocloud",
- "opennebula"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "ciuser" : {
- "description" : "cloud-init: User name to change ssh keys and password for instead of the image's configured default user.",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "cores" : {
- "default" : 1,
- "description" : "The number of cores per socket.",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- },
- "cpu" : {
- "description" : "Emulated CPU type.",
- "format" : "pve-vm-cpu-conf",
- "optional" : 1,
- "type" : "string",
- "typetext" : "[[cputype=]<string>] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>] [,phys-bits=<8-64|host>] [,reported-model=<enum>]"
- },
- "cpulimit" : {
- "default" : 0,
- "description" : "Limit of CPU usage.",
- "maximum" : 128,
- "minimum" : 0,
- "optional" : 1,
- "type" : "number",
- "typetext" : "<number> (0 - 128)",
- "verbose_description" : "Limit of CPU usage.\n\nNOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit."
- },
- "cpuunits" : {
- "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" : 1,
- "optional" : 1,
- "type" : "integer",
- "typetext" : "<integer> (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" : {
- "description" : "A list of settings you want to delete.",
- "format" : "pve-configid-list",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "description" : {
- "description" : "Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file.",
- "maxLength" : 8192,
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "digest" : {
- "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
- "maxLength" : 40,
- "optional" : 1,
- "type" : "string",
- "typetext" : "<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. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume.",
- "format" : {
- "efitype" : {
- "default" : "2m",
- "description" : "Size and type of the OVMF EFI vars. '4m' is newer and recommended, and required for Secure Boot. For backwards compatibility, '2m' is used if not otherwise specified. Ignored for VMs with arch=aarc64 (ARM).",
- "enum" : [
- "2m",
- "4m"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "file" : {
- "default_key" : 1,
- "description" : "The drive's backing volume.",
- "format" : "pve-volume-id-or-qm-path",
- "format_description" : "volume",
- "type" : "string"
- },
- "format" : {
- "description" : "The drive's backing file's data format.",
- "enum" : [
- "raw",
- "cow",
- "qcow",
- "qed",
- "qcow2",
- "vmdk",
- "cloop"
- ],
- "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.",
- "optional" : 1,
- "type" : "boolean"
- },
- "size" : {
- "description" : "Disk size. This is purely informational and has no effect.",
- "format" : "disk-size",
- "format_description" : "DiskSize",
- "optional" : 1,
- "type" : "string"
- },
- "volume" : {
- "alias" : "file"
- }
- },
- "optional" : 1,
- "type" : "string",
- "typetext" : "[file=]<volume> [,efitype=<2m|4m>] [,format=<enum>] [,import-from=<source volume>] [,pre-enrolled-keys=<1|0>] [,size=<DiskSize>]"
- },
- "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.",
- "optional" : 1,
- "requires" : "delete",
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "freeze" : {
- "description" : "Freeze CPU at startup (use 'c' monitor command to start execution).",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "hookscript" : {
- "description" : "Script that will be executed during various steps in the vms lifetime.",
- "format" : "pve-volume-id",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "hostpci[n]" : {
- "description" : "Map host PCI devices into guest.",
- "format" : "pve-qm-hostpci",
- "optional" : 1,
- "type" : "string",
- "typetext" : "[host=]<HOSTPCIID[;HOSTPCIID2...]> [,device-id=<hex id>] [,legacy-igd=<1|0>] [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,sub-device-id=<hex id>] [,sub-vendor-id=<hex id>] [,vendor-id=<hex 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" : {
- "default" : "network,disk,usb",
- "description" : "Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory', 'usb' and 'cloudinit'. Use '0' to disable hotplug completely. Using '1' as value is an alias for the default `network,disk,usb`. USB hotplugging is possible for guests with machine version >= 7.1 and ostype l26 or windows > 7.",
- "format" : "pve-hotplug-features",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "hugepages" : {
- "description" : "Enable/disable hugepages memory.",
- "enum" : [
- "any",
- "2",
- "1024"
- ],
- "optional" : 1,
- "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. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume.",
- "format" : {
- "aio" : {
- "description" : "AIO type to use.",
- "enum" : [
- "native",
- "threads",
- "io_uring"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "backup" : {
- "description" : "Whether the drive should be included when making backups.",
- "optional" : 1,
- "type" : "boolean"
- },
- "bps" : {
- "description" : "Maximum r/w speed in bytes per second.",
- "format_description" : "bps",
- "optional" : 1,
- "type" : "integer"
- },
- "bps_max_length" : {
- "description" : "Maximum length of I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "bps_rd" : {
- "description" : "Maximum read speed in bytes per second.",
- "format_description" : "bps",
- "optional" : 1,
- "type" : "integer"
- },
- "bps_rd_length" : {
- "alias" : "bps_rd_max_length"
- },
- "bps_rd_max_length" : {
- "description" : "Maximum length of read I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "bps_wr" : {
- "description" : "Maximum write speed in bytes per second.",
- "format_description" : "bps",
- "optional" : 1,
- "type" : "integer"
- },
- "bps_wr_length" : {
- "alias" : "bps_wr_max_length"
- },
- "bps_wr_max_length" : {
- "description" : "Maximum length of write I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "cache" : {
- "description" : "The drive's cache mode",
- "enum" : [
- "none",
- "writethrough",
- "writeback",
- "unsafe",
- "directsync"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "cyls" : {
- "description" : "Force the drive's physical geometry to have a specific cylinder count.",
- "optional" : 1,
- "type" : "integer"
- },
- "detect_zeroes" : {
- "description" : "Controls whether to detect and try to optimize writes of zeroes.",
- "optional" : 1,
- "type" : "boolean"
- },
- "discard" : {
- "description" : "Controls whether to pass discard/trim requests to the underlying storage.",
- "enum" : [
- "ignore",
- "on"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "file" : {
- "default_key" : 1,
- "description" : "The drive's backing volume.",
- "format" : "pve-volume-id-or-qm-path",
- "format_description" : "volume",
- "type" : "string"
- },
- "format" : {
- "description" : "The drive's backing file's data format.",
- "enum" : [
- "raw",
- "cow",
- "qcow",
- "qed",
- "qcow2",
- "vmdk",
- "cloop"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "heads" : {
- "description" : "Force the drive's physical geometry to have a specific head count.",
- "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",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_max" : {
- "description" : "Maximum unthrottled r/w I/O pool in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_max_length" : {
- "description" : "Maximum length of I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "iops_rd" : {
- "description" : "Maximum read I/O in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_rd_length" : {
- "alias" : "iops_rd_max_length"
- },
- "iops_rd_max" : {
- "description" : "Maximum unthrottled read I/O pool in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_rd_max_length" : {
- "description" : "Maximum length of read I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "iops_wr" : {
- "description" : "Maximum write I/O in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_wr_length" : {
- "alias" : "iops_wr_max_length"
- },
- "iops_wr_max" : {
- "description" : "Maximum unthrottled write I/O pool in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_wr_max_length" : {
- "description" : "Maximum length of write I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "mbps" : {
- "description" : "Maximum r/w speed in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_max" : {
- "description" : "Maximum unthrottled r/w pool in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_rd" : {
- "description" : "Maximum read speed in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_rd_max" : {
- "description" : "Maximum unthrottled read pool in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_wr" : {
- "description" : "Maximum write speed in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_wr_max" : {
- "description" : "Maximum unthrottled write pool in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "media" : {
- "default" : "disk",
- "description" : "The drive's media type.",
- "enum" : [
- "cdrom",
- "disk"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "model" : {
- "description" : "The drive's reported model name, url-encoded, up to 40 bytes long.",
- "format" : "urlencoded",
- "format_description" : "model",
- "maxLength" : 120,
- "optional" : 1,
- "type" : "string"
- },
- "replicate" : {
- "default" : 1,
- "description" : "Whether the drive should considered for replication jobs.",
- "optional" : 1,
- "type" : "boolean"
- },
- "rerror" : {
- "description" : "Read error action.",
- "enum" : [
- "ignore",
- "report",
- "stop"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "secs" : {
- "description" : "Force the drive's physical geometry to have a specific sector count.",
- "optional" : 1,
- "type" : "integer"
- },
- "serial" : {
- "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long.",
- "format" : "urlencoded",
- "format_description" : "serial",
- "maxLength" : 60,
- "optional" : 1,
- "type" : "string"
- },
- "shared" : {
- "default" : 0,
- "description" : "Mark this locally-managed volume as available on all nodes",
- "optional" : 1,
- "type" : "boolean",
- "verbose_description" : "Mark this locally-managed volume as available on all nodes.\n\nWARNING: This option does not share the volume automatically, it assumes it is shared already!"
- },
- "size" : {
- "description" : "Disk size. This is purely informational and has no effect.",
- "format" : "disk-size",
- "format_description" : "DiskSize",
- "optional" : 1,
- "type" : "string"
- },
- "snapshot" : {
- "description" : "Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.",
- "optional" : 1,
- "type" : "boolean"
- },
- "ssd" : {
- "description" : "Whether to expose this drive as an SSD, rather than a rotational hard disk.",
- "optional" : 1,
- "type" : "boolean"
- },
- "trans" : {
- "description" : "Force disk geometry bios translation mode.",
- "enum" : [
- "none",
- "lba",
- "auto"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "volume" : {
- "alias" : "file"
- },
- "werror" : {
- "description" : "Write error action.",
- "enum" : [
- "enospc",
- "ignore",
- "report",
- "stop"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "wwn" : {
- "description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.",
- "format_description" : "wwn",
- "optional" : 1,
- "pattern" : "(?^:^(0x)[0-9a-fA-F]{16})",
- "type" : "string"
- }
- },
- "optional" : 1,
- "type" : "string",
- "typetext" : "[file=]<volume> [,aio=<native|threads|io_uring>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,import-from=<source volume>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]"
- },
- "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",
- "format" : "pve-qm-ipconfig",
- "optional" : 1,
- "type" : "string",
- "typetext" : "[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]"
- },
- "ivshmem" : {
- "description" : "Inter-VM shared memory. Useful for direct communication between VMs, or to the host.",
- "format" : {
- "name" : {
- "description" : "The name of the file. Will be prefixed with 'pve-shm-'. Default is the VMID. Will be deleted when the VM is stopped.",
- "format_description" : "string",
- "optional" : 1,
- "pattern" : "[a-zA-Z0-9\\-]+",
- "type" : "string"
- },
- "size" : {
- "description" : "The size of the file in MB.",
- "minimum" : 1,
- "type" : "integer"
- }
- },
- "optional" : 1,
- "type" : "string",
- "typetext" : "size=<integer> [,name=<string>]"
- },
- "keephugepages" : {
- "default" : 0,
- "description" : "Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "keyboard" : {
- "default" : null,
- "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",
- "da",
- "en-gb",
- "en-us",
- "es",
- "fi",
- "fr",
- "fr-be",
- "fr-ca",
- "fr-ch",
- "hu",
- "is",
- "it",
- "ja",
- "lt",
- "mk",
- "nl",
- "no",
- "pl",
- "pt",
- "pt-br",
- "sv",
- "sl",
- "tr"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "kvm" : {
- "default" : 1,
- "description" : "Enable/disable KVM hardware virtualization.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "localtime" : {
- "description" : "Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "lock" : {
- "description" : "Lock/unlock the VM.",
- "enum" : [
- "backup",
- "clone",
- "create",
- "migrate",
- "rollback",
- "snapshot",
- "snapshot-delete",
- "suspending",
- "suspended"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "machine" : {
- "description" : "Specifies the QEMU machine type.",
- "maxLength" : 40,
- "optional" : 1,
- "pattern" : "(pc|pc(-i440fx)?-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|q35|pc-q35-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|virt(?:-\\d+(\\.\\d+)+)?(\\+pve\\d+)?)",
- "type" : "string"
- },
- "memory" : {
- "default" : 512,
- "description" : "Amount of RAM for the VM in MiB. This is the maximum available memory when you use the balloon device.",
- "minimum" : 16,
- "optional" : 1,
- "type" : "integer",
- "typetext" : "<integer> (16 - N)"
- },
- "migrate_downtime" : {
- "default" : 0.1,
- "description" : "Set maximum tolerated downtime (in seconds) for migrations.",
- "minimum" : 0,
- "optional" : 1,
- "type" : "number",
- "typetext" : "<number> (0 - N)"
- },
- "migrate_speed" : {
- "default" : 0,
- "description" : "Set maximum speed (in MB/s) for migrations. Value 0 is no limit.",
- "minimum" : 0,
- "optional" : 1,
- "type" : "integer",
- "typetext" : "<integer> (0 - N)"
- },
- "name" : {
- "description" : "Set a name for the VM. Only used on the configuration web interface.",
- "format" : "dns-name",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "nameserver" : {
- "description" : "cloud-init: Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.",
- "format" : "address-list",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "net[n]" : {
- "description" : "Specify network devices.",
- "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,
- "type" : "string"
- },
- "e1000" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "e1000-82540em" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "e1000-82544gc" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "e1000-82545em" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "e1000e" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "firewall" : {
- "description" : "Whether this interface should be protected by the firewall.",
- "optional" : 1,
- "type" : "boolean"
- },
- "i82551" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "i82557b" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "i82559er" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "link_down" : {
- "description" : "Whether this interface should be disconnected (like pulling the plug).",
- "optional" : 1,
- "type" : "boolean"
- },
- "macaddr" : {
- "description" : "MAC address. That address must be unique withing your network. This is automatically generated if not specified.",
- "format" : "mac-addr",
- "format_description" : "XX:XX:XX:XX:XX:XX",
- "optional" : 1,
- "type" : "string",
- "verbose_description" : "A common MAC address with the I/G (Individual/Group) bit not set."
- },
- "model" : {
- "default_key" : 1,
- "description" : "Network Card Model. The 'virtio' model provides the best performance with very low CPU overhead. If your guest does not support this driver, it is usually best to use 'e1000'.",
- "enum" : [
- "e1000",
- "e1000-82540em",
- "e1000-82544gc",
- "e1000-82545em",
- "e1000e",
- "i82551",
- "i82557b",
- "i82559er",
- "ne2k_isa",
- "ne2k_pci",
- "pcnet",
- "rtl8139",
- "virtio",
- "vmxnet3"
- ],
- "type" : "string"
- },
- "mtu" : {
- "description" : "Force MTU, for VirtIO only. Set to '1' to use the bridge MTU",
- "maximum" : 65520,
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "ne2k_isa" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "ne2k_pci" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "pcnet" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "queues" : {
- "description" : "Number of packet queues to be used on the device.",
- "maximum" : 64,
- "minimum" : 0,
- "optional" : 1,
- "type" : "integer"
- },
- "rate" : {
- "description" : "Rate limit in mbps (megabytes per second) as floating point number.",
- "minimum" : 0,
- "optional" : 1,
- "type" : "number"
- },
- "rtl8139" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "tag" : {
- "description" : "VLAN tag to apply to packets on this interface.",
- "maximum" : 4094,
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "trunks" : {
- "description" : "VLAN trunks to pass through this interface.",
- "format_description" : "vlanid[;vlanid...]",
- "optional" : 1,
- "pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)",
- "type" : "string"
- },
- "virtio" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "vmxnet3" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- }
- },
- "optional" : 1,
- "type" : "string",
- "typetext" : "[model=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,mtu=<integer>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]"
- },
- "node" : {
- "description" : "The cluster node name.",
- "format" : "pve-node",
- "type" : "string",
- "typetext" : "<string>"
- },
- "numa" : {
- "default" : 0,
- "description" : "Enable/disable NUMA.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "numa[n]" : {
- "description" : "NUMA topology.",
- "format" : {
- "cpus" : {
- "description" : "CPUs accessing this NUMA node.",
- "format_description" : "id[-id];...",
- "pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)",
- "type" : "string"
- },
- "hostnodes" : {
- "description" : "Host NUMA nodes to use.",
- "format_description" : "id[-id];...",
- "optional" : 1,
- "pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)",
- "type" : "string"
- },
- "memory" : {
- "description" : "Amount of memory this NUMA node provides.",
- "optional" : 1,
- "type" : "number"
- },
- "policy" : {
- "description" : "NUMA allocation policy.",
- "enum" : [
- "preferred",
- "bind",
- "interleave"
- ],
- "optional" : 1,
- "type" : "string"
- }
- },
- "optional" : 1,
- "type" : "string",
- "typetext" : "cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]"
- },
- "onboot" : {
- "default" : 0,
- "description" : "Specifies whether a VM will be started during system bootup.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "ostype" : {
- "description" : "Specify guest operating system.",
- "enum" : [
- "other",
- "wxp",
- "w2k",
- "w2k3",
- "w2k8",
- "wvista",
- "win7",
- "win8",
- "win10",
- "win11",
- "l24",
- "l26",
- "solaris"
- ],
- "optional" : 1,
- "type" : "string",
- "verbose_description" : "Specify guest operating system. This is used to enable special\noptimization/features for specific operating systems:\n\n[horizontal]\nother;; unspecified OS\nwxp;; Microsoft Windows XP\nw2k;; Microsoft Windows 2000\nw2k3;; Microsoft Windows 2003\nw2k8;; Microsoft Windows 2008\nwvista;; Microsoft Windows Vista\nwin7;; Microsoft Windows 7\nwin8;; Microsoft Windows 8/2012/2012r2\nwin10;; Microsoft Windows 10/2016/2019\nwin11;; Microsoft Windows 11/2022\nl24;; Linux 2.4 Kernel\nl26;; Linux 2.6 - 6.X Kernel\nsolaris;; Solaris/OpenSolaris/OpenIndiania kernel\n"
- },
- "parallel[n]" : {
- "description" : "Map host parallel devices (n is 0 to 2).",
- "optional" : 1,
- "pattern" : "/dev/parport\\d+|/dev/usb/lp\\d+",
- "type" : "string",
- "verbose_description" : "Map host parallel devices (n is 0 to 2).\n\nNOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such\nmachines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n"
- },
- "protection" : {
- "default" : 0,
- "description" : "Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "reboot" : {
- "default" : 1,
- "description" : "Allow reboot. If set to '0' the VM exit on reboot.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "revert" : {
- "description" : "Revert a pending change.",
- "format" : "pve-configid-list",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "rng0" : {
- "description" : "Configure a VirtIO-based Random Number Generator.",
- "format" : {
- "max_bytes" : {
- "default" : 1024,
- "description" : "Maximum bytes of entropy allowed to get injected into the guest every 'period' milliseconds. Prefer a lower value when using '/dev/random' as source. Use `0` to disable limiting (potentially dangerous!).",
- "optional" : 1,
- "type" : "integer"
- },
- "period" : {
- "default" : 1000,
- "description" : "Every 'period' milliseconds the entropy-injection quota is reset, allowing the guest to retrieve another 'max_bytes' of entropy.",
- "optional" : 1,
- "type" : "integer"
- },
- "source" : {
- "default_key" : 1,
- "description" : "The file on the host to gather entropy from. In most cases '/dev/urandom' should be preferred over '/dev/random' to avoid entropy-starvation issues on the host. Using urandom does *not* decrease security in any meaningful way, as it's still seeded from real entropy, and the bytes provided will most likely be mixed with real entropy on the guest as well. '/dev/hwrng' can be used to pass through a hardware RNG from the host.",
- "enum" : [
- "/dev/urandom",
- "/dev/random",
- "/dev/hwrng"
- ],
- "type" : "string"
- }
- },
- "optional" : 1,
- "type" : "string",
- "typetext" : "[source=]</dev/urandom|/dev/random|/dev/hwrng> [,max_bytes=<integer>] [,period=<integer>]"
- },
- "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. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume.",
- "format" : {
- "aio" : {
- "description" : "AIO type to use.",
- "enum" : [
- "native",
- "threads",
- "io_uring"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "backup" : {
- "description" : "Whether the drive should be included when making backups.",
- "optional" : 1,
- "type" : "boolean"
- },
- "bps" : {
- "description" : "Maximum r/w speed in bytes per second.",
- "format_description" : "bps",
- "optional" : 1,
- "type" : "integer"
- },
- "bps_max_length" : {
- "description" : "Maximum length of I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "bps_rd" : {
- "description" : "Maximum read speed in bytes per second.",
- "format_description" : "bps",
- "optional" : 1,
- "type" : "integer"
- },
- "bps_rd_length" : {
- "alias" : "bps_rd_max_length"
- },
- "bps_rd_max_length" : {
- "description" : "Maximum length of read I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "bps_wr" : {
- "description" : "Maximum write speed in bytes per second.",
- "format_description" : "bps",
- "optional" : 1,
- "type" : "integer"
- },
- "bps_wr_length" : {
- "alias" : "bps_wr_max_length"
- },
- "bps_wr_max_length" : {
- "description" : "Maximum length of write I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "cache" : {
- "description" : "The drive's cache mode",
- "enum" : [
- "none",
- "writethrough",
- "writeback",
- "unsafe",
- "directsync"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "cyls" : {
- "description" : "Force the drive's physical geometry to have a specific cylinder count.",
- "optional" : 1,
- "type" : "integer"
- },
- "detect_zeroes" : {
- "description" : "Controls whether to detect and try to optimize writes of zeroes.",
- "optional" : 1,
- "type" : "boolean"
- },
- "discard" : {
- "description" : "Controls whether to pass discard/trim requests to the underlying storage.",
- "enum" : [
- "ignore",
- "on"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "file" : {
- "default_key" : 1,
- "description" : "The drive's backing volume.",
- "format" : "pve-volume-id-or-qm-path",
- "format_description" : "volume",
- "type" : "string"
- },
- "format" : {
- "description" : "The drive's backing file's data format.",
- "enum" : [
- "raw",
- "cow",
- "qcow",
- "qed",
- "qcow2",
- "vmdk",
- "cloop"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "heads" : {
- "description" : "Force the drive's physical geometry to have a specific head count.",
- "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",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_max" : {
- "description" : "Maximum unthrottled r/w I/O pool in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_max_length" : {
- "description" : "Maximum length of I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "iops_rd" : {
- "description" : "Maximum read I/O in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_rd_length" : {
- "alias" : "iops_rd_max_length"
- },
- "iops_rd_max" : {
- "description" : "Maximum unthrottled read I/O pool in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_rd_max_length" : {
- "description" : "Maximum length of read I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "iops_wr" : {
- "description" : "Maximum write I/O in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_wr_length" : {
- "alias" : "iops_wr_max_length"
- },
- "iops_wr_max" : {
- "description" : "Maximum unthrottled write I/O pool in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_wr_max_length" : {
- "description" : "Maximum length of write I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "mbps" : {
- "description" : "Maximum r/w speed in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_max" : {
- "description" : "Maximum unthrottled r/w pool in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_rd" : {
- "description" : "Maximum read speed in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_rd_max" : {
- "description" : "Maximum unthrottled read pool in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_wr" : {
- "description" : "Maximum write speed in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_wr_max" : {
- "description" : "Maximum unthrottled write pool in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "media" : {
- "default" : "disk",
- "description" : "The drive's media type.",
- "enum" : [
- "cdrom",
- "disk"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "replicate" : {
- "default" : 1,
- "description" : "Whether the drive should considered for replication jobs.",
- "optional" : 1,
- "type" : "boolean"
- },
- "rerror" : {
- "description" : "Read error action.",
- "enum" : [
- "ignore",
- "report",
- "stop"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "secs" : {
- "description" : "Force the drive's physical geometry to have a specific sector count.",
- "optional" : 1,
- "type" : "integer"
- },
- "serial" : {
- "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long.",
- "format" : "urlencoded",
- "format_description" : "serial",
- "maxLength" : 60,
- "optional" : 1,
- "type" : "string"
- },
- "shared" : {
- "default" : 0,
- "description" : "Mark this locally-managed volume as available on all nodes",
- "optional" : 1,
- "type" : "boolean",
- "verbose_description" : "Mark this locally-managed volume as available on all nodes.\n\nWARNING: This option does not share the volume automatically, it assumes it is shared already!"
- },
- "size" : {
- "description" : "Disk size. This is purely informational and has no effect.",
- "format" : "disk-size",
- "format_description" : "DiskSize",
- "optional" : 1,
- "type" : "string"
- },
- "snapshot" : {
- "description" : "Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.",
- "optional" : 1,
- "type" : "boolean"
- },
- "ssd" : {
- "description" : "Whether to expose this drive as an SSD, rather than a rotational hard disk.",
- "optional" : 1,
- "type" : "boolean"
- },
- "trans" : {
- "description" : "Force disk geometry bios translation mode.",
- "enum" : [
- "none",
- "lba",
- "auto"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "volume" : {
- "alias" : "file"
- },
- "werror" : {
- "description" : "Write error action.",
- "enum" : [
- "enospc",
- "ignore",
- "report",
- "stop"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "wwn" : {
- "description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.",
- "format_description" : "wwn",
- "optional" : 1,
- "pattern" : "(?^:^(0x)[0-9a-fA-F]{16})",
- "type" : "string"
- }
- },
- "optional" : 1,
- "type" : "string",
- "typetext" : "[file=]<volume> [,aio=<native|threads|io_uring>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,import-from=<source volume>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]"
- },
- "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. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume.",
- "format" : {
- "aio" : {
- "description" : "AIO type to use.",
- "enum" : [
- "native",
- "threads",
- "io_uring"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "backup" : {
- "description" : "Whether the drive should be included when making backups.",
- "optional" : 1,
- "type" : "boolean"
- },
- "bps" : {
- "description" : "Maximum r/w speed in bytes per second.",
- "format_description" : "bps",
- "optional" : 1,
- "type" : "integer"
- },
- "bps_max_length" : {
- "description" : "Maximum length of I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "bps_rd" : {
- "description" : "Maximum read speed in bytes per second.",
- "format_description" : "bps",
- "optional" : 1,
- "type" : "integer"
- },
- "bps_rd_length" : {
- "alias" : "bps_rd_max_length"
- },
- "bps_rd_max_length" : {
- "description" : "Maximum length of read I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "bps_wr" : {
- "description" : "Maximum write speed in bytes per second.",
- "format_description" : "bps",
- "optional" : 1,
- "type" : "integer"
- },
- "bps_wr_length" : {
- "alias" : "bps_wr_max_length"
- },
- "bps_wr_max_length" : {
- "description" : "Maximum length of write I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "cache" : {
- "description" : "The drive's cache mode",
- "enum" : [
- "none",
- "writethrough",
- "writeback",
- "unsafe",
- "directsync"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "cyls" : {
- "description" : "Force the drive's physical geometry to have a specific cylinder count.",
- "optional" : 1,
- "type" : "integer"
- },
- "detect_zeroes" : {
- "description" : "Controls whether to detect and try to optimize writes of zeroes.",
- "optional" : 1,
- "type" : "boolean"
- },
- "discard" : {
- "description" : "Controls whether to pass discard/trim requests to the underlying storage.",
- "enum" : [
- "ignore",
- "on"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "file" : {
- "default_key" : 1,
- "description" : "The drive's backing volume.",
- "format" : "pve-volume-id-or-qm-path",
- "format_description" : "volume",
- "type" : "string"
- },
- "format" : {
- "description" : "The drive's backing file's data format.",
- "enum" : [
- "raw",
- "cow",
- "qcow",
- "qed",
- "qcow2",
- "vmdk",
- "cloop"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "heads" : {
- "description" : "Force the drive's physical geometry to have a specific head count.",
- "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",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_max" : {
- "description" : "Maximum unthrottled r/w I/O pool in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_max_length" : {
- "description" : "Maximum length of I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "iops_rd" : {
- "description" : "Maximum read I/O in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_rd_length" : {
- "alias" : "iops_rd_max_length"
- },
- "iops_rd_max" : {
- "description" : "Maximum unthrottled read I/O pool in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_rd_max_length" : {
- "description" : "Maximum length of read I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "iops_wr" : {
- "description" : "Maximum write I/O in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_wr_length" : {
- "alias" : "iops_wr_max_length"
- },
- "iops_wr_max" : {
- "description" : "Maximum unthrottled write I/O pool in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_wr_max_length" : {
- "description" : "Maximum length of write I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "iothread" : {
- "description" : "Whether to use iothreads for this drive",
- "optional" : 1,
- "type" : "boolean"
- },
- "mbps" : {
- "description" : "Maximum r/w speed in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_max" : {
- "description" : "Maximum unthrottled r/w pool in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_rd" : {
- "description" : "Maximum read speed in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_rd_max" : {
- "description" : "Maximum unthrottled read pool in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_wr" : {
- "description" : "Maximum write speed in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_wr_max" : {
- "description" : "Maximum unthrottled write pool in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "media" : {
- "default" : "disk",
- "description" : "The drive's media type.",
- "enum" : [
- "cdrom",
- "disk"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "queues" : {
- "description" : "Number of queues.",
- "minimum" : 2,
- "optional" : 1,
- "type" : "integer"
- },
- "replicate" : {
- "default" : 1,
- "description" : "Whether the drive should considered for replication jobs.",
- "optional" : 1,
- "type" : "boolean"
- },
- "rerror" : {
- "description" : "Read error action.",
- "enum" : [
- "ignore",
- "report",
- "stop"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "ro" : {
- "description" : "Whether the drive is read-only.",
- "optional" : 1,
- "type" : "boolean"
- },
- "scsiblock" : {
- "default" : 0,
- "description" : "whether to use scsi-block for full passthrough of host block device\n\nWARNING: can lead to I/O errors in combination with low memory or high memory fragmentation on host",
- "optional" : 1,
- "type" : "boolean"
- },
- "secs" : {
- "description" : "Force the drive's physical geometry to have a specific sector count.",
- "optional" : 1,
- "type" : "integer"
- },
- "serial" : {
- "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long.",
- "format" : "urlencoded",
- "format_description" : "serial",
- "maxLength" : 60,
- "optional" : 1,
- "type" : "string"
- },
- "shared" : {
- "default" : 0,
- "description" : "Mark this locally-managed volume as available on all nodes",
- "optional" : 1,
- "type" : "boolean",
- "verbose_description" : "Mark this locally-managed volume as available on all nodes.\n\nWARNING: This option does not share the volume automatically, it assumes it is shared already!"
- },
- "size" : {
- "description" : "Disk size. This is purely informational and has no effect.",
- "format" : "disk-size",
- "format_description" : "DiskSize",
- "optional" : 1,
- "type" : "string"
- },
- "snapshot" : {
- "description" : "Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.",
- "optional" : 1,
- "type" : "boolean"
- },
- "ssd" : {
- "description" : "Whether to expose this drive as an SSD, rather than a rotational hard disk.",
- "optional" : 1,
- "type" : "boolean"
- },
- "trans" : {
- "description" : "Force disk geometry bios translation mode.",
- "enum" : [
- "none",
- "lba",
- "auto"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "volume" : {
- "alias" : "file"
- },
- "werror" : {
- "description" : "Write error action.",
- "enum" : [
- "enospc",
- "ignore",
- "report",
- "stop"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "wwn" : {
- "description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.",
- "format_description" : "wwn",
- "optional" : 1,
- "pattern" : "(?^:^(0x)[0-9a-fA-F]{16})",
- "type" : "string"
- }
- },
- "optional" : 1,
- "type" : "string",
- "typetext" : "[file=]<volume> [,aio=<native|threads|io_uring>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,import-from=<source volume>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<integer>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,ro=<1|0>] [,scsiblock=<1|0>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]"
- },
- "scsihw" : {
- "default" : "lsi",
- "description" : "SCSI controller model",
- "enum" : [
- "lsi",
- "lsi53c810",
- "virtio-scsi-pci",
- "virtio-scsi-single",
- "megasas",
- "pvscsi"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "searchdomain" : {
- "description" : "cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "serial[n]" : {
- "description" : "Create a serial device inside the VM (n is 0 to 3)",
- "optional" : 1,
- "pattern" : "(/dev/.+|socket)",
- "type" : "string",
- "verbose_description" : "Create a serial device inside the VM (n is 0 to 3), and pass through a\nhost serial device (i.e. /dev/ttyS0), or create a unix socket on the\nhost side (use 'qm terminal' to open a terminal connection).\n\nNOTE: If you pass through a host serial device, it is no longer possible to migrate such machines -\nuse with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n"
- },
- "shares" : {
- "default" : 1000,
- "description" : "Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning. Auto-ballooning is done by pvestatd.",
- "maximum" : 50000,
- "minimum" : 0,
- "optional" : 1,
- "type" : "integer",
- "typetext" : "<integer> (0 - 50000)"
- },
- "skiplock" : {
- "description" : "Ignore locks - only root is allowed to use this option.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "smbios1" : {
- "description" : "Specify SMBIOS type 1 fields.",
- "format" : "pve-qm-smbios1",
- "maxLength" : 512,
- "optional" : 1,
- "type" : "string",
- "typetext" : "[base64=<1|0>] [,family=<Base64 encoded string>] [,manufacturer=<Base64 encoded string>] [,product=<Base64 encoded string>] [,serial=<Base64 encoded string>] [,sku=<Base64 encoded string>] [,uuid=<UUID>] [,version=<Base64 encoded string>]"
- },
- "smp" : {
- "default" : 1,
- "description" : "The number of CPUs. Please use option -sockets instead.",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- },
- "sockets" : {
- "default" : 1,
- "description" : "The number of CPU sockets.",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- },
- "spice_enhancements" : {
- "description" : "Configure additional enhancements for SPICE.",
- "format" : {
- "foldersharing" : {
- "default" : "0",
- "description" : "Enable folder sharing via SPICE. Needs Spice-WebDAV daemon installed in the VM.",
- "optional" : 1,
- "type" : "boolean"
- },
- "videostreaming" : {
- "default" : "off",
- "description" : "Enable video streaming. Uses compression for detected video streams.",
- "enum" : [
- "off",
- "all",
- "filter"
- ],
- "optional" : 1,
- "type" : "string"
- }
- },
- "optional" : 1,
- "type" : "string",
- "typetext" : "[foldersharing=<1|0>] [,videostreaming=<off|all|filter>]"
- },
- "sshkeys" : {
- "description" : "cloud-init: Setup public SSH keys (one key per line, OpenSSH format).",
- "format" : "urlencoded",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "startdate" : {
- "default" : "now",
- "description" : "Set the initial date of the real time clock. Valid format for date are:'now' or '2006-06-17T16:01:21' or '2006-06-17'.",
- "optional" : 1,
- "pattern" : "(now|\\d{4}-\\d{1,2}-\\d{1,2}(T\\d{1,2}:\\d{1,2}:\\d{1,2})?)",
- "type" : "string",
- "typetext" : "(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)"
- },
- "startup" : {
- "description" : "Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.",
- "format" : "pve-startup-order",
- "optional" : 1,
- "type" : "string",
- "typetext" : "[[order=]\\d+] [,up=\\d+] [,down=\\d+] "
- },
- "tablet" : {
- "default" : 1,
- "description" : "Enable/disable the USB tablet device.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>",
- "verbose_description" : "Enable/disable the USB tablet device. This device is usually needed to allow absolute mouse positioning with VNC. Else the mouse runs out of sync with normal VNC clients. If you're running lots of console-only guests on one host, you may consider disabling this to save some context switches. This is turned off by default if you use spice (`qm set <vmid> --vga qxl`)."
- },
- "tags" : {
- "description" : "Tags of the VM. This is only meta information.",
- "format" : "pve-tag-list",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "tdf" : {
- "default" : 0,
- "description" : "Enable/disable time drift fix.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "template" : {
- "default" : 0,
- "description" : "Enable/disable Template.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "tpmstate0" : {
- "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,
- "description" : "The drive's backing volume.",
- "format" : "pve-volume-id-or-qm-path",
- "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",
- "format_description" : "DiskSize",
- "optional" : 1,
- "type" : "string"
- },
- "version" : {
- "default" : "v2.0",
- "description" : "The TPM interface version. v2.0 is newer and should be preferred. Note that this cannot be changed later on.",
- "enum" : [
- "v1.2",
- "v2.0"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "volume" : {
- "alias" : "file"
- }
- },
- "optional" : 1,
- "type" : "string",
- "typetext" : "[file=]<volume> [,import-from=<source volume>] [,size=<DiskSize>] [,version=<v1.2|v2.0>]"
- },
- "unused[n]" : {
- "description" : "Reference to unused volumes. This is used internally, and should not be modified manually.",
- "format" : {
- "file" : {
- "default_key" : 1,
- "description" : "The drive's backing volume.",
- "format" : "pve-volume-id",
- "format_description" : "volume",
- "type" : "string"
- },
- "volume" : {
- "alias" : "file"
- }
- },
- "optional" : 1,
- "type" : "string",
- "typetext" : "[file=]<volume>"
- },
- "usb[n]" : {
- "description" : "Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14).",
- "format" : {
- "host" : {
- "default_key" : 1,
- "description" : "The Host USB device or port or the value 'spice'. HOSTUSBDEVICE syntax is:\n\n 'bus-port(.port)*' (decimal numbers) or\n 'vendor_id:product_id' (hexadeciaml numbers) or\n 'spice'\n\nYou can use the 'lsusb -t' command to list existing usb devices.\n\nNOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such\nmachines - use with special care.\n\nThe value 'spice' can be used to add a usb redirection devices for spice.\n",
- "format" : "pve-qm-usb-device",
- "format_description" : "HOSTUSBDEVICE|spice",
- "type" : "string"
- },
- "usb3" : {
- "default" : 0,
- "description" : "Specifies whether if given host option is a USB3 device or port. For modern guests (machine version >= 7.1 and ostype l26 and windows > 7), this flag is irrelevant (all devices are plugged into a xhci controller).",
- "optional" : 1,
- "type" : "boolean"
- }
- },
- "optional" : 1,
- "type" : "string",
- "typetext" : "[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]"
- },
- "vcpus" : {
- "default" : 0,
- "description" : "Number of hotplugged vcpus.",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- },
- "vga" : {
- "description" : "Configure the VGA hardware.",
- "format" : {
- "memory" : {
- "description" : "Sets the VGA memory (in MiB). Has no effect with serial display.",
- "maximum" : 512,
- "minimum" : 4,
- "optional" : 1,
- "type" : "integer"
- },
- "type" : {
- "default" : "std",
- "default_key" : 1,
- "description" : "Select the VGA type.",
- "enum" : [
- "cirrus",
- "qxl",
- "qxl2",
- "qxl3",
- "qxl4",
- "none",
- "serial0",
- "serial1",
- "serial2",
- "serial3",
- "std",
- "virtio",
- "virtio-gl",
- "vmware"
- ],
- "optional" : 1,
- "type" : "string"
- }
- },
- "optional" : 1,
- "type" : "string",
- "typetext" : "[[type=]<enum>] [,memory=<integer>]",
- "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. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume.",
- "format" : {
- "aio" : {
- "description" : "AIO type to use.",
- "enum" : [
- "native",
- "threads",
- "io_uring"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "backup" : {
- "description" : "Whether the drive should be included when making backups.",
- "optional" : 1,
- "type" : "boolean"
- },
- "bps" : {
- "description" : "Maximum r/w speed in bytes per second.",
- "format_description" : "bps",
- "optional" : 1,
- "type" : "integer"
- },
- "bps_max_length" : {
- "description" : "Maximum length of I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "bps_rd" : {
- "description" : "Maximum read speed in bytes per second.",
- "format_description" : "bps",
- "optional" : 1,
- "type" : "integer"
- },
- "bps_rd_length" : {
- "alias" : "bps_rd_max_length"
- },
- "bps_rd_max_length" : {
- "description" : "Maximum length of read I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "bps_wr" : {
- "description" : "Maximum write speed in bytes per second.",
- "format_description" : "bps",
- "optional" : 1,
- "type" : "integer"
- },
- "bps_wr_length" : {
- "alias" : "bps_wr_max_length"
- },
- "bps_wr_max_length" : {
- "description" : "Maximum length of write I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "cache" : {
- "description" : "The drive's cache mode",
- "enum" : [
- "none",
- "writethrough",
- "writeback",
- "unsafe",
- "directsync"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "cyls" : {
- "description" : "Force the drive's physical geometry to have a specific cylinder count.",
- "optional" : 1,
- "type" : "integer"
- },
- "detect_zeroes" : {
- "description" : "Controls whether to detect and try to optimize writes of zeroes.",
- "optional" : 1,
- "type" : "boolean"
- },
- "discard" : {
- "description" : "Controls whether to pass discard/trim requests to the underlying storage.",
- "enum" : [
- "ignore",
- "on"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "file" : {
- "default_key" : 1,
- "description" : "The drive's backing volume.",
- "format" : "pve-volume-id-or-qm-path",
- "format_description" : "volume",
- "type" : "string"
- },
- "format" : {
- "description" : "The drive's backing file's data format.",
- "enum" : [
- "raw",
- "cow",
- "qcow",
- "qed",
- "qcow2",
- "vmdk",
- "cloop"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "heads" : {
- "description" : "Force the drive's physical geometry to have a specific head count.",
- "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",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_max" : {
- "description" : "Maximum unthrottled r/w I/O pool in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_max_length" : {
- "description" : "Maximum length of I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "iops_rd" : {
- "description" : "Maximum read I/O in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_rd_length" : {
- "alias" : "iops_rd_max_length"
- },
- "iops_rd_max" : {
- "description" : "Maximum unthrottled read I/O pool in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_rd_max_length" : {
- "description" : "Maximum length of read I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "iops_wr" : {
- "description" : "Maximum write I/O in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_wr_length" : {
- "alias" : "iops_wr_max_length"
- },
- "iops_wr_max" : {
- "description" : "Maximum unthrottled write I/O pool in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_wr_max_length" : {
- "description" : "Maximum length of write I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "iothread" : {
- "description" : "Whether to use iothreads for this drive",
- "optional" : 1,
- "type" : "boolean"
- },
- "mbps" : {
- "description" : "Maximum r/w speed in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_max" : {
- "description" : "Maximum unthrottled r/w pool in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_rd" : {
- "description" : "Maximum read speed in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_rd_max" : {
- "description" : "Maximum unthrottled read pool in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_wr" : {
- "description" : "Maximum write speed in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_wr_max" : {
- "description" : "Maximum unthrottled write pool in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "media" : {
- "default" : "disk",
- "description" : "The drive's media type.",
- "enum" : [
- "cdrom",
- "disk"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "replicate" : {
- "default" : 1,
- "description" : "Whether the drive should considered for replication jobs.",
- "optional" : 1,
- "type" : "boolean"
- },
- "rerror" : {
- "description" : "Read error action.",
- "enum" : [
- "ignore",
- "report",
- "stop"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "ro" : {
- "description" : "Whether the drive is read-only.",
- "optional" : 1,
- "type" : "boolean"
- },
- "secs" : {
- "description" : "Force the drive's physical geometry to have a specific sector count.",
- "optional" : 1,
- "type" : "integer"
- },
- "serial" : {
- "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long.",
- "format" : "urlencoded",
- "format_description" : "serial",
- "maxLength" : 60,
- "optional" : 1,
- "type" : "string"
- },
- "shared" : {
- "default" : 0,
- "description" : "Mark this locally-managed volume as available on all nodes",
- "optional" : 1,
- "type" : "boolean",
- "verbose_description" : "Mark this locally-managed volume as available on all nodes.\n\nWARNING: This option does not share the volume automatically, it assumes it is shared already!"
- },
- "size" : {
- "description" : "Disk size. This is purely informational and has no effect.",
- "format" : "disk-size",
- "format_description" : "DiskSize",
- "optional" : 1,
- "type" : "string"
- },
- "snapshot" : {
- "description" : "Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.",
- "optional" : 1,
- "type" : "boolean"
- },
- "trans" : {
- "description" : "Force disk geometry bios translation mode.",
- "enum" : [
- "none",
- "lba",
- "auto"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "volume" : {
- "alias" : "file"
- },
- "werror" : {
- "description" : "Write error action.",
- "enum" : [
- "enospc",
- "ignore",
- "report",
- "stop"
- ],
- "optional" : 1,
- "type" : "string"
- }
- },
- "optional" : 1,
- "type" : "string",
- "typetext" : "[file=]<volume> [,aio=<native|threads|io_uring>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,import-from=<source volume>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,ro=<1|0>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]"
- },
- "vmgenid" : {
- "default" : "1 (autogenerated)",
- "description" : "Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly.",
- "format_description" : "UUID",
- "optional" : 1,
- "pattern" : "(?:[a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}|[01])",
- "type" : "string",
- "verbose_description" : "The VM generation ID (vmgenid) device exposes a 128-bit integer value identifier to the guest OS. This allows to notify the guest operating system when the virtual machine is executed with a different configuration (e.g. snapshot execution or creation from a template). The guest operating system notices the change, and is then able to react as appropriate by marking its copies of distributed databases as dirty, re-initializing its random number generator, etc.\nNote that auto-creation only works when done through API/CLI create or update methods, but not when manually editing the config file."
- },
- "vmid" : {
- "description" : "The (unique) ID of the VM.",
- "format" : "pve-vmid",
- "minimum" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- },
- "vmstatestorage" : {
- "description" : "Default storage for VM state volumes/files.",
- "format" : "pve-storage-id",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "watchdog" : {
- "description" : "Create a virtual hardware watchdog device.",
- "format" : "pve-qm-watchdog",
- "optional" : 1,
- "type" : "string",
- "typetext" : "[[model=]<i6300esb|ib700>] [,action=<enum>]",
- "verbose_description" : "Create a virtual hardware watchdog device. Once enabled (by a guest action), the watchdog must be periodically polled by an agent inside the guest or else the watchdog will reset the guest (or execute the respective action specified)"
- }
- }
- },
- "permissions" : {
- "check" : [
- "perm",
- "/vms/{vmid}",
- [
- "VM.Config.Disk",
- "VM.Config.CDROM",
- "VM.Config.CPU",
- "VM.Config.Memory",
- "VM.Config.Network",
- "VM.Config.HWType",
- "VM.Config.Options",
- "VM.Config.Cloudinit"
- ],
- "any",
- 1
- ]
- },
- "protected" : 1,
- "proxyto" : "node",
- "returns" : {
- "type" : "null"
- }
- }
- },
- "leaf" : 1,
- "path" : "/nodes/{node}/qemu/{vmid}/config",
- "text" : "config"
- },
- {
- "info" : {
- "GET" : {
- "allowtoken" : 1,
- "description" : "Get the virtual machine configuration with both current and pending values.",
- "method" : "GET",
- "name" : "vm_pending",
- "parameters" : {
- "additionalProperties" : 0,
- "properties" : {
- "node" : {
- "description" : "The cluster node name.",
- "format" : "pve-node",
- "type" : "string",
- "typetext" : "<string>"
- },
- "vmid" : {
- "description" : "The (unique) ID of the VM.",
- "format" : "pve-vmid",
- "minimum" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- }
- }
- },
- "permissions" : {
- "check" : [
- "perm",
- "/vms/{vmid}",
- [
- "VM.Audit"
- ]
- ]
- },
- "proxyto" : "node",
- "returns" : {
- "items" : {
- "properties" : {
- "delete" : {
- "description" : "Indicates a pending delete request if present and not 0. The value 2 indicates a force-delete request.",
- "maximum" : 2,
- "minimum" : 0,
- "optional" : 1,
- "type" : "integer"
- },
- "key" : {
- "description" : "Configuration option name.",
- "type" : "string"
- },
- "pending" : {
- "description" : "Pending value.",
- "optional" : 1,
- "type" : "string"
- },
- "value" : {
- "description" : "Current value.",
- "optional" : 1,
- "type" : "string"
- }
- },
- "type" : "object"
- },
- "type" : "array"
- }
- }
- },
- "leaf" : 1,
- "path" : "/nodes/{node}/qemu/{vmid}/pending",
- "text" : "pending"
- },
- {
- "children" : [
- {
- "info" : {
- "GET" : {
- "allowtoken" : 1,
- "description" : "Get automatically generated cloudinit config.",
- "method" : "GET",
- "name" : "cloudinit_generated_config_dump",
- "parameters" : {
- "additionalProperties" : 0,
- "properties" : {
- "node" : {
- "description" : "The cluster node name.",
- "format" : "pve-node",
- "type" : "string",
- "typetext" : "<string>"
- },
- "type" : {
- "description" : "Config type.",
- "enum" : [
- "user",
- "network",
- "meta"
- ],
- "type" : "string"
- },
- "vmid" : {
- "description" : "The (unique) ID of the VM.",
- "format" : "pve-vmid",
- "minimum" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- }
- }
- },
- "permissions" : {
- "check" : [
- "perm",
- "/vms/{vmid}",
- [
- "VM.Audit"
- ]
- ]
- },
- "proxyto" : "node",
- "returns" : {
- "type" : "string"
- }
- }
- },
- "leaf" : 1,
- "path" : "/nodes/{node}/qemu/{vmid}/cloudinit/dump",
- "text" : "dump"
- }
- ],
- "info" : {
- "GET" : {
- "allowtoken" : 1,
- "description" : "Get the cloudinit configuration with both current and pending values.",
- "method" : "GET",
- "name" : "cloudinit_pending",
- "parameters" : {
- "additionalProperties" : 0,
- "properties" : {
- "node" : {
- "description" : "The cluster node name.",
- "format" : "pve-node",
- "type" : "string",
- "typetext" : "<string>"
- },
- "vmid" : {
- "description" : "The (unique) ID of the VM.",
- "format" : "pve-vmid",
- "minimum" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- }
- }
- },
- "permissions" : {
- "check" : [
- "perm",
- "/vms/{vmid}",
- [
- "VM.Audit"
- ]
- ]
- },
- "proxyto" : "node",
- "returns" : {
- "items" : {
- "properties" : {
- "key" : {
- "description" : "Configuration option name.",
- "type" : "string"
- },
- "new" : {
- "description" : "The new pending value.",
- "optional" : 1,
- "type" : "string"
- },
- "old" : {
- "description" : "Value as it was used to generate the current cloudinit image.",
- "optional" : 1,
- "type" : "string"
- }
- },
- "type" : "object"
- },
- "type" : "array"
- }
- },
- "PUT" : {
- "allowtoken" : 1,
- "description" : "Regenerate and change cloudinit config drive.",
- "method" : "PUT",
- "name" : "cloudinit_update",
- "parameters" : {
- "additionalProperties" : 0,
- "properties" : {
- "node" : {
- "description" : "The cluster node name.",
- "format" : "pve-node",
- "type" : "string",
- "typetext" : "<string>"
- },
- "vmid" : {
- "description" : "The (unique) ID of the VM.",
- "format" : "pve-vmid",
- "minimum" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- }
- }
- },
- "permissions" : {
- "check" : [
- "perm",
- "/vms/{vmid}",
- "VM.Config.Cloudinit"
- ]
- },
- "protected" : 1,
- "proxyto" : "node",
- "returns" : {
- "type" : "null"
- }
- }
- },
- "leaf" : 0,
- "path" : "/nodes/{node}/qemu/{vmid}/cloudinit",
- "text" : "cloudinit"
- },
- {
- "info" : {
- "PUT" : {
- "allowtoken" : 1,
- "description" : "Unlink/delete disk images.",
- "method" : "PUT",
- "name" : "unlink",
- "parameters" : {
- "additionalProperties" : 0,
- "properties" : {
- "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.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "idlist" : {
- "description" : "A list of disk IDs you want to delete.",
- "format" : "pve-configid-list",
- "type" : "string",
- "typetext" : "<string>"
- },
- "node" : {
- "description" : "The cluster node name.",
- "format" : "pve-node",
- "type" : "string",
- "typetext" : "<string>"
- },
- "vmid" : {
- "description" : "The (unique) ID of the VM.",
- "format" : "pve-vmid",
- "minimum" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- }
- }
- },
- "permissions" : {
- "check" : [
- "perm",
- "/vms/{vmid}",
- [
- "VM.Config.Disk"
- ]
- ]
- },
- "protected" : 1,
- "proxyto" : "node",
- "returns" : {
- "type" : "null"
- }
- }
- },
- "leaf" : 1,
- "path" : "/nodes/{node}/qemu/{vmid}/unlink",
- "text" : "unlink"
- },
- {
- "info" : {
- "POST" : {
- "allowtoken" : 1,
- "description" : "Creates a TCP VNC proxy connections.",
- "method" : "POST",
- "name" : "vncproxy",
- "parameters" : {
- "additionalProperties" : 0,
- "properties" : {
- "generate-password" : {
- "default" : 0,
- "description" : "Generates a random password to be used as ticket instead of the API ticket.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "node" : {
- "description" : "The cluster node name.",
- "format" : "pve-node",
- "type" : "string",
- "typetext" : "<string>"
- },
- "vmid" : {
- "description" : "The (unique) ID of the VM.",
- "format" : "pve-vmid",
- "minimum" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- },
- "websocket" : {
- "description" : "starts websockify instead of vncproxy",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- }
- }
- },
- "permissions" : {
- "check" : [
- "perm",
- "/vms/{vmid}",
- [
- "VM.Console"
- ]
- ]
- },
- "protected" : 1,
- "returns" : {
- "additionalProperties" : 0,
- "properties" : {
- "cert" : {
- "type" : "string"
- },
- "password" : {
- "description" : "Returned if requested with 'generate-password' param. Consists of printable ASCII characters ('!' .. '~').",
- "optional" : 1,
- "type" : "string"
- },
- "port" : {
- "type" : "integer"
- },
- "ticket" : {
- "type" : "string"
- },
- "upid" : {
- "type" : "string"
- },
- "user" : {
- "type" : "string"
- }
- }
- }
- }
- },
- "leaf" : 1,
- "path" : "/nodes/{node}/qemu/{vmid}/vncproxy",
- "text" : "vncproxy"
- },
- {
- "info" : {
- "POST" : {
- "allowtoken" : 1,
- "description" : "Creates a TCP proxy connections.",
- "method" : "POST",
- "name" : "termproxy",
- "parameters" : {
- "additionalProperties" : 0,
- "properties" : {
- "node" : {
- "description" : "The cluster node name.",
- "format" : "pve-node",
- "type" : "string",
- "typetext" : "<string>"
- },
- "serial" : {
- "description" : "opens a serial terminal (defaults to display)",
- "enum" : [
- "serial0",
- "serial1",
- "serial2",
- "serial3"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "vmid" : {
- "description" : "The (unique) ID of the VM.",
- "format" : "pve-vmid",
- "minimum" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- }
- }
- },
- "permissions" : {
- "check" : [
- "perm",
- "/vms/{vmid}",
- [
- "VM.Console"
- ]
- ]
- },
- "protected" : 1,
- "returns" : {
- "additionalProperties" : 0,
- "properties" : {
- "port" : {
- "type" : "integer"
- },
- "ticket" : {
- "type" : "string"
- },
- "upid" : {
- "type" : "string"
- },
- "user" : {
- "type" : "string"
- }
- }
- }
- }
- },
- "leaf" : 1,
- "path" : "/nodes/{node}/qemu/{vmid}/termproxy",
- "text" : "termproxy"
- },
- {
- "info" : {
- "GET" : {
- "allowtoken" : 1,
- "description" : "Opens a weksocket for VNC traffic.",
- "method" : "GET",
- "name" : "vncwebsocket",
- "parameters" : {
- "additionalProperties" : 0,
- "properties" : {
- "node" : {
- "description" : "The cluster node name.",
- "format" : "pve-node",
- "type" : "string",
- "typetext" : "<string>"
- },
- "port" : {
- "description" : "Port number returned by previous vncproxy call.",
- "maximum" : 5999,
- "minimum" : 5900,
- "type" : "integer",
- "typetext" : "<integer> (5900 - 5999)"
- },
- "vmid" : {
- "description" : "The (unique) ID of the VM.",
- "format" : "pve-vmid",
- "minimum" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- },
- "vncticket" : {
- "description" : "Ticket from previous call to vncproxy.",
- "maxLength" : 512,
- "type" : "string",
- "typetext" : "<string>"
- }
- }
- },
- "permissions" : {
- "check" : [
- "perm",
- "/vms/{vmid}",
- [
- "VM.Console"
- ]
- ],
- "description" : "You also need to pass a valid ticket (vncticket)."
- },
- "returns" : {
- "properties" : {
- "port" : {
- "type" : "string"
- }
- },
- "type" : "object"
- }
- }
- },
- "leaf" : 1,
- "path" : "/nodes/{node}/qemu/{vmid}/vncwebsocket",
- "text" : "vncwebsocket"
- },
- {
- "info" : {
- "POST" : {
- "allowtoken" : 1,
- "description" : "Returns a SPICE configuration to connect to the VM.",
- "method" : "POST",
- "name" : "spiceproxy",
- "parameters" : {
- "additionalProperties" : 0,
- "properties" : {
- "node" : {
- "description" : "The cluster node name.",
- "format" : "pve-node",
- "type" : "string",
- "typetext" : "<string>"
- },
- "proxy" : {
- "description" : "SPICE proxy server. This can be used by the client to specify the proxy server. All nodes in a cluster runs 'spiceproxy', so it is up to the client to choose one. By default, we return the node where the VM is currently running. As reasonable setting is to use same node you use to connect to the API (This is window.location.hostname for the JS GUI).",
- "format" : "address",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "vmid" : {
- "description" : "The (unique) ID of the VM.",
- "format" : "pve-vmid",
- "minimum" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- }
- }
- },
- "permissions" : {
- "check" : [
- "perm",
- "/vms/{vmid}",
- [
- "VM.Console"
- ]
- ]
- },
- "protected" : 1,
- "proxyto" : "node",
- "returns" : {
- "additionalProperties" : 1,
- "description" : "Returned values can be directly passed to the 'remote-viewer' application.",
- "properties" : {
- "host" : {
- "type" : "string"
- },
- "password" : {
- "type" : "string"
- },
- "proxy" : {
- "type" : "string"
- },
- "tls-port" : {
- "type" : "integer"
- },
- "type" : {
- "type" : "string"
- }
- }
- }
- }
- },
- "leaf" : 1,
- "path" : "/nodes/{node}/qemu/{vmid}/spiceproxy",
- "text" : "spiceproxy"
- },
- {
- "children" : [
- {
- "info" : {
- "GET" : {
- "allowtoken" : 1,
- "description" : "Get virtual machine status.",
- "method" : "GET",
- "name" : "vm_status",
- "parameters" : {
- "additionalProperties" : 0,
- "properties" : {
- "node" : {
- "description" : "The cluster node name.",
- "format" : "pve-node",
- "type" : "string",
- "typetext" : "<string>"
- },
- "vmid" : {
- "description" : "The (unique) ID of the VM.",
- "format" : "pve-vmid",
- "minimum" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- }
- }
- },
- "permissions" : {
- "check" : [
- "perm",
- "/vms/{vmid}",
- [
- "VM.Audit"
- ]
- ]
- },
- "protected" : 1,
- "proxyto" : "node",
- "returns" : {
- "properties" : {
- "agent" : {
- "description" : "QEMU Guest Agent is enabled in config.",
- "optional" : 1,
- "type" : "boolean"
- },
- "cpus" : {
- "description" : "Maximum usable CPUs.",
- "optional" : 1,
- "type" : "number"
- },
- "ha" : {
- "description" : "HA manager service status.",
- "type" : "object"
- },
- "lock" : {
- "description" : "The current config lock, if any.",
- "optional" : 1,
- "type" : "string"
- },
- "maxdisk" : {
- "description" : "Root disk size in bytes.",
- "optional" : 1,
- "renderer" : "bytes",
- "type" : "integer"
- },
- "maxmem" : {
- "description" : "Maximum memory in bytes.",
- "optional" : 1,
- "renderer" : "bytes",
- "type" : "integer"
- },
- "name" : {
- "description" : "VM name.",
- "optional" : 1,
- "type" : "string"
- },
- "pid" : {
- "description" : "PID of running qemu process.",
- "optional" : 1,
- "type" : "integer"
- },
- "qmpstatus" : {
- "description" : "QEMU QMP agent status.",
- "optional" : 1,
- "type" : "string"
- },
- "running-machine" : {
- "description" : "The currently running machine type (if running).",
- "optional" : 1,
- "type" : "string"
- },
- "running-qemu" : {
- "description" : "The currently running QEMU version (if running).",
- "optional" : 1,
- "type" : "string"
- },
- "spice" : {
- "description" : "QEMU VGA configuration supports spice.",
- "optional" : 1,
- "type" : "boolean"
- },
- "status" : {
- "description" : "QEMU process status.",
- "enum" : [
- "stopped",
- "running"
- ],
- "type" : "string"
- },
- "tags" : {
- "description" : "The current configured tags, if any",
- "optional" : 1,
- "type" : "string"
- },
- "uptime" : {
- "description" : "Uptime.",
- "optional" : 1,
- "renderer" : "duration",
- "type" : "integer"
- },
- "vmid" : {
- "description" : "The (unique) ID of the VM.",
- "format" : "pve-vmid",
- "minimum" : 1,
- "type" : "integer"
- }
- },
- "type" : "object"
- }
- }
- },
- "leaf" : 1,
- "path" : "/nodes/{node}/qemu/{vmid}/status/current",
- "text" : "current"
- },
- {
- "info" : {
- "POST" : {
- "allowtoken" : 1,
- "description" : "Start virtual machine.",
- "method" : "POST",
- "name" : "vm_start",
- "parameters" : {
- "additionalProperties" : 0,
- "properties" : {
- "force-cpu" : {
- "description" : "Override QEMU's -cpu argument with the given string.",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "machine" : {
- "description" : "Specifies the QEMU machine type.",
- "maxLength" : 40,
- "optional" : 1,
- "pattern" : "(pc|pc(-i440fx)?-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|q35|pc-q35-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|virt(?:-\\d+(\\.\\d+)+)?(\\+pve\\d+)?)",
- "type" : "string"
- },
- "migratedfrom" : {
- "description" : "The cluster node name.",
- "format" : "pve-node",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "migration_network" : {
- "description" : "CIDR of the (sub) network that is used for migration.",
- "format" : "CIDR",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "migration_type" : {
- "description" : "Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.",
- "enum" : [
- "secure",
- "insecure"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "node" : {
- "description" : "The cluster node name.",
- "format" : "pve-node",
- "type" : "string",
- "typetext" : "<string>"
- },
- "skiplock" : {
- "description" : "Ignore locks - only root is allowed to use this option.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "stateuri" : {
- "description" : "Some command save/restore state from this location.",
- "maxLength" : 128,
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "targetstorage" : {
- "description" : "Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself.",
- "format" : "storage-pair-list",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "timeout" : {
- "default" : "max(30, vm memory in GiB)",
- "description" : "Wait maximal timeout seconds.",
- "minimum" : 0,
- "optional" : 1,
- "type" : "integer",
- "typetext" : "<integer> (0 - N)"
- },
- "vmid" : {
- "description" : "The (unique) ID of the VM.",
- "format" : "pve-vmid",
- "minimum" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- }
- }
- },
- "permissions" : {
- "check" : [
- "perm",
- "/vms/{vmid}",
- [
- "VM.PowerMgmt"
- ]
- ]
- },
- "protected" : 1,
- "proxyto" : "node",
- "returns" : {
- "type" : "string"
- }
- }
- },
- "leaf" : 1,
- "path" : "/nodes/{node}/qemu/{vmid}/status/start",
- "text" : "start"
- },
- {
- "info" : {
- "POST" : {
- "allowtoken" : 1,
- "description" : "Stop virtual machine. The qemu process will exit immediately. Thisis akin to pulling the power plug of a running computer and may damage the VM data",
- "method" : "POST",
- "name" : "vm_stop",
- "parameters" : {
- "additionalProperties" : 0,
- "properties" : {
- "keepActive" : {
- "default" : 0,
- "description" : "Do not deactivate storage volumes.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "migratedfrom" : {
- "description" : "The cluster node name.",
- "format" : "pve-node",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "node" : {
- "description" : "The cluster node name.",
- "format" : "pve-node",
- "type" : "string",
- "typetext" : "<string>"
- },
- "skiplock" : {
- "description" : "Ignore locks - only root is allowed to use this option.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "timeout" : {
- "description" : "Wait maximal timeout seconds.",
- "minimum" : 0,
- "optional" : 1,
- "type" : "integer",
- "typetext" : "<integer> (0 - N)"
- },
- "vmid" : {
- "description" : "The (unique) ID of the VM.",
- "format" : "pve-vmid",
- "minimum" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- }
- }
- },
- "permissions" : {
- "check" : [
- "perm",
- "/vms/{vmid}",
- [
- "VM.PowerMgmt"
- ]
- ]
- },
- "protected" : 1,
- "proxyto" : "node",
- "returns" : {
- "type" : "string"
- }
- }
- },
- "leaf" : 1,
- "path" : "/nodes/{node}/qemu/{vmid}/status/stop",
- "text" : "stop"
- },
- {
- "info" : {
- "POST" : {
- "allowtoken" : 1,
- "description" : "Reset virtual machine.",
- "method" : "POST",
- "name" : "vm_reset",
- "parameters" : {
- "additionalProperties" : 0,
- "properties" : {
- "node" : {
- "description" : "The cluster node name.",
- "format" : "pve-node",
- "type" : "string",
- "typetext" : "<string>"
- },
- "skiplock" : {
- "description" : "Ignore locks - only root is allowed to use this option.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "vmid" : {
- "description" : "The (unique) ID of the VM.",
- "format" : "pve-vmid",
- "minimum" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- }
- }
- },
- "permissions" : {
- "check" : [
- "perm",
- "/vms/{vmid}",
- [
- "VM.PowerMgmt"
- ]
- ]
- },
- "protected" : 1,
- "proxyto" : "node",
- "returns" : {
- "type" : "string"
- }
- }
- },
- "leaf" : 1,
- "path" : "/nodes/{node}/qemu/{vmid}/status/reset",
- "text" : "reset"
- },
- {
- "info" : {
- "POST" : {
- "allowtoken" : 1,
- "description" : "Shutdown virtual machine. This is similar to pressing the power button on a physical machine.This will send an ACPI event for the guest OS, which should then proceed to a clean shutdown.",
- "method" : "POST",
- "name" : "vm_shutdown",
- "parameters" : {
- "additionalProperties" : 0,
- "properties" : {
- "forceStop" : {
- "default" : 0,
- "description" : "Make sure the VM stops.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "keepActive" : {
- "default" : 0,
- "description" : "Do not deactivate storage volumes.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "node" : {
- "description" : "The cluster node name.",
- "format" : "pve-node",
- "type" : "string",
- "typetext" : "<string>"
- },
- "skiplock" : {
- "description" : "Ignore locks - only root is allowed to use this option.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "timeout" : {
- "description" : "Wait maximal timeout seconds.",
- "minimum" : 0,
- "optional" : 1,
- "type" : "integer",
- "typetext" : "<integer> (0 - N)"
- },
- "vmid" : {
- "description" : "The (unique) ID of the VM.",
- "format" : "pve-vmid",
- "minimum" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- }
- }
- },
- "permissions" : {
- "check" : [
- "perm",
- "/vms/{vmid}",
- [
- "VM.PowerMgmt"
- ]
- ]
- },
- "protected" : 1,
- "proxyto" : "node",
- "returns" : {
- "type" : "string"
- }
- }
- },
- "leaf" : 1,
- "path" : "/nodes/{node}/qemu/{vmid}/status/shutdown",
- "text" : "shutdown"
- },
- {
- "info" : {
- "POST" : {
- "allowtoken" : 1,
- "description" : "Reboot the VM by shutting it down, and starting it again. Applies pending changes.",
- "method" : "POST",
- "name" : "vm_reboot",
- "parameters" : {
- "additionalProperties" : 0,
- "properties" : {
- "node" : {
- "description" : "The cluster node name.",
- "format" : "pve-node",
- "type" : "string",
- "typetext" : "<string>"
- },
- "timeout" : {
- "description" : "Wait maximal timeout seconds for the shutdown.",
- "minimum" : 0,
- "optional" : 1,
- "type" : "integer",
- "typetext" : "<integer> (0 - N)"
- },
- "vmid" : {
- "description" : "The (unique) ID of the VM.",
- "format" : "pve-vmid",
- "minimum" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- }
- }
- },
- "permissions" : {
- "check" : [
- "perm",
- "/vms/{vmid}",
- [
- "VM.PowerMgmt"
- ]
- ]
- },
- "protected" : 1,
- "proxyto" : "node",
- "returns" : {
- "type" : "string"
- }
- }
- },
- "leaf" : 1,
- "path" : "/nodes/{node}/qemu/{vmid}/status/reboot",
- "text" : "reboot"
- },
- {
- "info" : {
- "POST" : {
- "allowtoken" : 1,
- "description" : "Suspend virtual machine.",
- "method" : "POST",
- "name" : "vm_suspend",
- "parameters" : {
- "additionalProperties" : 0,
- "properties" : {
- "node" : {
- "description" : "The cluster node name.",
- "format" : "pve-node",
- "type" : "string",
- "typetext" : "<string>"
- },
- "skiplock" : {
- "description" : "Ignore locks - only root is allowed to use this option.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "statestorage" : {
- "description" : "The storage for the VM state",
- "format" : "pve-storage-id",
- "optional" : 1,
- "requires" : "todisk",
- "type" : "string",
- "typetext" : "<string>"
- },
- "todisk" : {
- "default" : 0,
- "description" : "If set, suspends the VM to disk. Will be resumed on next VM start.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "vmid" : {
- "description" : "The (unique) ID of the VM.",
- "format" : "pve-vmid",
- "minimum" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- }
- }
- },
- "permissions" : {
- "check" : [
- "perm",
- "/vms/{vmid}",
- [
- "VM.PowerMgmt"
- ]
- ],
- "description" : "You need 'VM.PowerMgmt' on /vms/{vmid}, and if you have set 'todisk', you need also 'VM.Config.Disk' on /vms/{vmid} and 'Datastore.AllocateSpace' on the storage for the vmstate."
- },
- "protected" : 1,
- "proxyto" : "node",
- "returns" : {
- "type" : "string"
- }
- }
- },
- "leaf" : 1,
- "path" : "/nodes/{node}/qemu/{vmid}/status/suspend",
- "text" : "suspend"
- },
- {
- "info" : {
- "POST" : {
- "allowtoken" : 1,
- "description" : "Resume virtual machine.",
- "method" : "POST",
- "name" : "vm_resume",
- "parameters" : {
- "additionalProperties" : 0,
- "properties" : {
- "nocheck" : {
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "node" : {
- "description" : "The cluster node name.",
- "format" : "pve-node",
- "type" : "string",
- "typetext" : "<string>"
- },
- "skiplock" : {
- "description" : "Ignore locks - only root is allowed to use this option.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "vmid" : {
- "description" : "The (unique) ID of the VM.",
- "format" : "pve-vmid",
- "minimum" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- }
- }
- },
- "permissions" : {
- "check" : [
- "perm",
- "/vms/{vmid}",
- [
- "VM.PowerMgmt"
- ]
- ]
- },
- "protected" : 1,
- "proxyto" : "node",
- "returns" : {
- "type" : "string"
- }
- }
- },
- "leaf" : 1,
- "path" : "/nodes/{node}/qemu/{vmid}/status/resume",
- "text" : "resume"
- }
- ],
- "info" : {
- "GET" : {
- "allowtoken" : 1,
- "description" : "Directory index",
- "method" : "GET",
- "name" : "vmcmdidx",
- "parameters" : {
- "additionalProperties" : 0,
- "properties" : {
- "node" : {
- "description" : "The cluster node name.",
- "format" : "pve-node",
- "type" : "string",
- "typetext" : "<string>"
- },
- "vmid" : {
- "description" : "The (unique) ID of the VM.",
- "format" : "pve-vmid",
- "minimum" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- }
- }
- },
- "permissions" : {
- "user" : "all"
- },
- "proxyto" : "node",
- "returns" : {
- "items" : {
- "properties" : {
- "subdir" : {
- "type" : "string"
- }
- },
- "type" : "object"
- },
- "links" : [
- {
- "href" : "{subdir}",
- "rel" : "child"
- }
- ],
- "type" : "array"
- }
- }
- },
- "leaf" : 0,
- "path" : "/nodes/{node}/qemu/{vmid}/status",
- "text" : "status"
- },
- {
- "info" : {
- "PUT" : {
- "allowtoken" : 1,
- "description" : "Send key event to virtual machine.",
- "method" : "PUT",
- "name" : "vm_sendkey",
- "parameters" : {
- "additionalProperties" : 0,
- "properties" : {
- "key" : {
- "description" : "The key (qemu monitor encoding).",
- "type" : "string",
- "typetext" : "<string>"
- },
- "node" : {
- "description" : "The cluster node name.",
- "format" : "pve-node",
- "type" : "string",
- "typetext" : "<string>"
- },
- "skiplock" : {
- "description" : "Ignore locks - only root is allowed to use this option.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "vmid" : {
- "description" : "The (unique) ID of the VM.",
- "format" : "pve-vmid",
- "minimum" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- }
- }
- },
- "permissions" : {
- "check" : [
- "perm",
- "/vms/{vmid}",
- [
- "VM.Console"
- ]
- ]
- },
- "protected" : 1,
- "proxyto" : "node",
- "returns" : {
- "type" : "null"
- }
- }
- },
- "leaf" : 1,
- "path" : "/nodes/{node}/qemu/{vmid}/sendkey",
- "text" : "sendkey"
- },
- {
- "info" : {
- "GET" : {
- "allowtoken" : 1,
- "description" : "Check if feature for virtual machine is available.",
- "method" : "GET",
- "name" : "vm_feature",
- "parameters" : {
- "additionalProperties" : 0,
- "properties" : {
- "feature" : {
- "description" : "Feature to check.",
- "enum" : [
- "snapshot",
- "clone",
- "copy"
- ],
- "type" : "string"
- },
- "node" : {
- "description" : "The cluster node name.",
- "format" : "pve-node",
- "type" : "string",
- "typetext" : "<string>"
- },
- "snapname" : {
- "description" : "The name of the snapshot.",
- "format" : "pve-configid",
- "maxLength" : 40,
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "vmid" : {
- "description" : "The (unique) ID of the VM.",
- "format" : "pve-vmid",
- "minimum" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- }
- }
- },
- "permissions" : {
- "check" : [
- "perm",
- "/vms/{vmid}",
- [
- "VM.Audit"
- ]
- ]
- },
- "protected" : 1,
- "proxyto" : "node",
- "returns" : {
- "properties" : {
- "hasFeature" : {
- "type" : "boolean"
- },
- "nodes" : {
- "items" : {
- "type" : "string"
- },
- "type" : "array"
- }
- },
- "type" : "object"
- }
- }
- },
- "leaf" : 1,
- "path" : "/nodes/{node}/qemu/{vmid}/feature",
- "text" : "feature"
- },
- {
- "info" : {
- "POST" : {
- "allowtoken" : 1,
- "description" : "Create a copy of virtual machine/template.",
- "method" : "POST",
- "name" : "clone_vm",
- "parameters" : {
- "additionalProperties" : 0,
- "properties" : {
- "bwlimit" : {
- "default" : "clone limit from datacenter or storage config",
- "description" : "Override I/O bandwidth limit (in KiB/s).",
- "minimum" : "0",
- "optional" : 1,
- "type" : "integer",
- "typetext" : "<integer> (0 - N)"
- },
- "description" : {
- "description" : "Description for the new VM.",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "format" : {
- "description" : "Target format for file storage. Only valid for full clone.",
- "enum" : [
- "raw",
- "qcow2",
- "vmdk"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "full" : {
- "description" : "Create a full copy of all disks. This is always done when you clone a normal VM. For VM templates, we try to create a linked clone by default.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "name" : {
- "description" : "Set a name for the new VM.",
- "format" : "dns-name",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "newid" : {
- "description" : "VMID for the clone.",
- "format" : "pve-vmid",
- "minimum" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- },
- "node" : {
- "description" : "The cluster node name.",
- "format" : "pve-node",
- "type" : "string",
- "typetext" : "<string>"
- },
- "pool" : {
- "description" : "Add the new VM to the specified pool.",
- "format" : "pve-poolid",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "snapname" : {
- "description" : "The name of the snapshot.",
- "format" : "pve-configid",
- "maxLength" : 40,
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "storage" : {
- "description" : "Target storage for full clone.",
- "format" : "pve-storage-id",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "target" : {
- "description" : "Target node. Only allowed if the original VM is on shared storage.",
- "format" : "pve-node",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "vmid" : {
- "description" : "The (unique) ID of the VM.",
- "format" : "pve-vmid",
- "minimum" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- }
- }
- },
- "permissions" : {
- "check" : [
- "and",
- [
- "perm",
- "/vms/{vmid}",
- [
- "VM.Clone"
- ]
- ],
- [
- "or",
- [
- "perm",
- "/vms/{newid}",
- [
- "VM.Allocate"
- ]
- ],
- [
- "perm",
- "/pool/{pool}",
- [
- "VM.Allocate"
- ],
- "require_param",
- "pool"
- ]
- ]
- ],
- "description" : "You need 'VM.Clone' permissions on /vms/{vmid}, and 'VM.Allocate' permissions on /vms/{newid} (or on the VM pool /pool/{pool}). You also need 'Datastore.AllocateSpace' on any used storage."
- },
- "protected" : 1,
- "proxyto" : "node",
- "returns" : {
- "type" : "string"
- }
- }
- },
- "leaf" : 1,
- "path" : "/nodes/{node}/qemu/{vmid}/clone",
- "text" : "clone"
- },
- {
- "info" : {
- "POST" : {
- "allowtoken" : 1,
- "description" : "Move volume to different storage or to a different VM.",
- "method" : "POST",
- "name" : "move_vm_disk",
- "parameters" : {
- "additionalProperties" : 0,
- "properties" : {
- "bwlimit" : {
- "default" : "move limit from datacenter or storage config",
- "description" : "Override I/O bandwidth limit (in KiB/s).",
- "minimum" : "0",
- "optional" : 1,
- "type" : "integer",
- "typetext" : "<integer> (0 - N)"
- },
- "delete" : {
- "default" : 0,
- "description" : "Delete the original disk after successful copy. By default the original disk is kept as unused disk.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "digest" : {
- "description" : "Prevent changes if current configuration file has different SHA1\"\n\t\t .\" digest. This can be used to prevent concurrent modifications.",
- "maxLength" : 40,
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "disk" : {
- "description" : "The disk you want to move.",
- "enum" : [
- "ide0",
- "ide1",
- "ide2",
- "ide3",
- "scsi0",
- "scsi1",
- "scsi2",
- "scsi3",
- "scsi4",
- "scsi5",
- "scsi6",
- "scsi7",
- "scsi8",
- "scsi9",
- "scsi10",
- "scsi11",
- "scsi12",
- "scsi13",
- "scsi14",
- "scsi15",
- "scsi16",
- "scsi17",
- "scsi18",
- "scsi19",
- "scsi20",
- "scsi21",
- "scsi22",
- "scsi23",
- "scsi24",
- "scsi25",
- "scsi26",
- "scsi27",
- "scsi28",
- "scsi29",
- "scsi30",
- "virtio0",
- "virtio1",
- "virtio2",
- "virtio3",
- "virtio4",
- "virtio5",
- "virtio6",
- "virtio7",
- "virtio8",
- "virtio9",
- "virtio10",
- "virtio11",
- "virtio12",
- "virtio13",
- "virtio14",
- "virtio15",
- "sata0",
- "sata1",
- "sata2",
- "sata3",
- "sata4",
- "sata5",
- "efidisk0",
- "tpmstate0",
- "unused0",
- "unused1",
- "unused2",
- "unused3",
- "unused4",
- "unused5",
- "unused6",
- "unused7",
- "unused8",
- "unused9",
- "unused10",
- "unused11",
- "unused12",
- "unused13",
- "unused14",
- "unused15",
- "unused16",
- "unused17",
- "unused18",
- "unused19",
- "unused20",
- "unused21",
- "unused22",
- "unused23",
- "unused24",
- "unused25",
- "unused26",
- "unused27",
- "unused28",
- "unused29",
- "unused30",
- "unused31",
- "unused32",
- "unused33",
- "unused34",
- "unused35",
- "unused36",
- "unused37",
- "unused38",
- "unused39",
- "unused40",
- "unused41",
- "unused42",
- "unused43",
- "unused44",
- "unused45",
- "unused46",
- "unused47",
- "unused48",
- "unused49",
- "unused50",
- "unused51",
- "unused52",
- "unused53",
- "unused54",
- "unused55",
- "unused56",
- "unused57",
- "unused58",
- "unused59",
- "unused60",
- "unused61",
- "unused62",
- "unused63",
- "unused64",
- "unused65",
- "unused66",
- "unused67",
- "unused68",
- "unused69",
- "unused70",
- "unused71",
- "unused72",
- "unused73",
- "unused74",
- "unused75",
- "unused76",
- "unused77",
- "unused78",
- "unused79",
- "unused80",
- "unused81",
- "unused82",
- "unused83",
- "unused84",
- "unused85",
- "unused86",
- "unused87",
- "unused88",
- "unused89",
- "unused90",
- "unused91",
- "unused92",
- "unused93",
- "unused94",
- "unused95",
- "unused96",
- "unused97",
- "unused98",
- "unused99",
- "unused100",
- "unused101",
- "unused102",
- "unused103",
- "unused104",
- "unused105",
- "unused106",
- "unused107",
- "unused108",
- "unused109",
- "unused110",
- "unused111",
- "unused112",
- "unused113",
- "unused114",
- "unused115",
- "unused116",
- "unused117",
- "unused118",
- "unused119",
- "unused120",
- "unused121",
- "unused122",
- "unused123",
- "unused124",
- "unused125",
- "unused126",
- "unused127",
- "unused128",
- "unused129",
- "unused130",
- "unused131",
- "unused132",
- "unused133",
- "unused134",
- "unused135",
- "unused136",
- "unused137",
- "unused138",
- "unused139",
- "unused140",
- "unused141",
- "unused142",
- "unused143",
- "unused144",
- "unused145",
- "unused146",
- "unused147",
- "unused148",
- "unused149",
- "unused150",
- "unused151",
- "unused152",
- "unused153",
- "unused154",
- "unused155",
- "unused156",
- "unused157",
- "unused158",
- "unused159",
- "unused160",
- "unused161",
- "unused162",
- "unused163",
- "unused164",
- "unused165",
- "unused166",
- "unused167",
- "unused168",
- "unused169",
- "unused170",
- "unused171",
- "unused172",
- "unused173",
- "unused174",
- "unused175",
- "unused176",
- "unused177",
- "unused178",
- "unused179",
- "unused180",
- "unused181",
- "unused182",
- "unused183",
- "unused184",
- "unused185",
- "unused186",
- "unused187",
- "unused188",
- "unused189",
- "unused190",
- "unused191",
- "unused192",
- "unused193",
- "unused194",
- "unused195",
- "unused196",
- "unused197",
- "unused198",
- "unused199",
- "unused200",
- "unused201",
- "unused202",
- "unused203",
- "unused204",
- "unused205",
- "unused206",
- "unused207",
- "unused208",
- "unused209",
- "unused210",
- "unused211",
- "unused212",
- "unused213",
- "unused214",
- "unused215",
- "unused216",
- "unused217",
- "unused218",
- "unused219",
- "unused220",
- "unused221",
- "unused222",
- "unused223",
- "unused224",
- "unused225",
- "unused226",
- "unused227",
- "unused228",
- "unused229",
- "unused230",
- "unused231",
- "unused232",
- "unused233",
- "unused234",
- "unused235",
- "unused236",
- "unused237",
- "unused238",
- "unused239",
- "unused240",
- "unused241",
- "unused242",
- "unused243",
- "unused244",
- "unused245",
- "unused246",
- "unused247",
- "unused248",
- "unused249",
- "unused250",
- "unused251",
- "unused252",
- "unused253",
- "unused254",
- "unused255"
- ],
- "type" : "string"
- },
- "format" : {
- "description" : "Target Format.",
- "enum" : [
- "raw",
- "qcow2",
- "vmdk"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "node" : {
- "description" : "The cluster node name.",
- "format" : "pve-node",
- "type" : "string",
- "typetext" : "<string>"
- },
- "storage" : {
- "description" : "Target storage.",
- "format" : "pve-storage-id",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "target-digest" : {
- "description" : "Prevent changes if the current config file of the target VM has a\"\n\t\t .\" different SHA1 digest. This can be used to detect concurrent modifications.",
- "maxLength" : 40,
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "target-disk" : {
- "description" : "The config key the disk will be moved to on the target VM (for example, ide0 or scsi1). Default is the source disk key.",
- "enum" : [
- "ide0",
- "ide1",
- "ide2",
- "ide3",
- "scsi0",
- "scsi1",
- "scsi2",
- "scsi3",
- "scsi4",
- "scsi5",
- "scsi6",
- "scsi7",
- "scsi8",
- "scsi9",
- "scsi10",
- "scsi11",
- "scsi12",
- "scsi13",
- "scsi14",
- "scsi15",
- "scsi16",
- "scsi17",
- "scsi18",
- "scsi19",
- "scsi20",
- "scsi21",
- "scsi22",
- "scsi23",
- "scsi24",
- "scsi25",
- "scsi26",
- "scsi27",
- "scsi28",
- "scsi29",
- "scsi30",
- "virtio0",
- "virtio1",
- "virtio2",
- "virtio3",
- "virtio4",
- "virtio5",
- "virtio6",
- "virtio7",
- "virtio8",
- "virtio9",
- "virtio10",
- "virtio11",
- "virtio12",
- "virtio13",
- "virtio14",
- "virtio15",
- "sata0",
- "sata1",
- "sata2",
- "sata3",
- "sata4",
- "sata5",
- "efidisk0",
- "tpmstate0",
- "unused0",
- "unused1",
- "unused2",
- "unused3",
- "unused4",
- "unused5",
- "unused6",
- "unused7",
- "unused8",
- "unused9",
- "unused10",
- "unused11",
- "unused12",
- "unused13",
- "unused14",
- "unused15",
- "unused16",
- "unused17",
- "unused18",
- "unused19",
- "unused20",
- "unused21",
- "unused22",
- "unused23",
- "unused24",
- "unused25",
- "unused26",
- "unused27",
- "unused28",
- "unused29",
- "unused30",
- "unused31",
- "unused32",
- "unused33",
- "unused34",
- "unused35",
- "unused36",
- "unused37",
- "unused38",
- "unused39",
- "unused40",
- "unused41",
- "unused42",
- "unused43",
- "unused44",
- "unused45",
- "unused46",
- "unused47",
- "unused48",
- "unused49",
- "unused50",
- "unused51",
- "unused52",
- "unused53",
- "unused54",
- "unused55",
- "unused56",
- "unused57",
- "unused58",
- "unused59",
- "unused60",
- "unused61",
- "unused62",
- "unused63",
- "unused64",
- "unused65",
- "unused66",
- "unused67",
- "unused68",
- "unused69",
- "unused70",
- "unused71",
- "unused72",
- "unused73",
- "unused74",
- "unused75",
- "unused76",
- "unused77",
- "unused78",
- "unused79",
- "unused80",
- "unused81",
- "unused82",
- "unused83",
- "unused84",
- "unused85",
- "unused86",
- "unused87",
- "unused88",
- "unused89",
- "unused90",
- "unused91",
- "unused92",
- "unused93",
- "unused94",
- "unused95",
- "unused96",
- "unused97",
- "unused98",
- "unused99",
- "unused100",
- "unused101",
- "unused102",
- "unused103",
- "unused104",
- "unused105",
- "unused106",
- "unused107",
- "unused108",
- "unused109",
- "unused110",
- "unused111",
- "unused112",
- "unused113",
- "unused114",
- "unused115",
- "unused116",
- "unused117",
- "unused118",
- "unused119",
- "unused120",
- "unused121",
- "unused122",
- "unused123",
- "unused124",
- "unused125",
- "unused126",
- "unused127",
- "unused128",
- "unused129",
- "unused130",
- "unused131",
- "unused132",
- "unused133",
- "unused134",
- "unused135",
- "unused136",
- "unused137",
- "unused138",
- "unused139",
- "unused140",
- "unused141",
- "unused142",
- "unused143",
- "unused144",
- "unused145",
- "unused146",
- "unused147",
- "unused148",
- "unused149",
- "unused150",
- "unused151",
- "unused152",
- "unused153",
- "unused154",
- "unused155",
- "unused156",
- "unused157",
- "unused158",
- "unused159",
- "unused160",
- "unused161",
- "unused162",
- "unused163",
- "unused164",
- "unused165",
- "unused166",
- "unused167",
- "unused168",
- "unused169",
- "unused170",
- "unused171",
- "unused172",
- "unused173",
- "unused174",
- "unused175",
- "unused176",
- "unused177",
- "unused178",
- "unused179",
- "unused180",
- "unused181",
- "unused182",
- "unused183",
- "unused184",
- "unused185",
- "unused186",
- "unused187",
- "unused188",
- "unused189",
- "unused190",
- "unused191",
- "unused192",
- "unused193",
- "unused194",
- "unused195",
- "unused196",
- "unused197",
- "unused198",
- "unused199",
- "unused200",
- "unused201",
- "unused202",
- "unused203",
- "unused204",
- "unused205",
- "unused206",
- "unused207",
- "unused208",
- "unused209",
- "unused210",
- "unused211",
- "unused212",
- "unused213",
- "unused214",
- "unused215",
- "unused216",
- "unused217",
- "unused218",
- "unused219",
- "unused220",
- "unused221",
- "unused222",
- "unused223",
- "unused224",
- "unused225",
- "unused226",
- "unused227",
- "unused228",
- "unused229",
- "unused230",
- "unused231",
- "unused232",
- "unused233",
- "unused234",
- "unused235",
- "unused236",
- "unused237",
- "unused238",
- "unused239",
- "unused240",
- "unused241",
- "unused242",
- "unused243",
- "unused244",
- "unused245",
- "unused246",
- "unused247",
- "unused248",
- "unused249",
- "unused250",
- "unused251",
- "unused252",
- "unused253",
- "unused254",
- "unused255"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "target-vmid" : {
- "description" : "The (unique) ID of the VM.",
- "format" : "pve-vmid",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- },
- "vmid" : {
- "description" : "The (unique) ID of the VM.",
- "format" : "pve-vmid",
- "minimum" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- }
- }
- },
- "permissions" : {
- "check" : [
- "perm",
- "/vms/{vmid}",
- [
- "VM.Config.Disk"
- ]
- ],
- "description" : "You need 'VM.Config.Disk' permissions on /vms/{vmid}, and 'Datastore.AllocateSpace' permissions on the storage. To move a disk to another VM, you need the permissions on the target VM as well."
- },
- "protected" : 1,
- "proxyto" : "node",
- "returns" : {
- "description" : "the task ID.",
- "type" : "string"
- }
- }
- },
- "leaf" : 1,
- "path" : "/nodes/{node}/qemu/{vmid}/move_disk",
- "text" : "move_disk"
- },
- {
- "info" : {
- "GET" : {
- "allowtoken" : 1,
- "description" : "Get preconditions for migration.",
- "method" : "GET",
- "name" : "migrate_vm_precondition",
- "parameters" : {
- "additionalProperties" : 0,
- "properties" : {
- "node" : {
- "description" : "The cluster node name.",
- "format" : "pve-node",
- "type" : "string",
- "typetext" : "<string>"
- },
- "target" : {
- "description" : "Target node.",
- "format" : "pve-node",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "vmid" : {
- "description" : "The (unique) ID of the VM.",
- "format" : "pve-vmid",
- "minimum" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- }
- }
- },
- "permissions" : {
- "check" : [
- "perm",
- "/vms/{vmid}",
- [
- "VM.Migrate"
- ]
- ]
- },
- "protected" : 1,
- "proxyto" : "node",
- "returns" : {
- "properties" : {
- "allowed_nodes" : {
- "description" : "List nodes allowed for offline migration, only passed if VM is offline",
- "optional" : 1,
- "type" : "array"
- },
- "local_disks" : {
- "description" : "List local disks including CD-Rom, unsused and not referenced disks",
- "type" : "array"
- },
- "local_resources" : {
- "description" : "List local resources e.g. pci, usb",
- "type" : "array"
- },
- "not_allowed_nodes" : {
- "description" : "List not allowed nodes with additional informations, only passed if VM is offline",
- "optional" : 1,
- "type" : "object"
- },
- "running" : {
- "type" : "boolean"
- }
- },
- "type" : "object"
- }
- },
- "POST" : {
- "allowtoken" : 1,
- "description" : "Migrate virtual machine. Creates a new migration task.",
- "method" : "POST",
- "name" : "migrate_vm",
- "parameters" : {
- "additionalProperties" : 0,
- "properties" : {
- "bwlimit" : {
- "default" : "migrate limit from datacenter or storage config",
- "description" : "Override I/O bandwidth limit (in KiB/s).",
- "minimum" : "0",
- "optional" : 1,
- "type" : "integer",
- "typetext" : "<integer> (0 - N)"
- },
- "force" : {
- "description" : "Allow to migrate VMs which use local devices. Only root may use this option.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "migration_network" : {
- "description" : "CIDR of the (sub) network that is used for migration.",
- "format" : "CIDR",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "migration_type" : {
- "description" : "Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.",
- "enum" : [
- "secure",
- "insecure"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "node" : {
- "description" : "The cluster node name.",
- "format" : "pve-node",
- "type" : "string",
- "typetext" : "<string>"
- },
- "online" : {
- "description" : "Use online/live migration if VM is running. Ignored if VM is stopped.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "target" : {
- "description" : "Target node.",
- "format" : "pve-node",
- "type" : "string",
- "typetext" : "<string>"
- },
- "targetstorage" : {
- "description" : "Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself.",
- "format" : "storage-pair-list",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "vmid" : {
- "description" : "The (unique) ID of the VM.",
- "format" : "pve-vmid",
- "minimum" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- },
- "with-local-disks" : {
- "description" : "Enable live storage migration for local disk",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- }
- }
- },
- "permissions" : {
- "check" : [
- "perm",
- "/vms/{vmid}",
- [
- "VM.Migrate"
- ]
- ]
- },
- "protected" : 1,
- "proxyto" : "node",
- "returns" : {
- "description" : "the task ID.",
- "type" : "string"
- }
- }
- },
- "leaf" : 1,
- "path" : "/nodes/{node}/qemu/{vmid}/migrate",
- "text" : "migrate"
- },
- {
- "info" : {
- "POST" : {
- "allowtoken" : 1,
- "description" : "Migrate virtual machine to a remote cluster. Creates a new migration task. EXPERIMENTAL feature!",
- "method" : "POST",
- "name" : "remote_migrate_vm",
- "parameters" : {
- "additionalProperties" : 0,
- "properties" : {
- "bwlimit" : {
- "default" : "migrate limit from datacenter or storage config",
- "description" : "Override I/O bandwidth limit (in KiB/s).",
- "minimum" : "0",
- "optional" : 1,
- "type" : "integer",
- "typetext" : "<integer> (0 - N)"
- },
- "delete" : {
- "default" : 0,
- "description" : "Delete the original VM and related data after successful migration. By default the original VM is kept on the source cluster in a stopped state.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "node" : {
- "description" : "The cluster node name.",
- "format" : "pve-node",
- "type" : "string",
- "typetext" : "<string>"
- },
- "online" : {
- "description" : "Use online/live migration if VM is running. Ignored if VM is stopped.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "target-bridge" : {
- "description" : "Mapping from source to target bridges. Providing only a single bridge ID maps all source bridges to that bridge. Providing the special value '1' will map each source bridge to itself.",
- "format" : "bridge-pair-list",
- "type" : "string",
- "typetext" : "<string>"
- },
- "target-endpoint" : {
- "description" : "Remote target endpoint",
- "format" : "proxmox-remote",
- "type" : "string",
- "typetext" : "apitoken=<A full Proxmox API token including the secret value.> ,host=<Remote Proxmox hostname or IP> [,fingerprint=<Remote host's certificate fingerprint, if not trusted by system store.>] [,port=<integer>]"
- },
- "target-storage" : {
- "description" : "Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself.",
- "format" : "storage-pair-list",
- "optional" : 0,
- "type" : "string",
- "typetext" : "<string>"
- },
- "target-vmid" : {
- "description" : "The (unique) ID of the VM.",
- "format" : "pve-vmid",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- },
- "vmid" : {
- "description" : "The (unique) ID of the VM.",
- "format" : "pve-vmid",
- "minimum" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- }
- }
- },
- "permissions" : {
- "check" : [
- "perm",
- "/vms/{vmid}",
- [
- "VM.Migrate"
- ]
- ]
- },
- "protected" : 1,
- "proxyto" : "node",
- "returns" : {
- "description" : "the task ID.",
- "type" : "string"
- }
- }
- },
- "leaf" : 1,
- "path" : "/nodes/{node}/qemu/{vmid}/remote_migrate",
- "text" : "remote_migrate"
- },
- {
- "info" : {
- "POST" : {
- "allowtoken" : 1,
- "description" : "Execute QEMU monitor commands.",
- "method" : "POST",
- "name" : "monitor",
- "parameters" : {
- "additionalProperties" : 0,
- "properties" : {
- "command" : {
- "description" : "The monitor command.",
- "type" : "string",
- "typetext" : "<string>"
- },
- "node" : {
- "description" : "The cluster node name.",
- "format" : "pve-node",
- "type" : "string",
- "typetext" : "<string>"
- },
- "vmid" : {
- "description" : "The (unique) ID of the VM.",
- "format" : "pve-vmid",
- "minimum" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- }
- }
- },
- "permissions" : {
- "check" : [
- "perm",
- "/vms/{vmid}",
- [
- "VM.Monitor"
- ]
- ],
- "description" : "Sys.Modify is required for (sub)commands which are not read-only ('info *' and 'help')"
- },
- "protected" : 1,
- "proxyto" : "node",
- "returns" : {
- "type" : "string"
- }
- }
- },
- "leaf" : 1,
- "path" : "/nodes/{node}/qemu/{vmid}/monitor",
- "text" : "monitor"
- },
- {
- "info" : {
- "PUT" : {
- "allowtoken" : 1,
- "description" : "Extend volume size.",
- "method" : "PUT",
- "name" : "resize_vm",
- "parameters" : {
- "additionalProperties" : 0,
- "properties" : {
- "digest" : {
- "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
- "maxLength" : 40,
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "disk" : {
- "description" : "The disk you want to resize.",
- "enum" : [
- "ide0",
- "ide1",
- "ide2",
- "ide3",
- "scsi0",
- "scsi1",
- "scsi2",
- "scsi3",
- "scsi4",
- "scsi5",
- "scsi6",
- "scsi7",
- "scsi8",
- "scsi9",
- "scsi10",
- "scsi11",
- "scsi12",
- "scsi13",
- "scsi14",
- "scsi15",
- "scsi16",
- "scsi17",
- "scsi18",
- "scsi19",
- "scsi20",
- "scsi21",
- "scsi22",
- "scsi23",
- "scsi24",
- "scsi25",
- "scsi26",
- "scsi27",
- "scsi28",
- "scsi29",
- "scsi30",
- "virtio0",
- "virtio1",
- "virtio2",
- "virtio3",
- "virtio4",
- "virtio5",
- "virtio6",
- "virtio7",
- "virtio8",
- "virtio9",
- "virtio10",
- "virtio11",
- "virtio12",
- "virtio13",
- "virtio14",
- "virtio15",
- "sata0",
- "sata1",
- "sata2",
- "sata3",
- "sata4",
- "sata5",
- "efidisk0",
- "tpmstate0"
- ],
- "type" : "string"
- },
- "node" : {
- "description" : "The cluster node name.",
- "format" : "pve-node",
- "type" : "string",
- "typetext" : "<string>"
- },
- "size" : {
- "description" : "The new size. With the `+` sign the value is added to the actual size of the volume and without it, the value is taken as an absolute one. Shrinking disk size is not supported.",
- "pattern" : "\\+?\\d+(\\.\\d+)?[KMGT]?",
- "type" : "string"
- },
- "skiplock" : {
- "description" : "Ignore locks - only root is allowed to use this option.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "vmid" : {
- "description" : "The (unique) ID of the VM.",
- "format" : "pve-vmid",
- "minimum" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- }
- }
- },
- "permissions" : {
- "check" : [
- "perm",
- "/vms/{vmid}",
- [
- "VM.Config.Disk"
- ]
- ]
- },
- "protected" : 1,
- "proxyto" : "node",
- "returns" : {
- "type" : "null"
- }
- }
- },
- "leaf" : 1,
- "path" : "/nodes/{node}/qemu/{vmid}/resize",
- "text" : "resize"
- },
- {
- "children" : [
- {
- "children" : [
- {
- "info" : {
- "GET" : {
- "allowtoken" : 1,
- "description" : "Get snapshot configuration",
- "method" : "GET",
- "name" : "get_snapshot_config",
- "parameters" : {
- "additionalProperties" : 0,
- "properties" : {
- "node" : {
- "description" : "The cluster node name.",
- "format" : "pve-node",
- "type" : "string",
- "typetext" : "<string>"
- },
- "snapname" : {
- "description" : "The name of the snapshot.",
- "format" : "pve-configid",
- "maxLength" : 40,
- "type" : "string",
- "typetext" : "<string>"
- },
- "vmid" : {
- "description" : "The (unique) ID of the VM.",
- "format" : "pve-vmid",
- "minimum" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- }
- }
- },
- "permissions" : {
- "check" : [
- "perm",
- "/vms/{vmid}",
- [
- "VM.Snapshot",
- "VM.Snapshot.Rollback",
- "VM.Audit"
- ],
- "any",
- 1
- ]
- },
- "proxyto" : "node",
- "returns" : {
- "type" : "object"
- }
- },
- "PUT" : {
- "allowtoken" : 1,
- "description" : "Update snapshot metadata.",
- "method" : "PUT",
- "name" : "update_snapshot_config",
- "parameters" : {
- "additionalProperties" : 0,
- "properties" : {
- "description" : {
- "description" : "A textual description or comment.",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "node" : {
- "description" : "The cluster node name.",
- "format" : "pve-node",
- "type" : "string",
- "typetext" : "<string>"
- },
- "snapname" : {
- "description" : "The name of the snapshot.",
- "format" : "pve-configid",
- "maxLength" : 40,
- "type" : "string",
- "typetext" : "<string>"
- },
- "vmid" : {
- "description" : "The (unique) ID of the VM.",
- "format" : "pve-vmid",
- "minimum" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- }
- }
- },
- "permissions" : {
- "check" : [
- "perm",
- "/vms/{vmid}",
- [
- "VM.Snapshot"
- ]
- ]
- },
- "protected" : 1,
- "proxyto" : "node",
- "returns" : {
- "type" : "null"
- }
- }
- },
- "leaf" : 1,
- "path" : "/nodes/{node}/qemu/{vmid}/snapshot/{snapname}/config",
- "text" : "config"
- },
- {
- "info" : {
- "POST" : {
- "allowtoken" : 1,
- "description" : "Rollback VM state to specified snapshot.",
- "method" : "POST",
- "name" : "rollback",
- "parameters" : {
- "additionalProperties" : 0,
- "properties" : {
- "node" : {
- "description" : "The cluster node name.",
- "format" : "pve-node",
- "type" : "string",
- "typetext" : "<string>"
- },
- "snapname" : {
- "description" : "The name of the snapshot.",
- "format" : "pve-configid",
- "maxLength" : 40,
- "type" : "string",
- "typetext" : "<string>"
- },
- "start" : {
- "default" : 0,
- "description" : "Whether the VM should get started after rolling back successfully. (Note: VMs will be automatically started if the snapshot includes RAM.)",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "vmid" : {
- "description" : "The (unique) ID of the VM.",
- "format" : "pve-vmid",
- "minimum" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- }
- }
- },
- "permissions" : {
- "check" : [
- "perm",
- "/vms/{vmid}",
- [
- "VM.Snapshot",
- "VM.Snapshot.Rollback"
- ],
- "any",
- 1
- ]
- },
- "protected" : 1,
- "proxyto" : "node",
- "returns" : {
- "description" : "the task ID.",
- "type" : "string"
- }
- }
- },
- "leaf" : 1,
- "path" : "/nodes/{node}/qemu/{vmid}/snapshot/{snapname}/rollback",
- "text" : "rollback"
- }
- ],
- "info" : {
- "DELETE" : {
- "allowtoken" : 1,
- "description" : "Delete a VM snapshot.",
- "method" : "DELETE",
- "name" : "delsnapshot",
- "parameters" : {
- "additionalProperties" : 0,
- "properties" : {
- "force" : {
- "description" : "For removal from config file, even if removing disk snapshots fails.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "node" : {
- "description" : "The cluster node name.",
- "format" : "pve-node",
- "type" : "string",
- "typetext" : "<string>"
- },
- "snapname" : {
- "description" : "The name of the snapshot.",
- "format" : "pve-configid",
- "maxLength" : 40,
- "type" : "string",
- "typetext" : "<string>"
- },
- "vmid" : {
- "description" : "The (unique) ID of the VM.",
- "format" : "pve-vmid",
- "minimum" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- }
- }
- },
- "permissions" : {
- "check" : [
- "perm",
- "/vms/{vmid}",
- [
- "VM.Snapshot"
- ]
- ]
- },
- "protected" : 1,
- "proxyto" : "node",
- "returns" : {
- "description" : "the task ID.",
- "type" : "string"
- }
- },
- "GET" : {
- "allowtoken" : 1,
- "description" : "",
- "method" : "GET",
- "name" : "snapshot_cmd_idx",
- "parameters" : {
- "additionalProperties" : 0,
- "properties" : {
- "node" : {
- "description" : "The cluster node name.",
- "format" : "pve-node",
- "type" : "string",
- "typetext" : "<string>"
- },
- "snapname" : {
- "description" : "The name of the snapshot.",
- "format" : "pve-configid",
- "maxLength" : 40,
- "type" : "string",
- "typetext" : "<string>"
- },
- "vmid" : {
- "description" : "The (unique) ID of the VM.",
- "format" : "pve-vmid",
- "minimum" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- }
- }
- },
- "permissions" : {
- "user" : "all"
- },
- "returns" : {
- "items" : {
- "properties" : {},
- "type" : "object"
- },
- "links" : [
- {
- "href" : "{cmd}",
- "rel" : "child"
- }
- ],
- "type" : "array"
- }
- }
- },
- "leaf" : 0,
- "path" : "/nodes/{node}/qemu/{vmid}/snapshot/{snapname}",
- "text" : "{snapname}"
- }
- ],
- "info" : {
- "GET" : {
- "allowtoken" : 1,
- "description" : "List all snapshots.",
- "method" : "GET",
- "name" : "snapshot_list",
- "parameters" : {
- "additionalProperties" : 0,
- "properties" : {
- "node" : {
- "description" : "The cluster node name.",
- "format" : "pve-node",
- "type" : "string",
- "typetext" : "<string>"
- },
- "vmid" : {
- "description" : "The (unique) ID of the VM.",
- "format" : "pve-vmid",
- "minimum" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- }
- }
- },
- "permissions" : {
- "check" : [
- "perm",
- "/vms/{vmid}",
- [
- "VM.Audit"
- ]
- ]
- },
- "protected" : 1,
- "proxyto" : "node",
- "returns" : {
- "items" : {
- "properties" : {
- "description" : {
- "description" : "Snapshot description.",
- "type" : "string"
- },
- "name" : {
- "description" : "Snapshot identifier. Value 'current' identifies the current VM.",
- "type" : "string"
- },
- "parent" : {
- "description" : "Parent snapshot identifier.",
- "optional" : 1,
- "type" : "string"
- },
- "snaptime" : {
- "description" : "Snapshot creation time",
- "optional" : 1,
- "renderer" : "timestamp",
- "type" : "integer"
- },
- "vmstate" : {
- "description" : "Snapshot includes RAM.",
- "optional" : 1,
- "type" : "boolean"
- }
- },
- "type" : "object"
- },
- "links" : [
- {
- "href" : "{name}",
- "rel" : "child"
- }
- ],
- "type" : "array"
- }
- },
- "POST" : {
- "allowtoken" : 1,
- "description" : "Snapshot a VM.",
- "method" : "POST",
- "name" : "snapshot",
- "parameters" : {
- "additionalProperties" : 0,
- "properties" : {
- "description" : {
- "description" : "A textual description or comment.",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "node" : {
- "description" : "The cluster node name.",
- "format" : "pve-node",
- "type" : "string",
- "typetext" : "<string>"
- },
- "snapname" : {
- "description" : "The name of the snapshot.",
- "format" : "pve-configid",
- "maxLength" : 40,
- "type" : "string",
- "typetext" : "<string>"
- },
- "vmid" : {
- "description" : "The (unique) ID of the VM.",
- "format" : "pve-vmid",
- "minimum" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- },
- "vmstate" : {
- "description" : "Save the vmstate",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- }
- }
- },
- "permissions" : {
- "check" : [
- "perm",
- "/vms/{vmid}",
- [
- "VM.Snapshot"
- ]
- ]
- },
- "protected" : 1,
- "proxyto" : "node",
- "returns" : {
- "description" : "the task ID.",
- "type" : "string"
- }
- }
- },
- "leaf" : 0,
- "path" : "/nodes/{node}/qemu/{vmid}/snapshot",
- "text" : "snapshot"
- },
- {
- "info" : {
- "POST" : {
- "allowtoken" : 1,
- "description" : "Create a Template.",
- "method" : "POST",
- "name" : "template",
- "parameters" : {
- "additionalProperties" : 0,
- "properties" : {
- "disk" : {
- "description" : "If you want to convert only 1 disk to base image.",
- "enum" : [
- "ide0",
- "ide1",
- "ide2",
- "ide3",
- "scsi0",
- "scsi1",
- "scsi2",
- "scsi3",
- "scsi4",
- "scsi5",
- "scsi6",
- "scsi7",
- "scsi8",
- "scsi9",
- "scsi10",
- "scsi11",
- "scsi12",
- "scsi13",
- "scsi14",
- "scsi15",
- "scsi16",
- "scsi17",
- "scsi18",
- "scsi19",
- "scsi20",
- "scsi21",
- "scsi22",
- "scsi23",
- "scsi24",
- "scsi25",
- "scsi26",
- "scsi27",
- "scsi28",
- "scsi29",
- "scsi30",
- "virtio0",
- "virtio1",
- "virtio2",
- "virtio3",
- "virtio4",
- "virtio5",
- "virtio6",
- "virtio7",
- "virtio8",
- "virtio9",
- "virtio10",
- "virtio11",
- "virtio12",
- "virtio13",
- "virtio14",
- "virtio15",
- "sata0",
- "sata1",
- "sata2",
- "sata3",
- "sata4",
- "sata5",
- "efidisk0",
- "tpmstate0"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "node" : {
- "description" : "The cluster node name.",
- "format" : "pve-node",
- "type" : "string",
- "typetext" : "<string>"
- },
- "vmid" : {
- "description" : "The (unique) ID of the VM.",
- "format" : "pve-vmid",
- "minimum" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- }
- }
- },
- "permissions" : {
- "check" : [
- "perm",
- "/vms/{vmid}",
- [
- "VM.Allocate"
- ]
- ],
- "description" : "You need 'VM.Allocate' permissions on /vms/{vmid}"
- },
- "protected" : 1,
- "proxyto" : "node",
- "returns" : {
- "description" : "the task ID.",
- "type" : "string"
- }
- }
- },
- "leaf" : 1,
- "path" : "/nodes/{node}/qemu/{vmid}/template",
- "text" : "template"
- },
- {
- "info" : {
- "POST" : {
- "allowtoken" : 1,
- "description" : "Migration tunnel endpoint - only for internal use by VM migration.",
- "method" : "POST",
- "name" : "mtunnel",
- "parameters" : {
- "additionalProperties" : 0,
- "properties" : {
- "bridges" : {
- "description" : "List of network bridges to check availability. Will be checked again for actually used bridges during migration.",
- "format" : "pve-bridge-id-list",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "node" : {
- "description" : "The cluster node name.",
- "format" : "pve-node",
- "type" : "string",
- "typetext" : "<string>"
- },
- "storages" : {
- "description" : "List of storages to check permission and availability. Will be checked again for all actually used storages during migration.",
- "format" : "pve-storage-id-list",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "vmid" : {
- "description" : "The (unique) ID of the VM.",
- "format" : "pve-vmid",
- "minimum" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- }
- }
- },
- "permissions" : {
- "check" : [
- "and",
- [
- "perm",
- "/vms/{vmid}",
- [
- "VM.Allocate"
- ]
- ],
- [
- "perm",
- "/",
- [
- "Sys.Incoming"
- ]
- ]
- ],
- "description" : "You need 'VM.Allocate' permissions on '/vms/{vmid}' and Sys.Incoming on '/'. Further permission checks happen during the actual migration."
- },
- "protected" : 1,
- "returns" : {
- "additionalProperties" : 0,
- "properties" : {
- "socket" : {
- "type" : "string"
- },
- "ticket" : {
- "type" : "string"
- },
- "upid" : {
- "type" : "string"
- }
- }
- }
- }
- },
- "leaf" : 1,
- "path" : "/nodes/{node}/qemu/{vmid}/mtunnel",
- "text" : "mtunnel"
- },
- {
- "info" : {
- "GET" : {
- "allowtoken" : 1,
- "description" : "Migration tunnel endpoint for websocket upgrade - only for internal use by VM migration.",
- "method" : "GET",
- "name" : "mtunnelwebsocket",
- "parameters" : {
- "additionalProperties" : 0,
- "properties" : {
- "node" : {
- "description" : "The cluster node name.",
- "format" : "pve-node",
- "type" : "string",
- "typetext" : "<string>"
- },
- "socket" : {
- "description" : "unix socket to forward to",
- "type" : "string",
- "typetext" : "<string>"
- },
- "ticket" : {
- "description" : "ticket return by initial 'mtunnel' API call, or retrieved via 'ticket' tunnel command",
- "type" : "string",
- "typetext" : "<string>"
- },
- "vmid" : {
- "description" : "The (unique) ID of the VM.",
- "format" : "pve-vmid",
- "minimum" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- }
- }
- },
- "permissions" : {
- "description" : "You need to pass a ticket valid for the selected socket. Tickets can be created via the mtunnel API call, which will check permissions accordingly.",
- "user" : "all"
- },
- "returns" : {
- "properties" : {
- "port" : {
- "optional" : 1,
- "type" : "string"
- },
- "socket" : {
- "optional" : 1,
- "type" : "string"
- }
- },
- "type" : "object"
- }
- }
- },
- "leaf" : 1,
- "path" : "/nodes/{node}/qemu/{vmid}/mtunnelwebsocket",
- "text" : "mtunnelwebsocket"
- }
- ],
- "info" : {
- "DELETE" : {
- "allowtoken" : 1,
- "description" : "Destroy the VM and all used/owned volumes. Removes any VM specific permissions and firewall rules",
- "method" : "DELETE",
- "name" : "destroy_vm",
- "parameters" : {
- "additionalProperties" : 0,
- "properties" : {
- "destroy-unreferenced-disks" : {
- "default" : 0,
- "description" : "If set, destroy additionally all disks not referenced in the config but with a matching VMID from all enabled storages.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "node" : {
- "description" : "The cluster node name.",
- "format" : "pve-node",
- "type" : "string",
- "typetext" : "<string>"
- },
- "purge" : {
- "description" : "Remove VMID from configurations, like backup & replication jobs and HA.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "skiplock" : {
- "description" : "Ignore locks - only root is allowed to use this option.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "vmid" : {
- "description" : "The (unique) ID of the VM.",
- "format" : "pve-vmid",
- "minimum" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- }
- }
- },
- "permissions" : {
- "check" : [
- "perm",
- "/vms/{vmid}",
- [
- "VM.Allocate"
- ]
- ]
- },
- "protected" : 1,
- "proxyto" : "node",
- "returns" : {
- "type" : "string"
- }
- },
- "GET" : {
- "allowtoken" : 1,
- "description" : "Directory index",
- "method" : "GET",
- "name" : "vmdiridx",
- "parameters" : {
- "additionalProperties" : 0,
- "properties" : {
- "node" : {
- "description" : "The cluster node name.",
- "format" : "pve-node",
- "type" : "string",
- "typetext" : "<string>"
- },
- "vmid" : {
- "description" : "The (unique) ID of the VM.",
- "format" : "pve-vmid",
- "minimum" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- }
- }
- },
- "permissions" : {
- "user" : "all"
- },
- "proxyto" : "node",
- "returns" : {
- "items" : {
- "properties" : {
- "subdir" : {
- "type" : "string"
- }
- },
- "type" : "object"
- },
- "links" : [
- {
- "href" : "{subdir}",
- "rel" : "child"
- }
- ],
- "type" : "array"
- }
- }
- },
- "leaf" : 0,
- "path" : "/nodes/{node}/qemu/{vmid}",
- "text" : "{vmid}"
- }
- ],
- "info" : {
- "GET" : {
- "allowtoken" : 1,
- "description" : "Virtual machine index (per node).",
- "method" : "GET",
- "name" : "vmlist",
- "parameters" : {
- "additionalProperties" : 0,
- "properties" : {
- "full" : {
- "description" : "Determine the full status of active VMs.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "node" : {
- "description" : "The cluster node name.",
- "format" : "pve-node",
- "type" : "string",
- "typetext" : "<string>"
- }
- }
- },
- "permissions" : {
- "description" : "Only list VMs where you have VM.Audit permissons on /vms/<vmid>.",
- "user" : "all"
- },
- "protected" : 1,
- "proxyto" : "node",
- "returns" : {
- "items" : {
- "properties" : {
- "cpus" : {
- "description" : "Maximum usable CPUs.",
- "optional" : 1,
- "type" : "number"
- },
- "lock" : {
- "description" : "The current config lock, if any.",
- "optional" : 1,
- "type" : "string"
- },
- "maxdisk" : {
- "description" : "Root disk size in bytes.",
- "optional" : 1,
- "renderer" : "bytes",
- "type" : "integer"
- },
- "maxmem" : {
- "description" : "Maximum memory in bytes.",
- "optional" : 1,
- "renderer" : "bytes",
- "type" : "integer"
- },
- "name" : {
- "description" : "VM name.",
- "optional" : 1,
- "type" : "string"
- },
- "pid" : {
- "description" : "PID of running qemu process.",
- "optional" : 1,
- "type" : "integer"
- },
- "qmpstatus" : {
- "description" : "QEMU QMP agent status.",
- "optional" : 1,
- "type" : "string"
- },
- "running-machine" : {
- "description" : "The currently running machine type (if running).",
- "optional" : 1,
- "type" : "string"
- },
- "running-qemu" : {
- "description" : "The currently running QEMU version (if running).",
- "optional" : 1,
- "type" : "string"
- },
- "status" : {
- "description" : "QEMU process status.",
- "enum" : [
- "stopped",
- "running"
- ],
- "type" : "string"
- },
- "tags" : {
- "description" : "The current configured tags, if any",
- "optional" : 1,
- "type" : "string"
- },
- "uptime" : {
- "description" : "Uptime.",
- "optional" : 1,
- "renderer" : "duration",
- "type" : "integer"
- },
- "vmid" : {
- "description" : "The (unique) ID of the VM.",
- "format" : "pve-vmid",
- "minimum" : 1,
- "type" : "integer"
- }
- },
- "type" : "object"
- },
- "links" : [
- {
- "href" : "{vmid}",
- "rel" : "child"
- }
- ],
- "type" : "array"
- }
- },
- "POST" : {
- "allowtoken" : 1,
- "description" : "Create or restore a virtual machine.",
- "method" : "POST",
- "name" : "create_vm",
- "parameters" : {
- "additionalProperties" : 0,
- "properties" : {
- "acpi" : {
- "default" : 1,
- "description" : "Enable/disable ACPI.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "affinity" : {
- "description" : "List of host cores used to execute guest processes, for example: 0,5,8-11",
- "format" : "pve-cpuset",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "agent" : {
- "description" : "Enable/disable communication with the QEMU Guest Agent and its properties.",
- "format" : {
- "enabled" : {
- "default" : 0,
- "default_key" : 1,
- "description" : "Enable/disable communication with a QEMU Guest Agent (QGA) running in the VM.",
- "type" : "boolean"
- },
- "freeze-fs-on-backup" : {
- "default" : 1,
- "description" : "Freeze/thaw guest filesystems on backup for consistency.",
- "optional" : 1,
- "type" : "boolean"
- },
- "fstrim_cloned_disks" : {
- "default" : 0,
- "description" : "Run fstrim after moving a disk or migrating the VM.",
- "optional" : 1,
- "type" : "boolean"
- },
- "type" : {
- "default" : "virtio",
- "description" : "Select the agent type",
- "enum" : [
- "virtio",
- "isa"
- ],
- "optional" : 1,
- "type" : "string"
- }
- },
- "optional" : 1,
- "type" : "string",
- "typetext" : "[enabled=]<1|0> [,freeze-fs-on-backup=<1|0>] [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]"
- },
- "arch" : {
- "description" : "Virtual processor architecture. Defaults to the host.",
- "enum" : [
- "x86_64",
- "aarch64"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "archive" : {
- "description" : "The backup archive. Either the file system path to a .tar or .vma file (use '-' to pipe data from stdin) or a proxmox storage backup volume identifier.",
- "maxLength" : 255,
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "args" : {
- "description" : "Arbitrary arguments passed to kvm.",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>",
- "verbose_description" : "Arbitrary arguments passed to kvm, for example:\n\nargs: -no-reboot -no-hpet\n\nNOTE: this option is for experts only.\n"
- },
- "audio0" : {
- "description" : "Configure a audio device, useful in combination with QXL/Spice.",
- "format" : {
- "device" : {
- "description" : "Configure an audio device.",
- "enum" : [
- "ich9-intel-hda",
- "intel-hda",
- "AC97"
- ],
- "type" : "string"
- },
- "driver" : {
- "default" : "spice",
- "description" : "Driver backend for the audio device.",
- "enum" : [
- "spice",
- "none"
- ],
- "optional" : 1,
- "type" : "string"
- }
- },
- "optional" : 1,
- "type" : "string",
- "typetext" : "device=<ich9-intel-hda|intel-hda|AC97> [,driver=<spice|none>]"
- },
- "autostart" : {
- "default" : 0,
- "description" : "Automatic restart after crash (currently ignored).",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "balloon" : {
- "description" : "Amount of target RAM for the VM in MiB. Using zero disables the ballon driver.",
- "minimum" : 0,
- "optional" : 1,
- "type" : "integer",
- "typetext" : "<integer> (0 - N)"
- },
- "bios" : {
- "default" : "seabios",
- "description" : "Select BIOS implementation.",
- "enum" : [
- "seabios",
- "ovmf"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "boot" : {
- "description" : "Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated.",
- "format" : "pve-qm-boot",
- "optional" : 1,
- "type" : "string",
- "typetext" : "[[legacy=]<[acdn]{1,4}>] [,order=<device[;device...]>]"
- },
- "bootdisk" : {
- "description" : "Enable booting from specified disk. Deprecated: Use 'boot: order=foo;bar' instead.",
- "format" : "pve-qm-bootdisk",
- "optional" : 1,
- "pattern" : "(ide|sata|scsi|virtio)\\d+",
- "type" : "string"
- },
- "bwlimit" : {
- "default" : "restore limit from datacenter or storage config",
- "description" : "Override I/O bandwidth limit (in KiB/s).",
- "minimum" : "0",
- "optional" : 1,
- "type" : "integer",
- "typetext" : "<integer> (0 - N)"
- },
- "cdrom" : {
- "description" : "This is an alias for option -ide2",
- "format" : "pve-qm-ide",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<volume>"
- },
- "cicustom" : {
- "description" : "cloud-init: Specify custom files to replace the automatically generated ones at start.",
- "format" : "pve-qm-cicustom",
- "optional" : 1,
- "type" : "string",
- "typetext" : "[meta=<volume>] [,network=<volume>] [,user=<volume>] [,vendor=<volume>]"
- },
- "cipassword" : {
- "description" : "cloud-init: Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords.",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "citype" : {
- "description" : "Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows.",
- "enum" : [
- "configdrive2",
- "nocloud",
- "opennebula"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "ciuser" : {
- "description" : "cloud-init: User name to change ssh keys and password for instead of the image's configured default user.",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "cores" : {
- "default" : 1,
- "description" : "The number of cores per socket.",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - N)"
- },
- "cpu" : {
- "description" : "Emulated CPU type.",
- "format" : "pve-vm-cpu-conf",
- "optional" : 1,
- "type" : "string",
- "typetext" : "[[cputype=]<string>] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>] [,phys-bits=<8-64|host>] [,reported-model=<enum>]"
- },
- "cpulimit" : {
- "default" : 0,
- "description" : "Limit of CPU usage.",
- "maximum" : 128,
- "minimum" : 0,
- "optional" : 1,
- "type" : "number",
- "typetext" : "<number> (0 - 128)",
- "verbose_description" : "Limit of CPU usage.\n\nNOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit."
- },
- "cpuunits" : {
- "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" : 1,
- "optional" : 1,
- "type" : "integer",
- "typetext" : "<integer> (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" : {
- "description" : "Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file.",
- "maxLength" : 8192,
- "optional" : 1,
- "type" : "string",
- "typetext" : "<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. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume.",
- "format" : {
- "efitype" : {
- "default" : "2m",
- "description" : "Size and type of the OVMF EFI vars. '4m' is newer and recommended, and required for Secure Boot. For backwards compatibility, '2m' is used if not otherwise specified. Ignored for VMs with arch=aarc64 (ARM).",
- "enum" : [
- "2m",
- "4m"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "file" : {
- "default_key" : 1,
- "description" : "The drive's backing volume.",
- "format" : "pve-volume-id-or-qm-path",
- "format_description" : "volume",
- "type" : "string"
- },
- "format" : {
- "description" : "The drive's backing file's data format.",
- "enum" : [
- "raw",
- "cow",
- "qcow",
- "qed",
- "qcow2",
- "vmdk",
- "cloop"
- ],
- "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.",
- "optional" : 1,
- "type" : "boolean"
- },
- "size" : {
- "description" : "Disk size. This is purely informational and has no effect.",
- "format" : "disk-size",
- "format_description" : "DiskSize",
- "optional" : 1,
- "type" : "string"
- },
- "volume" : {
- "alias" : "file"
- }
- },
- "optional" : 1,
- "type" : "string",
- "typetext" : "[file=]<volume> [,efitype=<2m|4m>] [,format=<enum>] [,import-from=<source volume>] [,pre-enrolled-keys=<1|0>] [,size=<DiskSize>]"
- },
- "force" : {
- "description" : "Allow to overwrite existing VM.",
- "optional" : 1,
- "requires" : "archive",
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "freeze" : {
- "description" : "Freeze CPU at startup (use 'c' monitor command to start execution).",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "hookscript" : {
- "description" : "Script that will be executed during various steps in the vms lifetime.",
- "format" : "pve-volume-id",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "hostpci[n]" : {
- "description" : "Map host PCI devices into guest.",
- "format" : "pve-qm-hostpci",
- "optional" : 1,
- "type" : "string",
- "typetext" : "[host=]<HOSTPCIID[;HOSTPCIID2...]> [,device-id=<hex id>] [,legacy-igd=<1|0>] [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,sub-device-id=<hex id>] [,sub-vendor-id=<hex id>] [,vendor-id=<hex 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" : {
- "default" : "network,disk,usb",
- "description" : "Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory', 'usb' and 'cloudinit'. Use '0' to disable hotplug completely. Using '1' as value is an alias for the default `network,disk,usb`. USB hotplugging is possible for guests with machine version >= 7.1 and ostype l26 or windows > 7.",
- "format" : "pve-hotplug-features",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "hugepages" : {
- "description" : "Enable/disable hugepages memory.",
- "enum" : [
- "any",
- "2",
- "1024"
- ],
- "optional" : 1,
- "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. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume.",
- "format" : {
- "aio" : {
- "description" : "AIO type to use.",
- "enum" : [
- "native",
- "threads",
- "io_uring"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "backup" : {
- "description" : "Whether the drive should be included when making backups.",
- "optional" : 1,
- "type" : "boolean"
- },
- "bps" : {
- "description" : "Maximum r/w speed in bytes per second.",
- "format_description" : "bps",
- "optional" : 1,
- "type" : "integer"
- },
- "bps_max_length" : {
- "description" : "Maximum length of I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "bps_rd" : {
- "description" : "Maximum read speed in bytes per second.",
- "format_description" : "bps",
- "optional" : 1,
- "type" : "integer"
- },
- "bps_rd_length" : {
- "alias" : "bps_rd_max_length"
- },
- "bps_rd_max_length" : {
- "description" : "Maximum length of read I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "bps_wr" : {
- "description" : "Maximum write speed in bytes per second.",
- "format_description" : "bps",
- "optional" : 1,
- "type" : "integer"
- },
- "bps_wr_length" : {
- "alias" : "bps_wr_max_length"
- },
- "bps_wr_max_length" : {
- "description" : "Maximum length of write I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "cache" : {
- "description" : "The drive's cache mode",
- "enum" : [
- "none",
- "writethrough",
- "writeback",
- "unsafe",
- "directsync"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "cyls" : {
- "description" : "Force the drive's physical geometry to have a specific cylinder count.",
- "optional" : 1,
- "type" : "integer"
- },
- "detect_zeroes" : {
- "description" : "Controls whether to detect and try to optimize writes of zeroes.",
- "optional" : 1,
- "type" : "boolean"
- },
- "discard" : {
- "description" : "Controls whether to pass discard/trim requests to the underlying storage.",
- "enum" : [
- "ignore",
- "on"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "file" : {
- "default_key" : 1,
- "description" : "The drive's backing volume.",
- "format" : "pve-volume-id-or-qm-path",
- "format_description" : "volume",
- "type" : "string"
- },
- "format" : {
- "description" : "The drive's backing file's data format.",
- "enum" : [
- "raw",
- "cow",
- "qcow",
- "qed",
- "qcow2",
- "vmdk",
- "cloop"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "heads" : {
- "description" : "Force the drive's physical geometry to have a specific head count.",
- "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",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_max" : {
- "description" : "Maximum unthrottled r/w I/O pool in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_max_length" : {
- "description" : "Maximum length of I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "iops_rd" : {
- "description" : "Maximum read I/O in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_rd_length" : {
- "alias" : "iops_rd_max_length"
- },
- "iops_rd_max" : {
- "description" : "Maximum unthrottled read I/O pool in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_rd_max_length" : {
- "description" : "Maximum length of read I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "iops_wr" : {
- "description" : "Maximum write I/O in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_wr_length" : {
- "alias" : "iops_wr_max_length"
- },
- "iops_wr_max" : {
- "description" : "Maximum unthrottled write I/O pool in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_wr_max_length" : {
- "description" : "Maximum length of write I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "mbps" : {
- "description" : "Maximum r/w speed in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_max" : {
- "description" : "Maximum unthrottled r/w pool in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_rd" : {
- "description" : "Maximum read speed in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_rd_max" : {
- "description" : "Maximum unthrottled read pool in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_wr" : {
- "description" : "Maximum write speed in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_wr_max" : {
- "description" : "Maximum unthrottled write pool in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "media" : {
- "default" : "disk",
- "description" : "The drive's media type.",
- "enum" : [
- "cdrom",
- "disk"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "model" : {
- "description" : "The drive's reported model name, url-encoded, up to 40 bytes long.",
- "format" : "urlencoded",
- "format_description" : "model",
- "maxLength" : 120,
- "optional" : 1,
- "type" : "string"
- },
- "replicate" : {
- "default" : 1,
- "description" : "Whether the drive should considered for replication jobs.",
- "optional" : 1,
- "type" : "boolean"
- },
- "rerror" : {
- "description" : "Read error action.",
- "enum" : [
- "ignore",
- "report",
- "stop"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "secs" : {
- "description" : "Force the drive's physical geometry to have a specific sector count.",
- "optional" : 1,
- "type" : "integer"
- },
- "serial" : {
- "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long.",
- "format" : "urlencoded",
- "format_description" : "serial",
- "maxLength" : 60,
- "optional" : 1,
- "type" : "string"
- },
- "shared" : {
- "default" : 0,
- "description" : "Mark this locally-managed volume as available on all nodes",
- "optional" : 1,
- "type" : "boolean",
- "verbose_description" : "Mark this locally-managed volume as available on all nodes.\n\nWARNING: This option does not share the volume automatically, it assumes it is shared already!"
- },
- "size" : {
- "description" : "Disk size. This is purely informational and has no effect.",
- "format" : "disk-size",
- "format_description" : "DiskSize",
- "optional" : 1,
- "type" : "string"
- },
- "snapshot" : {
- "description" : "Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.",
- "optional" : 1,
- "type" : "boolean"
- },
- "ssd" : {
- "description" : "Whether to expose this drive as an SSD, rather than a rotational hard disk.",
- "optional" : 1,
- "type" : "boolean"
- },
- "trans" : {
- "description" : "Force disk geometry bios translation mode.",
- "enum" : [
- "none",
- "lba",
- "auto"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "volume" : {
- "alias" : "file"
- },
- "werror" : {
- "description" : "Write error action.",
- "enum" : [
- "enospc",
- "ignore",
- "report",
- "stop"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "wwn" : {
- "description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.",
- "format_description" : "wwn",
- "optional" : 1,
- "pattern" : "(?^:^(0x)[0-9a-fA-F]{16})",
- "type" : "string"
- }
- },
- "optional" : 1,
- "type" : "string",
- "typetext" : "[file=]<volume> [,aio=<native|threads|io_uring>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,import-from=<source volume>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]"
- },
- "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",
- "format" : "pve-qm-ipconfig",
- "optional" : 1,
- "type" : "string",
- "typetext" : "[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]"
- },
- "ivshmem" : {
- "description" : "Inter-VM shared memory. Useful for direct communication between VMs, or to the host.",
- "format" : {
- "name" : {
- "description" : "The name of the file. Will be prefixed with 'pve-shm-'. Default is the VMID. Will be deleted when the VM is stopped.",
- "format_description" : "string",
- "optional" : 1,
- "pattern" : "[a-zA-Z0-9\\-]+",
- "type" : "string"
- },
- "size" : {
- "description" : "The size of the file in MB.",
- "minimum" : 1,
- "type" : "integer"
- }
- },
- "optional" : 1,
- "type" : "string",
- "typetext" : "size=<integer> [,name=<string>]"
- },
- "keephugepages" : {
- "default" : 0,
- "description" : "Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "keyboard" : {
- "default" : null,
- "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",
- "da",
- "en-gb",
- "en-us",
- "es",
- "fi",
- "fr",
- "fr-be",
- "fr-ca",
- "fr-ch",
- "hu",
- "is",
- "it",
- "ja",
- "lt",
- "mk",
- "nl",
- "no",
- "pl",
- "pt",
- "pt-br",
- "sv",
- "sl",
- "tr"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "kvm" : {
- "default" : 1,
- "description" : "Enable/disable KVM hardware virtualization.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "live-restore" : {
- "description" : "Start the VM immediately from the backup and restore in background. PBS only.",
- "optional" : 1,
- "requires" : "archive",
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "localtime" : {
- "description" : "Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "lock" : {
- "description" : "Lock/unlock the VM.",
- "enum" : [
- "backup",
- "clone",
- "create",
- "migrate",
- "rollback",
- "snapshot",
- "snapshot-delete",
- "suspending",
- "suspended"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "machine" : {
- "description" : "Specifies the QEMU machine type.",
- "maxLength" : 40,
- "optional" : 1,
- "pattern" : "(pc|pc(-i440fx)?-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|q35|pc-q35-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|virt(?:-\\d+(\\.\\d+)+)?(\\+pve\\d+)?)",
- "type" : "string"
- },
- "memory" : {
- "default" : 512,
- "description" : "Amount of RAM for the VM in MiB. This is the maximum available memory when you use the balloon device.",
- "minimum" : 16,
- "optional" : 1,
- "type" : "integer",
- "typetext" : "<integer> (16 - N)"
- },
- "migrate_downtime" : {
- "default" : 0.1,
- "description" : "Set maximum tolerated downtime (in seconds) for migrations.",
- "minimum" : 0,
- "optional" : 1,
- "type" : "number",
- "typetext" : "<number> (0 - N)"
- },
- "migrate_speed" : {
- "default" : 0,
- "description" : "Set maximum speed (in MB/s) for migrations. Value 0 is no limit.",
- "minimum" : 0,
- "optional" : 1,
- "type" : "integer",
- "typetext" : "<integer> (0 - N)"
- },
- "name" : {
- "description" : "Set a name for the VM. Only used on the configuration web interface.",
- "format" : "dns-name",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "nameserver" : {
- "description" : "cloud-init: Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.",
- "format" : "address-list",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "net[n]" : {
- "description" : "Specify network devices.",
- "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,
- "type" : "string"
- },
- "e1000" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "e1000-82540em" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "e1000-82544gc" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "e1000-82545em" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "e1000e" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "firewall" : {
- "description" : "Whether this interface should be protected by the firewall.",
- "optional" : 1,
- "type" : "boolean"
- },
- "i82551" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "i82557b" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "i82559er" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "link_down" : {
- "description" : "Whether this interface should be disconnected (like pulling the plug).",
- "optional" : 1,
- "type" : "boolean"
- },
- "macaddr" : {
- "description" : "MAC address. That address must be unique withing your network. This is automatically generated if not specified.",
- "format" : "mac-addr",
- "format_description" : "XX:XX:XX:XX:XX:XX",
- "optional" : 1,
- "type" : "string",
- "verbose_description" : "A common MAC address with the I/G (Individual/Group) bit not set."
- },
- "model" : {
- "default_key" : 1,
- "description" : "Network Card Model. The 'virtio' model provides the best performance with very low CPU overhead. If your guest does not support this driver, it is usually best to use 'e1000'.",
- "enum" : [
- "e1000",
- "e1000-82540em",
- "e1000-82544gc",
- "e1000-82545em",
- "e1000e",
- "i82551",
- "i82557b",
- "i82559er",
- "ne2k_isa",
- "ne2k_pci",
- "pcnet",
- "rtl8139",
- "virtio",
- "vmxnet3"
- ],
- "type" : "string"
- },
- "mtu" : {
- "description" : "Force MTU, for VirtIO only. Set to '1' to use the bridge MTU",
- "maximum" : 65520,
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "ne2k_isa" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "ne2k_pci" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "pcnet" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "queues" : {
- "description" : "Number of packet queues to be used on the device.",
- "maximum" : 64,
- "minimum" : 0,
- "optional" : 1,
- "type" : "integer"
- },
- "rate" : {
- "description" : "Rate limit in mbps (megabytes per second) as floating point number.",
- "minimum" : 0,
- "optional" : 1,
- "type" : "number"
- },
- "rtl8139" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "tag" : {
- "description" : "VLAN tag to apply to packets on this interface.",
- "maximum" : 4094,
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "trunks" : {
- "description" : "VLAN trunks to pass through this interface.",
- "format_description" : "vlanid[;vlanid...]",
- "optional" : 1,
- "pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)",
- "type" : "string"
- },
- "virtio" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- },
- "vmxnet3" : {
- "alias" : "macaddr",
- "keyAlias" : "model"
- }
- },
- "optional" : 1,
- "type" : "string",
- "typetext" : "[model=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,mtu=<integer>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]"
- },
- "node" : {
- "description" : "The cluster node name.",
- "format" : "pve-node",
- "type" : "string",
- "typetext" : "<string>"
- },
- "numa" : {
- "default" : 0,
- "description" : "Enable/disable NUMA.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "numa[n]" : {
- "description" : "NUMA topology.",
- "format" : {
- "cpus" : {
- "description" : "CPUs accessing this NUMA node.",
- "format_description" : "id[-id];...",
- "pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)",
- "type" : "string"
- },
- "hostnodes" : {
- "description" : "Host NUMA nodes to use.",
- "format_description" : "id[-id];...",
- "optional" : 1,
- "pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)",
- "type" : "string"
- },
- "memory" : {
- "description" : "Amount of memory this NUMA node provides.",
- "optional" : 1,
- "type" : "number"
- },
- "policy" : {
- "description" : "NUMA allocation policy.",
- "enum" : [
- "preferred",
- "bind",
- "interleave"
- ],
- "optional" : 1,
- "type" : "string"
- }
- },
- "optional" : 1,
- "type" : "string",
- "typetext" : "cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]"
- },
- "onboot" : {
- "default" : 0,
- "description" : "Specifies whether a VM will be started during system bootup.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "ostype" : {
- "description" : "Specify guest operating system.",
- "enum" : [
- "other",
- "wxp",
- "w2k",
- "w2k3",
- "w2k8",
- "wvista",
- "win7",
- "win8",
- "win10",
- "win11",
- "l24",
- "l26",
- "solaris"
- ],
- "optional" : 1,
- "type" : "string",
- "verbose_description" : "Specify guest operating system. This is used to enable special\noptimization/features for specific operating systems:\n\n[horizontal]\nother;; unspecified OS\nwxp;; Microsoft Windows XP\nw2k;; Microsoft Windows 2000\nw2k3;; Microsoft Windows 2003\nw2k8;; Microsoft Windows 2008\nwvista;; Microsoft Windows Vista\nwin7;; Microsoft Windows 7\nwin8;; Microsoft Windows 8/2012/2012r2\nwin10;; Microsoft Windows 10/2016/2019\nwin11;; Microsoft Windows 11/2022\nl24;; Linux 2.4 Kernel\nl26;; Linux 2.6 - 6.X Kernel\nsolaris;; Solaris/OpenSolaris/OpenIndiania kernel\n"
- },
- "parallel[n]" : {
- "description" : "Map host parallel devices (n is 0 to 2).",
- "optional" : 1,
- "pattern" : "/dev/parport\\d+|/dev/usb/lp\\d+",
- "type" : "string",
- "verbose_description" : "Map host parallel devices (n is 0 to 2).\n\nNOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such\nmachines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n"
- },
- "pool" : {
- "description" : "Add the VM to the specified pool.",
- "format" : "pve-poolid",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "protection" : {
- "default" : 0,
- "description" : "Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "reboot" : {
- "default" : 1,
- "description" : "Allow reboot. If set to '0' the VM exit on reboot.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "rng0" : {
- "description" : "Configure a VirtIO-based Random Number Generator.",
- "format" : {
- "max_bytes" : {
- "default" : 1024,
- "description" : "Maximum bytes of entropy allowed to get injected into the guest every 'period' milliseconds. Prefer a lower value when using '/dev/random' as source. Use `0` to disable limiting (potentially dangerous!).",
- "optional" : 1,
- "type" : "integer"
- },
- "period" : {
- "default" : 1000,
- "description" : "Every 'period' milliseconds the entropy-injection quota is reset, allowing the guest to retrieve another 'max_bytes' of entropy.",
- "optional" : 1,
- "type" : "integer"
- },
- "source" : {
- "default_key" : 1,
- "description" : "The file on the host to gather entropy from. In most cases '/dev/urandom' should be preferred over '/dev/random' to avoid entropy-starvation issues on the host. Using urandom does *not* decrease security in any meaningful way, as it's still seeded from real entropy, and the bytes provided will most likely be mixed with real entropy on the guest as well. '/dev/hwrng' can be used to pass through a hardware RNG from the host.",
- "enum" : [
- "/dev/urandom",
- "/dev/random",
- "/dev/hwrng"
- ],
- "type" : "string"
- }
- },
- "optional" : 1,
- "type" : "string",
- "typetext" : "[source=]</dev/urandom|/dev/random|/dev/hwrng> [,max_bytes=<integer>] [,period=<integer>]"
- },
- "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. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume.",
- "format" : {
- "aio" : {
- "description" : "AIO type to use.",
- "enum" : [
- "native",
- "threads",
- "io_uring"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "backup" : {
- "description" : "Whether the drive should be included when making backups.",
- "optional" : 1,
- "type" : "boolean"
- },
- "bps" : {
- "description" : "Maximum r/w speed in bytes per second.",
- "format_description" : "bps",
- "optional" : 1,
- "type" : "integer"
- },
- "bps_max_length" : {
- "description" : "Maximum length of I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "bps_rd" : {
- "description" : "Maximum read speed in bytes per second.",
- "format_description" : "bps",
- "optional" : 1,
- "type" : "integer"
- },
- "bps_rd_length" : {
- "alias" : "bps_rd_max_length"
- },
- "bps_rd_max_length" : {
- "description" : "Maximum length of read I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "bps_wr" : {
- "description" : "Maximum write speed in bytes per second.",
- "format_description" : "bps",
- "optional" : 1,
- "type" : "integer"
- },
- "bps_wr_length" : {
- "alias" : "bps_wr_max_length"
- },
- "bps_wr_max_length" : {
- "description" : "Maximum length of write I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "cache" : {
- "description" : "The drive's cache mode",
- "enum" : [
- "none",
- "writethrough",
- "writeback",
- "unsafe",
- "directsync"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "cyls" : {
- "description" : "Force the drive's physical geometry to have a specific cylinder count.",
- "optional" : 1,
- "type" : "integer"
- },
- "detect_zeroes" : {
- "description" : "Controls whether to detect and try to optimize writes of zeroes.",
- "optional" : 1,
- "type" : "boolean"
- },
- "discard" : {
- "description" : "Controls whether to pass discard/trim requests to the underlying storage.",
- "enum" : [
- "ignore",
- "on"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "file" : {
- "default_key" : 1,
- "description" : "The drive's backing volume.",
- "format" : "pve-volume-id-or-qm-path",
- "format_description" : "volume",
- "type" : "string"
- },
- "format" : {
- "description" : "The drive's backing file's data format.",
- "enum" : [
- "raw",
- "cow",
- "qcow",
- "qed",
- "qcow2",
- "vmdk",
- "cloop"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "heads" : {
- "description" : "Force the drive's physical geometry to have a specific head count.",
- "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",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_max" : {
- "description" : "Maximum unthrottled r/w I/O pool in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_max_length" : {
- "description" : "Maximum length of I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "iops_rd" : {
- "description" : "Maximum read I/O in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_rd_length" : {
- "alias" : "iops_rd_max_length"
- },
- "iops_rd_max" : {
- "description" : "Maximum unthrottled read I/O pool in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_rd_max_length" : {
- "description" : "Maximum length of read I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "iops_wr" : {
- "description" : "Maximum write I/O in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_wr_length" : {
- "alias" : "iops_wr_max_length"
- },
- "iops_wr_max" : {
- "description" : "Maximum unthrottled write I/O pool in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_wr_max_length" : {
- "description" : "Maximum length of write I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "mbps" : {
- "description" : "Maximum r/w speed in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_max" : {
- "description" : "Maximum unthrottled r/w pool in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_rd" : {
- "description" : "Maximum read speed in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_rd_max" : {
- "description" : "Maximum unthrottled read pool in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_wr" : {
- "description" : "Maximum write speed in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_wr_max" : {
- "description" : "Maximum unthrottled write pool in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "media" : {
- "default" : "disk",
- "description" : "The drive's media type.",
- "enum" : [
- "cdrom",
- "disk"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "replicate" : {
- "default" : 1,
- "description" : "Whether the drive should considered for replication jobs.",
- "optional" : 1,
- "type" : "boolean"
- },
- "rerror" : {
- "description" : "Read error action.",
- "enum" : [
- "ignore",
- "report",
- "stop"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "secs" : {
- "description" : "Force the drive's physical geometry to have a specific sector count.",
- "optional" : 1,
- "type" : "integer"
- },
- "serial" : {
- "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long.",
- "format" : "urlencoded",
- "format_description" : "serial",
- "maxLength" : 60,
- "optional" : 1,
- "type" : "string"
- },
- "shared" : {
- "default" : 0,
- "description" : "Mark this locally-managed volume as available on all nodes",
- "optional" : 1,
- "type" : "boolean",
- "verbose_description" : "Mark this locally-managed volume as available on all nodes.\n\nWARNING: This option does not share the volume automatically, it assumes it is shared already!"
- },
- "size" : {
- "description" : "Disk size. This is purely informational and has no effect.",
- "format" : "disk-size",
- "format_description" : "DiskSize",
- "optional" : 1,
- "type" : "string"
- },
- "snapshot" : {
- "description" : "Controls qemu's snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.",
- "optional" : 1,
- "type" : "boolean"
- },
- "ssd" : {
- "description" : "Whether to expose this drive as an SSD, rather than a rotational hard disk.",
- "optional" : 1,
- "type" : "boolean"
- },
- "trans" : {
- "description" : "Force disk geometry bios translation mode.",
- "enum" : [
- "none",
- "lba",
- "auto"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "volume" : {
- "alias" : "file"
- },
- "werror" : {
- "description" : "Write error action.",
- "enum" : [
- "enospc",
- "ignore",
- "report",
- "stop"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "wwn" : {
- "description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.",
- "format_description" : "wwn",
- "optional" : 1,
- "pattern" : "(?^:^(0x)[0-9a-fA-F]{16})",
- "type" : "string"
- }
- },
- "optional" : 1,
- "type" : "string",
- "typetext" : "[file=]<volume> [,aio=<native|threads|io_uring>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,import-from=<source volume>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]"
- },
- "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. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume.",
- "format" : {
- "aio" : {
- "description" : "AIO type to use.",
- "enum" : [
- "native",
- "threads",
- "io_uring"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "backup" : {
- "description" : "Whether the drive should be included when making backups.",
- "optional" : 1,
- "type" : "boolean"
- },
- "bps" : {
- "description" : "Maximum r/w speed in bytes per second.",
- "format_description" : "bps",
- "optional" : 1,
- "type" : "integer"
- },
- "bps_max_length" : {
- "description" : "Maximum length of I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "bps_rd" : {
- "description" : "Maximum read speed in bytes per second.",
- "format_description" : "bps",
- "optional" : 1,
- "type" : "integer"
- },
- "bps_rd_length" : {
- "alias" : "bps_rd_max_length"
- },
- "bps_rd_max_length" : {
- "description" : "Maximum length of read I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "bps_wr" : {
- "description" : "Maximum write speed in bytes per second.",
- "format_description" : "bps",
- "optional" : 1,
- "type" : "integer"
- },
- "bps_wr_length" : {
- "alias" : "bps_wr_max_length"
- },
- "bps_wr_max_length" : {
- "description" : "Maximum length of write I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "cache" : {
- "description" : "The drive's cache mode",
- "enum" : [
- "none",
- "writethrough",
- "writeback",
- "unsafe",
- "directsync"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "cyls" : {
- "description" : "Force the drive's physical geometry to have a specific cylinder count.",
- "optional" : 1,
- "type" : "integer"
- },
- "detect_zeroes" : {
- "description" : "Controls whether to detect and try to optimize writes of zeroes.",
- "optional" : 1,
- "type" : "boolean"
- },
- "discard" : {
- "description" : "Controls whether to pass discard/trim requests to the underlying storage.",
- "enum" : [
- "ignore",
- "on"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "file" : {
- "default_key" : 1,
- "description" : "The drive's backing volume.",
- "format" : "pve-volume-id-or-qm-path",
- "format_description" : "volume",
- "type" : "string"
- },
- "format" : {
- "description" : "The drive's backing file's data format.",
- "enum" : [
- "raw",
- "cow",
- "qcow",
- "qed",
- "qcow2",
- "vmdk",
- "cloop"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "heads" : {
- "description" : "Force the drive's physical geometry to have a specific head count.",
- "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",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_max" : {
- "description" : "Maximum unthrottled r/w I/O pool in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_max_length" : {
- "description" : "Maximum length of I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "iops_rd" : {
- "description" : "Maximum read I/O in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_rd_length" : {
- "alias" : "iops_rd_max_length"
- },
- "iops_rd_max" : {
- "description" : "Maximum unthrottled read I/O pool in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_rd_max_length" : {
- "description" : "Maximum length of read I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "iops_wr" : {
- "description" : "Maximum write I/O in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_wr_length" : {
- "alias" : "iops_wr_max_length"
- },
- "iops_wr_max" : {
- "description" : "Maximum unthrottled write I/O pool in operations per second.",
- "format_description" : "iops",
- "optional" : 1,
- "type" : "integer"
- },
- "iops_wr_max_length" : {
- "description" : "Maximum length of write I/O bursts in seconds.",
- "format_description" : "seconds",
- "minimum" : 1,
- "optional" : 1,
- "type" : "integer"
- },
- "iothread" : {
- "description" : "Whether to use iothreads for this drive",
- "optional" : 1,
- "type" : "boolean"
- },
- "mbps" : {
- "description" : "Maximum r/w speed in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_max" : {
- "description" : "Maximum unthrottled r/w pool in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_rd" : {
- "description" : "Maximum read speed in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_rd_max" : {
- "description" : "Maximum unthrottled read pool in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_wr" : {
- "description" : "Maximum write speed in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "mbps_wr_max" : {
- "description" : "Maximum unthrottled write pool in megabytes per second.",
- "format_description" : "mbps",
- "optional" : 1,
- "type" : "number"
- },
- "media" : {
- "default" : "disk",
- "description" : "The drive's media type.",
- "enum" : [
- "cdrom",
- "disk"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "queues" : {
- "description" : "Number of queues.",
- "minimum" : 2,
- "optional" : 1,
- "type" : "integer"
- },
- "replicate" : {
- "default" : 1,
- "description" : "Whether the drive should considered for replication jobs.",