proxmox-mirrors/pve-docs
1
0
Fork 0
mirror of https://git.proxmox.com/git/pve-docs synced 2025-06-14 16:45:20 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

update auto-generated docs

Browse Source
This commit is contained in:
Dietmar Maurer 2016-05-19 16:14:05 +02:00
parent 37638f5933
commit c2993fe56c
16 changed files with 1115 additions and 799 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

280
api-viewer/apidata.js
View File

@ -5059,9 +5059,10 @@ var pveapi = [
"type" : "boolean" "type" : "boolean"
}, },
"args" : { "args" : {
"description" : "Arbitrary arguments passed to kvm, for example:\n\nargs: -no-reboot -no-hpet\n\nNOTE: this option is for experts only.\n", "description" : "Arbitrary arguments passed to kvm.",
"optional" : 1, "optional" : 1,
"type" : "string" "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"
}, },
"autostart" : { "autostart" : {
"default" : 0, "default" : 0,
@ -5172,19 +5173,21 @@ var pveapi = [
}, },
"cpulimit" : { "cpulimit" : {
"default" : 0, "default" : 0,
"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.", "description" : "Limit of CPU usage.",
"maximum" : 128, "maximum" : 128,
"minimum" : 0, "minimum" : 0,
"optional" : 1, "optional" : 1,
"type" : "number" "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" : { "cpuunits" : {
"default" : 1000, "default" : 1000,
"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.\n\nNOTE: You can disable fair-scheduler configuration by setting this to 0.", "description" : "CPU weight for a VM.",
"maximum" : 500000, "maximum" : 500000,
"minimum" : 0, "minimum" : 0,
"optional" : 1, "optional" : 1,
"type" : "integer" "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.\n\nNOTE: You can disable fair-scheduler configuration by setting this to 0."
}, },
"delete" : { "delete" : {
"description" : "A list of settings you want to delete.", "description" : "A list of settings you want to delete.",
@ -5215,7 +5218,7 @@ var pveapi = [
"type" : "boolean" "type" : "boolean"
}, },
"hostpci[n]" : { "hostpci[n]" : {
"description" : "Map host pci devices. HOSTPCIDEVICE syntax is:\n\n'bus:dev.func' (hexadecimal numbers)\n\nYou can us the 'lspci' command to list existing pci devices.\n\nThe 'rombar' option determines whether or not the device's ROM will be visible in the guest's memory map (default is 'on').\n\nNOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.\n\nExperimental: user reported problems with this option.\n", "description" : "Map host PCI devices into guest.",
"format" : "pve-qm-hostpci", "format" : "pve-qm-hostpci",
"optional" : 1, "optional" : 1,
"type" : "string" "type" : "string"
@ -5475,7 +5478,7 @@ var pveapi = [
}, },
"keyboard" : { "keyboard" : {
"default" : "en-us", "default" : "en-us",
"description" : "Keybord layout for vnc server. Default is read from the datacenter configuration file.", "description" : "Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.",
"enum" : [ "enum" : [
"de", "de",
"de-ch", "de-ch",
@ -5563,10 +5566,10 @@ var pveapi = [
"type" : "string" "type" : "string"
}, },
"net[n]" : { "net[n]" : {
"description" : "Specify network devices.\n\nMODEL is one of: e1000 e1000-82540em e1000-82544gc e1000-82545em i82551 i82557b i82559er ne2k_isa ne2k_pci pcnet rtl8139 virtio vmxnet3\n\nXX:XX:XX:XX:XX:XX should be an unique MAC address. This is\nautomatically generated if not specified.\n\nThe bridge parameter can be used to automatically add the interface to a bridge device. The Proxmox VE standard bridge is called 'vmbr0'.\n\nOption 'rate' is used to limit traffic bandwidth from and to this interface. It is specified as floating point number, unit is 'Megabytes per second'.\n\nIf you specify no bridge, we create a kvm 'user' (NATed) network device, which provides DHCP and DNS services. The following addresses are used:\n\n10.0.2.2 Gateway\n10.0.2.3 DNS Server\n10.0.2.4 SMB Server\n\nThe DHCP server assign addresses to the guest starting from 10.0.2.15.\n\n", "description" : "Specify network devices.",
"format" : { "format" : {
"bridge" : { "bridge" : {
"description" : "Bridge to attach the network device to.", "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_description" : "bridge", "format_description" : "bridge",
"optional" : 1, "optional" : 1,
"type" : "string" "type" : "string"
@ -5605,12 +5608,12 @@ var pveapi = [
"keyAlias" : "model" "keyAlias" : "model"
}, },
"link_down" : { "link_down" : {
"description" : "Whether this interface should be DISconnected (like pulling the plug).", "description" : "Whether this interface should be disconnected (like pulling the plug).",
"optional" : 1, "optional" : 1,
"type" : "boolean" "type" : "boolean"
}, },
"macaddr" : { "macaddr" : {
"description" : "MAC address", "description" : "MAC address. That address must be unique withing your network. This is automatically generated if not specified.",
"format_description" : "XX:XX:XX:XX:XX:XX", "format_description" : "XX:XX:XX:XX:XX:XX",
"optional" : 1, "optional" : 1,
"pattern" : "(?^i:[0-9a-f]{2}(?::[0-9a-f]{2}){5})", "pattern" : "(?^i:[0-9a-f]{2}(?::[0-9a-f]{2}){5})",
@ -5618,7 +5621,7 @@ var pveapi = [
}, },
"model" : { "model" : {
"default_key" : 1, "default_key" : 1,
"description" : "Network Card Model.", "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" : [ "enum" : [
"rtl8139", "rtl8139",
"ne2k_pci", "ne2k_pci",
@ -5657,7 +5660,7 @@ var pveapi = [
"type" : "integer" "type" : "integer"
}, },
"rate" : { "rate" : {
"description" : "Rate limit in mbps as floating point number.", "description" : "Rate limit in mbps (megabytes per second) as floating point number.",
"minimum" : 0, "minimum" : 0,
"optional" : 1, "optional" : 1,
"type" : "number" "type" : "number"
@ -5669,7 +5672,7 @@ var pveapi = [
"tag" : { "tag" : {
"description" : "VLAN tag to apply to packets on this interface.", "description" : "VLAN tag to apply to packets on this interface.",
"maximum" : 4094, "maximum" : 4094,
"minimum" : 2, "minimum" : 1,
"optional" : 1, "optional" : 1,
"type" : "integer" "type" : "integer"
}, },
@ -5704,28 +5707,28 @@ var pveapi = [
"type" : "boolean" "type" : "boolean"
}, },
"numa[n]" : { "numa[n]" : {
"description" : "numa topology", "description" : "NUMA topology.",
"format" : { "format" : {
"cpus" : { "cpus" : {
"description" : "CPUs accessing this numa node.", "description" : "CPUs accessing this NUMA node.",
"format_description" : "id[-id];...", "format_description" : "id[-id];...",
"pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)", "pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)",
"type" : "string" "type" : "string"
}, },
"hostnodes" : { "hostnodes" : {
"description" : "host numa nodes to use", "description" : "Host NUMA nodes to use.",
"format_description" : "id[-id];...", "format_description" : "id[-id];...",
"optional" : 1, "optional" : 1,
"pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)", "pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)",
"type" : "string" "type" : "string"
}, },
"memory" : { "memory" : {
"description" : "Amount of memory this numa node provides.", "description" : "Amount of memory this NUMA node provides.",
"optional" : 1, "optional" : 1,
"type" : "number" "type" : "number"
}, },
"policy" : { "policy" : {
"description" : "numa allocation policy.", "description" : "NUMA allocation policy.",
"enum" : [ "enum" : [
"preferred", "preferred",
"bind", "bind",
@ -5745,7 +5748,7 @@ var pveapi = [
"type" : "boolean" "type" : "boolean"
}, },
"ostype" : { "ostype" : {
"description" : "Used to enable special optimization/features for specific\noperating systems:\n\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\nl24 => Linux 2.4 Kernel\nl26 => Linux 2.6/3.X Kernel\nsolaris => solaris/opensolaris/openindiania kernel\n\nother|l24|l26|solaris ... no special behaviour\nwxp|w2k|w2k3|w2k8|wvista|win7|win8 ... use --localtime switch\n", "description" : "Specify guest operating system.",
"enum" : [ "enum" : [
"other", "other",
"wxp", "wxp",
@ -5760,17 +5763,19 @@ var pveapi = [
"solaris" "solaris"
], ],
"optional" : 1, "optional" : 1,
"type" : "string" "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\nl24;; Linux 2.4 Kernel\nl26;; Linux 2.6/3.X Kernel\nsolaris;; Solaris/OpenSolaris/OpenIndiania kernel\n"
}, },
"parallel[n]" : { "parallel[n]" : {
"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 machines - use with special care.\n\nExperimental: user reported problems with this option.\n", "description" : "Map host parallel devices (n is 0 to 2).",
"optional" : 1, "optional" : 1,
"pattern" : "/dev/parport\\d+|/dev/usb/lp\\d+", "pattern" : "/dev/parport\\d+|/dev/usb/lp\\d+",
"type" : "string" "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 machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n"
}, },
"protection" : { "protection" : {
"default" : 0, "default" : 0,
"description" : "Sets the protection flag of the VM. This will prevent the remove operation.", "description" : "Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.",
"optional" : 1, "optional" : 1,
"type" : "boolean" "type" : "boolean"
}, },
@ -6265,7 +6270,7 @@ var pveapi = [
}, },
"scsihw" : { "scsihw" : {
"default" : "lsi", "default" : "lsi",
"description" : "scsi controller model", "description" : "SCSI controller model",
"enum" : [ "enum" : [
"lsi", "lsi",
"lsi53c810", "lsi53c810",
@ -6278,10 +6283,11 @@ var pveapi = [
"type" : "string" "type" : "string"
}, },
"serial[n]" : { "serial[n]" : {
"description" : "Create a serial device inside the VM (n is 0 to 3), and pass through a host serial device (i.e. /dev/ttyS0), or create a unix socket on the host 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 - use with special care.\n\nExperimental: user reported problems with this option.\n", "description" : "Create a serial device inside the VM (n is 0 to 3)",
"optional" : 1, "optional" : 1,
"pattern" : "(/dev/.+|socket)", "pattern" : "(/dev/.+|socket)",
"type" : "string" "type" : "string",
"verbose_description" : "\nCreate 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 - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n"
}, },
"shares" : { "shares" : {
"default" : 1000, "default" : 1000,
@ -6334,9 +6340,10 @@ var pveapi = [
}, },
"tablet" : { "tablet" : {
"default" : 1, "default" : 1,
"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 (-vga=qxl).", "description" : "Enable/disable the USB tablet device.",
"optional" : 1, "optional" : 1,
"type" : "boolean" "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 (-vga=qxl)."
}, },
"tdf" : { "tdf" : {
"default" : 0, "default" : 0,
@ -6351,23 +6358,24 @@ var pveapi = [
"type" : "boolean" "type" : "boolean"
}, },
"unused[n]" : { "unused[n]" : {
"description" : "Reference to unused volumes.", "description" : "Reference to unused volumes. This is used internally, and should not be modified manually.",
"format" : "pve-volume-id", "format" : "pve-volume-id",
"optional" : 1, "optional" : 1,
"type" : "string" "type" : "string"
}, },
"usb[n]" : { "usb[n]" : {
"description" : "Configure an USB device (n is 0 to 4). This can be used to\npass-through usb devices to the guest. 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 machines - use with special care.\n\nThe value 'spice' can be used to add a usb redirection devices for spice.\n\nThe 'usb3' option determines whether the device is a USB3 device or not (this does currently not work reliably with spice redirection and is then ignored).\n\n", "description" : "Configure an USB device (n is 0 to 4).",
"format" : { "format" : {
"host" : { "host" : {
"default_key" : 1, "default_key" : 1,
"description" : "The Host USB device or port or the value spice", "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 machines - 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" : "pve-qm-usb-device",
"format_description" : "HOSTUSBDEVICE|spice", "format_description" : "HOSTUSBDEVICE|spice",
"type" : "string" "type" : "string"
}, },
"usb3" : { "usb3" : {
"description" : "Specifies whether if given host option is a USB3 device or port", "default" : 0,
"description" : "Specifies whether if given host option is a USB3 device or port (this does currently not work reliably with spice redirection and is then ignored).",
"optional" : 1, "optional" : 1,
"type" : "boolean" "type" : "boolean"
} }
@ -6383,7 +6391,7 @@ var pveapi = [
"type" : "integer" "type" : "integer"
}, },
"vga" : { "vga" : {
"description" : "Select the VGA type. If you want to use high resolution modes (>= 1280x1024x16) then you should use the options 'std' or 'vmware'. Default is 'std' for win8/win7/w2k8, and 'cirrus' for other OS types. The 'qxl' option enables the SPICE display sever. For win* OS you can select how many independent displays you want, Linux guests can add displays them self. You can also run without any graphic card, using a serial device as terminal.", "description" : "Select the VGA type.",
"enum" : [ "enum" : [
"std", "std",
"cirrus", "cirrus",
@ -6398,7 +6406,8 @@ var pveapi = [
"qxl4" "qxl4"
], ],
"optional" : 1, "optional" : 1,
"type" : "string" "type" : "string",
"verbose_description" : "Select the VGA type. If you want to use high resolution modes (>= 1280x1024x16) then you should use the options 'std' or 'vmware'. Default is 'std' for win8/win7/w2k8, and 'cirrus' for other OS types. The 'qxl' option enables the SPICE display sever. For win* OS you can select how many independent displays you want, Linux guests can add displays them self. You can also run without any graphic card, using a serial device as terminal."
}, },
"virtio[n]" : { "virtio[n]" : {
"description" : "Use volume as VIRTIO hard disk (n is 0 to 15).", "description" : "Use volume as VIRTIO hard disk (n is 0 to 15).",
@ -6650,10 +6659,11 @@ var pveapi = [
"type" : "integer" "type" : "integer"
}, },
"watchdog" : { "watchdog" : {
"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)", "description" : "Create a virtual hardware watchdog device.",
"format" : "pve-qm-watchdog", "format" : "pve-qm-watchdog",
"optional" : 1, "optional" : 1,
"type" : "string" "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)"
} }
} }
}, },
@ -6701,9 +6711,10 @@ var pveapi = [
"type" : "boolean" "type" : "boolean"
}, },
"args" : { "args" : {
"description" : "Arbitrary arguments passed to kvm, for example:\n\nargs: -no-reboot -no-hpet\n\nNOTE: this option is for experts only.\n", "description" : "Arbitrary arguments passed to kvm.",
"optional" : 1, "optional" : 1,
"type" : "string" "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"
}, },
"autostart" : { "autostart" : {
"default" : 0, "default" : 0,
@ -6807,19 +6818,21 @@ var pveapi = [
}, },
"cpulimit" : { "cpulimit" : {
"default" : 0, "default" : 0,
"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.", "description" : "Limit of CPU usage.",
"maximum" : 128, "maximum" : 128,
"minimum" : 0, "minimum" : 0,
"optional" : 1, "optional" : 1,
"type" : "number" "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" : { "cpuunits" : {
"default" : 1000, "default" : 1000,
"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.\n\nNOTE: You can disable fair-scheduler configuration by setting this to 0.", "description" : "CPU weight for a VM.",
"maximum" : 500000, "maximum" : 500000,
"minimum" : 0, "minimum" : 0,
"optional" : 1, "optional" : 1,
"type" : "integer" "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.\n\nNOTE: You can disable fair-scheduler configuration by setting this to 0."
}, },
"delete" : { "delete" : {
"description" : "A list of settings you want to delete.", "description" : "A list of settings you want to delete.",
@ -6850,7 +6863,7 @@ var pveapi = [
"type" : "boolean" "type" : "boolean"
}, },
"hostpci[n]" : { "hostpci[n]" : {
"description" : "Map host pci devices. HOSTPCIDEVICE syntax is:\n\n'bus:dev.func' (hexadecimal numbers)\n\nYou can us the 'lspci' command to list existing pci devices.\n\nThe 'rombar' option determines whether or not the device's ROM will be visible in the guest's memory map (default is 'on').\n\nNOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.\n\nExperimental: user reported problems with this option.\n", "description" : "Map host PCI devices into guest.",
"format" : "pve-qm-hostpci", "format" : "pve-qm-hostpci",
"optional" : 1, "optional" : 1,
"type" : "string" "type" : "string"
@ -7110,7 +7123,7 @@ var pveapi = [
}, },
"keyboard" : { "keyboard" : {
"default" : "en-us", "default" : "en-us",
"description" : "Keybord layout for vnc server. Default is read from the datacenter configuration file.", "description" : "Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.",
"enum" : [ "enum" : [
"de", "de",
"de-ch", "de-ch",
@ -7198,10 +7211,10 @@ var pveapi = [
"type" : "string" "type" : "string"
}, },
"net[n]" : { "net[n]" : {
"description" : "Specify network devices.\n\nMODEL is one of: e1000 e1000-82540em e1000-82544gc e1000-82545em i82551 i82557b i82559er ne2k_isa ne2k_pci pcnet rtl8139 virtio vmxnet3\n\nXX:XX:XX:XX:XX:XX should be an unique MAC address. This is\nautomatically generated if not specified.\n\nThe bridge parameter can be used to automatically add the interface to a bridge device. The Proxmox VE standard bridge is called 'vmbr0'.\n\nOption 'rate' is used to limit traffic bandwidth from and to this interface. It is specified as floating point number, unit is 'Megabytes per second'.\n\nIf you specify no bridge, we create a kvm 'user' (NATed) network device, which provides DHCP and DNS services. The following addresses are used:\n\n10.0.2.2 Gateway\n10.0.2.3 DNS Server\n10.0.2.4 SMB Server\n\nThe DHCP server assign addresses to the guest starting from 10.0.2.15.\n\n", "description" : "Specify network devices.",
"format" : { "format" : {
"bridge" : { "bridge" : {
"description" : "Bridge to attach the network device to.", "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_description" : "bridge", "format_description" : "bridge",
"optional" : 1, "optional" : 1,
"type" : "string" "type" : "string"
@ -7240,12 +7253,12 @@ var pveapi = [
"keyAlias" : "model" "keyAlias" : "model"
}, },
"link_down" : { "link_down" : {
"description" : "Whether this interface should be DISconnected (like pulling the plug).", "description" : "Whether this interface should be disconnected (like pulling the plug).",
"optional" : 1, "optional" : 1,
"type" : "boolean" "type" : "boolean"
}, },
"macaddr" : { "macaddr" : {
"description" : "MAC address", "description" : "MAC address. That address must be unique withing your network. This is automatically generated if not specified.",
"format_description" : "XX:XX:XX:XX:XX:XX", "format_description" : "XX:XX:XX:XX:XX:XX",
"optional" : 1, "optional" : 1,
"pattern" : "(?^i:[0-9a-f]{2}(?::[0-9a-f]{2}){5})", "pattern" : "(?^i:[0-9a-f]{2}(?::[0-9a-f]{2}){5})",
@ -7253,7 +7266,7 @@ var pveapi = [
}, },
"model" : { "model" : {
"default_key" : 1, "default_key" : 1,
"description" : "Network Card Model.", "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" : [ "enum" : [
"rtl8139", "rtl8139",
"ne2k_pci", "ne2k_pci",
@ -7292,7 +7305,7 @@ var pveapi = [
"type" : "integer" "type" : "integer"
}, },
"rate" : { "rate" : {
"description" : "Rate limit in mbps as floating point number.", "description" : "Rate limit in mbps (megabytes per second) as floating point number.",
"minimum" : 0, "minimum" : 0,
"optional" : 1, "optional" : 1,
"type" : "number" "type" : "number"
@ -7304,7 +7317,7 @@ var pveapi = [
"tag" : { "tag" : {
"description" : "VLAN tag to apply to packets on this interface.", "description" : "VLAN tag to apply to packets on this interface.",
"maximum" : 4094, "maximum" : 4094,
"minimum" : 2, "minimum" : 1,
"optional" : 1, "optional" : 1,
"type" : "integer" "type" : "integer"
}, },
@ -7339,28 +7352,28 @@ var pveapi = [
"type" : "boolean" "type" : "boolean"
}, },
"numa[n]" : { "numa[n]" : {
"description" : "numa topology", "description" : "NUMA topology.",
"format" : { "format" : {
"cpus" : { "cpus" : {
"description" : "CPUs accessing this numa node.", "description" : "CPUs accessing this NUMA node.",
"format_description" : "id[-id];...", "format_description" : "id[-id];...",
"pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)", "pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)",
"type" : "string" "type" : "string"
}, },
"hostnodes" : { "hostnodes" : {
"description" : "host numa nodes to use", "description" : "Host NUMA nodes to use.",
"format_description" : "id[-id];...", "format_description" : "id[-id];...",
"optional" : 1, "optional" : 1,
"pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)", "pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)",
"type" : "string" "type" : "string"
}, },
"memory" : { "memory" : {
"description" : "Amount of memory this numa node provides.", "description" : "Amount of memory this NUMA node provides.",
"optional" : 1, "optional" : 1,
"type" : "number" "type" : "number"
}, },
"policy" : { "policy" : {
"description" : "numa allocation policy.", "description" : "NUMA allocation policy.",
"enum" : [ "enum" : [
"preferred", "preferred",
"bind", "bind",
@ -7380,7 +7393,7 @@ var pveapi = [
"type" : "boolean" "type" : "boolean"
}, },
"ostype" : { "ostype" : {
"description" : "Used to enable special optimization/features for specific\noperating systems:\n\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\nl24 => Linux 2.4 Kernel\nl26 => Linux 2.6/3.X Kernel\nsolaris => solaris/opensolaris/openindiania kernel\n\nother|l24|l26|solaris ... no special behaviour\nwxp|w2k|w2k3|w2k8|wvista|win7|win8 ... use --localtime switch\n", "description" : "Specify guest operating system.",
"enum" : [ "enum" : [
"other", "other",
"wxp", "wxp",
@ -7395,17 +7408,19 @@ var pveapi = [
"solaris" "solaris"
], ],
"optional" : 1, "optional" : 1,
"type" : "string" "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\nl24;; Linux 2.4 Kernel\nl26;; Linux 2.6/3.X Kernel\nsolaris;; Solaris/OpenSolaris/OpenIndiania kernel\n"
}, },
"parallel[n]" : { "parallel[n]" : {
"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 machines - use with special care.\n\nExperimental: user reported problems with this option.\n", "description" : "Map host parallel devices (n is 0 to 2).",
"optional" : 1, "optional" : 1,
"pattern" : "/dev/parport\\d+|/dev/usb/lp\\d+", "pattern" : "/dev/parport\\d+|/dev/usb/lp\\d+",
"type" : "string" "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 machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n"
}, },
"protection" : { "protection" : {
"default" : 0, "default" : 0,
"description" : "Sets the protection flag of the VM. This will prevent the remove operation.", "description" : "Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.",
"optional" : 1, "optional" : 1,
"type" : "boolean" "type" : "boolean"
}, },
@ -7900,7 +7915,7 @@ var pveapi = [
}, },
"scsihw" : { "scsihw" : {
"default" : "lsi", "default" : "lsi",
"description" : "scsi controller model", "description" : "SCSI controller model",
"enum" : [ "enum" : [
"lsi", "lsi",
"lsi53c810", "lsi53c810",
@ -7913,10 +7928,11 @@ var pveapi = [
"type" : "string" "type" : "string"
}, },
"serial[n]" : { "serial[n]" : {
"description" : "Create a serial device inside the VM (n is 0 to 3), and pass through a host serial device (i.e. /dev/ttyS0), or create a unix socket on the host 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 - use with special care.\n\nExperimental: user reported problems with this option.\n", "description" : "Create a serial device inside the VM (n is 0 to 3)",
"optional" : 1, "optional" : 1,
"pattern" : "(/dev/.+|socket)", "pattern" : "(/dev/.+|socket)",
"type" : "string" "type" : "string",
"verbose_description" : "\nCreate 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 - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n"
}, },
"shares" : { "shares" : {
"default" : 1000, "default" : 1000,
@ -7969,9 +7985,10 @@ var pveapi = [
}, },
"tablet" : { "tablet" : {
"default" : 1, "default" : 1,
"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 (-vga=qxl).", "description" : "Enable/disable the USB tablet device.",
"optional" : 1, "optional" : 1,
"type" : "boolean" "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 (-vga=qxl)."
}, },
"tdf" : { "tdf" : {
"default" : 0, "default" : 0,
@ -7986,23 +8003,24 @@ var pveapi = [
"type" : "boolean" "type" : "boolean"
}, },
"unused[n]" : { "unused[n]" : {
"description" : "Reference to unused volumes.", "description" : "Reference to unused volumes. This is used internally, and should not be modified manually.",
"format" : "pve-volume-id", "format" : "pve-volume-id",
"optional" : 1, "optional" : 1,
"type" : "string" "type" : "string"
}, },
"usb[n]" : { "usb[n]" : {
"description" : "Configure an USB device (n is 0 to 4). This can be used to\npass-through usb devices to the guest. 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 machines - use with special care.\n\nThe value 'spice' can be used to add a usb redirection devices for spice.\n\nThe 'usb3' option determines whether the device is a USB3 device or not (this does currently not work reliably with spice redirection and is then ignored).\n\n", "description" : "Configure an USB device (n is 0 to 4).",
"format" : { "format" : {
"host" : { "host" : {
"default_key" : 1, "default_key" : 1,
"description" : "The Host USB device or port or the value spice", "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 machines - 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" : "pve-qm-usb-device",
"format_description" : "HOSTUSBDEVICE|spice", "format_description" : "HOSTUSBDEVICE|spice",
"type" : "string" "type" : "string"
}, },
"usb3" : { "usb3" : {
"description" : "Specifies whether if given host option is a USB3 device or port", "default" : 0,
"description" : "Specifies whether if given host option is a USB3 device or port (this does currently not work reliably with spice redirection and is then ignored).",
"optional" : 1, "optional" : 1,
"type" : "boolean" "type" : "boolean"
} }
@ -8018,7 +8036,7 @@ var pveapi = [
"type" : "integer" "type" : "integer"
}, },
"vga" : { "vga" : {
"description" : "Select the VGA type. If you want to use high resolution modes (>= 1280x1024x16) then you should use the options 'std' or 'vmware'. Default is 'std' for win8/win7/w2k8, and 'cirrus' for other OS types. The 'qxl' option enables the SPICE display sever. For win* OS you can select how many independent displays you want, Linux guests can add displays them self. You can also run without any graphic card, using a serial device as terminal.", "description" : "Select the VGA type.",
"enum" : [ "enum" : [
"std", "std",
"cirrus", "cirrus",
@ -8033,7 +8051,8 @@ var pveapi = [
"qxl4" "qxl4"
], ],
"optional" : 1, "optional" : 1,
"type" : "string" "type" : "string",
"verbose_description" : "Select the VGA type. If you want to use high resolution modes (>= 1280x1024x16) then you should use the options 'std' or 'vmware'. Default is 'std' for win8/win7/w2k8, and 'cirrus' for other OS types. The 'qxl' option enables the SPICE display sever. For win* OS you can select how many independent displays you want, Linux guests can add displays them self. You can also run without any graphic card, using a serial device as terminal."
}, },
"virtio[n]" : { "virtio[n]" : {
"description" : "Use volume as VIRTIO hard disk (n is 0 to 15).", "description" : "Use volume as VIRTIO hard disk (n is 0 to 15).",
@ -8285,10 +8304,11 @@ var pveapi = [
"type" : "integer" "type" : "integer"
}, },
"watchdog" : { "watchdog" : {
"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)", "description" : "Create a virtual hardware watchdog device.",
"format" : "pve-qm-watchdog", "format" : "pve-qm-watchdog",
"optional" : 1, "optional" : 1,
"type" : "string" "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)"
} }
} }
}, },
@ -10232,9 +10252,10 @@ var pveapi = [
"type" : "string" "type" : "string"
}, },
"args" : { "args" : {
"description" : "Arbitrary arguments passed to kvm, for example:\n\nargs: -no-reboot -no-hpet\n\nNOTE: this option is for experts only.\n", "description" : "Arbitrary arguments passed to kvm.",
"optional" : 1, "optional" : 1,
"type" : "string" "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"
}, },
"autostart" : { "autostart" : {
"default" : 0, "default" : 0,
@ -10338,19 +10359,21 @@ var pveapi = [
}, },
"cpulimit" : { "cpulimit" : {
"default" : 0, "default" : 0,
"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.", "description" : "Limit of CPU usage.",
"maximum" : 128, "maximum" : 128,
"minimum" : 0, "minimum" : 0,
"optional" : 1, "optional" : 1,
"type" : "number" "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" : { "cpuunits" : {
"default" : 1000, "default" : 1000,
"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.\n\nNOTE: You can disable fair-scheduler configuration by setting this to 0.", "description" : "CPU weight for a VM.",
"maximum" : 500000, "maximum" : 500000,
"minimum" : 0, "minimum" : 0,
"optional" : 1, "optional" : 1,
"type" : "integer" "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.\n\nNOTE: You can disable fair-scheduler configuration by setting this to 0."
}, },
"description" : { "description" : {
"description" : "Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.", "description" : "Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.",
@ -10369,7 +10392,7 @@ var pveapi = [
"type" : "boolean" "type" : "boolean"
}, },
"hostpci[n]" : { "hostpci[n]" : {
"description" : "Map host pci devices. HOSTPCIDEVICE syntax is:\n\n'bus:dev.func' (hexadecimal numbers)\n\nYou can us the 'lspci' command to list existing pci devices.\n\nThe 'rombar' option determines whether or not the device's ROM will be visible in the guest's memory map (default is 'on').\n\nNOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.\n\nExperimental: user reported problems with this option.\n", "description" : "Map host PCI devices into guest.",
"format" : "pve-qm-hostpci", "format" : "pve-qm-hostpci",
"optional" : 1, "optional" : 1,
"type" : "string" "type" : "string"
@ -10629,7 +10652,7 @@ var pveapi = [
}, },
"keyboard" : { "keyboard" : {
"default" : "en-us", "default" : "en-us",
"description" : "Keybord layout for vnc server. Default is read from the datacenter configuration file.", "description" : "Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.",
"enum" : [ "enum" : [
"de", "de",
"de-ch", "de-ch",
@ -10717,10 +10740,10 @@ var pveapi = [
"type" : "string" "type" : "string"
}, },
"net[n]" : { "net[n]" : {
"description" : "Specify network devices.\n\nMODEL is one of: e1000 e1000-82540em e1000-82544gc e1000-82545em i82551 i82557b i82559er ne2k_isa ne2k_pci pcnet rtl8139 virtio vmxnet3\n\nXX:XX:XX:XX:XX:XX should be an unique MAC address. This is\nautomatically generated if not specified.\n\nThe bridge parameter can be used to automatically add the interface to a bridge device. The Proxmox VE standard bridge is called 'vmbr0'.\n\nOption 'rate' is used to limit traffic bandwidth from and to this interface. It is specified as floating point number, unit is 'Megabytes per second'.\n\nIf you specify no bridge, we create a kvm 'user' (NATed) network device, which provides DHCP and DNS services. The following addresses are used:\n\n10.0.2.2 Gateway\n10.0.2.3 DNS Server\n10.0.2.4 SMB Server\n\nThe DHCP server assign addresses to the guest starting from 10.0.2.15.\n\n", "description" : "Specify network devices.",
"format" : { "format" : {
"bridge" : { "bridge" : {
"description" : "Bridge to attach the network device to.", "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_description" : "bridge", "format_description" : "bridge",
"optional" : 1, "optional" : 1,
"type" : "string" "type" : "string"
@ -10759,12 +10782,12 @@ var pveapi = [
"keyAlias" : "model" "keyAlias" : "model"
}, },
"link_down" : { "link_down" : {
"description" : "Whether this interface should be DISconnected (like pulling the plug).", "description" : "Whether this interface should be disconnected (like pulling the plug).",
"optional" : 1, "optional" : 1,
"type" : "boolean" "type" : "boolean"
}, },
"macaddr" : { "macaddr" : {
"description" : "MAC address", "description" : "MAC address. That address must be unique withing your network. This is automatically generated if not specified.",
"format_description" : "XX:XX:XX:XX:XX:XX", "format_description" : "XX:XX:XX:XX:XX:XX",
"optional" : 1, "optional" : 1,
"pattern" : "(?^i:[0-9a-f]{2}(?::[0-9a-f]{2}){5})", "pattern" : "(?^i:[0-9a-f]{2}(?::[0-9a-f]{2}){5})",
@ -10772,7 +10795,7 @@ var pveapi = [
}, },
"model" : { "model" : {
"default_key" : 1, "default_key" : 1,
"description" : "Network Card Model.", "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" : [ "enum" : [
"rtl8139", "rtl8139",
"ne2k_pci", "ne2k_pci",
@ -10811,7 +10834,7 @@ var pveapi = [
"type" : "integer" "type" : "integer"
}, },
"rate" : { "rate" : {
"description" : "Rate limit in mbps as floating point number.", "description" : "Rate limit in mbps (megabytes per second) as floating point number.",
"minimum" : 0, "minimum" : 0,
"optional" : 1, "optional" : 1,
"type" : "number" "type" : "number"
@ -10823,7 +10846,7 @@ var pveapi = [
"tag" : { "tag" : {
"description" : "VLAN tag to apply to packets on this interface.", "description" : "VLAN tag to apply to packets on this interface.",
"maximum" : 4094, "maximum" : 4094,
"minimum" : 2, "minimum" : 1,
"optional" : 1, "optional" : 1,
"type" : "integer" "type" : "integer"
}, },
@ -10858,28 +10881,28 @@ var pveapi = [
"type" : "boolean" "type" : "boolean"
}, },
"numa[n]" : { "numa[n]" : {
"description" : "numa topology", "description" : "NUMA topology.",
"format" : { "format" : {
"cpus" : { "cpus" : {
"description" : "CPUs accessing this numa node.", "description" : "CPUs accessing this NUMA node.",
"format_description" : "id[-id];...", "format_description" : "id[-id];...",
"pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)", "pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)",
"type" : "string" "type" : "string"
}, },
"hostnodes" : { "hostnodes" : {
"description" : "host numa nodes to use", "description" : "Host NUMA nodes to use.",
"format_description" : "id[-id];...", "format_description" : "id[-id];...",
"optional" : 1, "optional" : 1,
"pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)", "pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)",
"type" : "string" "type" : "string"
}, },
"memory" : { "memory" : {
"description" : "Amount of memory this numa node provides.", "description" : "Amount of memory this NUMA node provides.",
"optional" : 1, "optional" : 1,
"type" : "number" "type" : "number"
}, },
"policy" : { "policy" : {
"description" : "numa allocation policy.", "description" : "NUMA allocation policy.",
"enum" : [ "enum" : [
"preferred", "preferred",
"bind", "bind",
@ -10899,7 +10922,7 @@ var pveapi = [
"type" : "boolean" "type" : "boolean"
}, },
"ostype" : { "ostype" : {
"description" : "Used to enable special optimization/features for specific\noperating systems:\n\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\nl24 => Linux 2.4 Kernel\nl26 => Linux 2.6/3.X Kernel\nsolaris => solaris/opensolaris/openindiania kernel\n\nother|l24|l26|solaris ... no special behaviour\nwxp|w2k|w2k3|w2k8|wvista|win7|win8 ... use --localtime switch\n", "description" : "Specify guest operating system.",
"enum" : [ "enum" : [
"other", "other",
"wxp", "wxp",
@ -10914,13 +10937,15 @@ var pveapi = [
"solaris" "solaris"
], ],
"optional" : 1, "optional" : 1,
"type" : "string" "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\nl24;; Linux 2.4 Kernel\nl26;; Linux 2.6/3.X Kernel\nsolaris;; Solaris/OpenSolaris/OpenIndiania kernel\n"
}, },
"parallel[n]" : { "parallel[n]" : {
"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 machines - use with special care.\n\nExperimental: user reported problems with this option.\n", "description" : "Map host parallel devices (n is 0 to 2).",
"optional" : 1, "optional" : 1,
"pattern" : "/dev/parport\\d+|/dev/usb/lp\\d+", "pattern" : "/dev/parport\\d+|/dev/usb/lp\\d+",
"type" : "string" "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 machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n"
}, },
"pool" : { "pool" : {
"description" : "Add the VM to the specified pool.", "description" : "Add the VM to the specified pool.",
@ -10930,7 +10955,7 @@ var pveapi = [
}, },
"protection" : { "protection" : {
"default" : 0, "default" : 0,
"description" : "Sets the protection flag of the VM. This will prevent the remove operation.", "description" : "Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.",
"optional" : 1, "optional" : 1,
"type" : "boolean" "type" : "boolean"
}, },
@ -11419,7 +11444,7 @@ var pveapi = [
}, },
"scsihw" : { "scsihw" : {
"default" : "lsi", "default" : "lsi",
"description" : "scsi controller model", "description" : "SCSI controller model",
"enum" : [ "enum" : [
"lsi", "lsi",
"lsi53c810", "lsi53c810",
@ -11432,10 +11457,11 @@ var pveapi = [
"type" : "string" "type" : "string"
}, },
"serial[n]" : { "serial[n]" : {
"description" : "Create a serial device inside the VM (n is 0 to 3), and pass through a host serial device (i.e. /dev/ttyS0), or create a unix socket on the host 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 - use with special care.\n\nExperimental: user reported problems with this option.\n", "description" : "Create a serial device inside the VM (n is 0 to 3)",
"optional" : 1, "optional" : 1,
"pattern" : "(/dev/.+|socket)", "pattern" : "(/dev/.+|socket)",
"type" : "string" "type" : "string",
"verbose_description" : "\nCreate 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 - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n"
}, },
"shares" : { "shares" : {
"default" : 1000, "default" : 1000,
@ -11489,9 +11515,10 @@ var pveapi = [
}, },
"tablet" : { "tablet" : {
"default" : 1, "default" : 1,
"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 (-vga=qxl).", "description" : "Enable/disable the USB tablet device.",
"optional" : 1, "optional" : 1,
"type" : "boolean" "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 (-vga=qxl)."
}, },
"tdf" : { "tdf" : {
"default" : 0, "default" : 0,
@ -11512,23 +11539,24 @@ var pveapi = [
"type" : "boolean" "type" : "boolean"
}, },
"unused[n]" : { "unused[n]" : {
"description" : "Reference to unused volumes.", "description" : "Reference to unused volumes. This is used internally, and should not be modified manually.",
"format" : "pve-volume-id", "format" : "pve-volume-id",
"optional" : 1, "optional" : 1,
"type" : "string" "type" : "string"
}, },
"usb[n]" : { "usb[n]" : {
"description" : "Configure an USB device (n is 0 to 4). This can be used to\npass-through usb devices to the guest. 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 machines - use with special care.\n\nThe value 'spice' can be used to add a usb redirection devices for spice.\n\nThe 'usb3' option determines whether the device is a USB3 device or not (this does currently not work reliably with spice redirection and is then ignored).\n\n", "description" : "Configure an USB device (n is 0 to 4).",
"format" : { "format" : {
"host" : { "host" : {
"default_key" : 1, "default_key" : 1,
"description" : "The Host USB device or port or the value spice", "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 machines - 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" : "pve-qm-usb-device",
"format_description" : "HOSTUSBDEVICE|spice", "format_description" : "HOSTUSBDEVICE|spice",
"type" : "string" "type" : "string"
}, },
"usb3" : { "usb3" : {
"description" : "Specifies whether if given host option is a USB3 device or port", "default" : 0,
"description" : "Specifies whether if given host option is a USB3 device or port (this does currently not work reliably with spice redirection and is then ignored).",
"optional" : 1, "optional" : 1,
"type" : "boolean" "type" : "boolean"
} }
@ -11544,7 +11572,7 @@ var pveapi = [
"type" : "integer" "type" : "integer"
}, },
"vga" : { "vga" : {
"description" : "Select the VGA type. If you want to use high resolution modes (>= 1280x1024x16) then you should use the options 'std' or 'vmware'. Default is 'std' for win8/win7/w2k8, and 'cirrus' for other OS types. The 'qxl' option enables the SPICE display sever. For win* OS you can select how many independent displays you want, Linux guests can add displays them self. You can also run without any graphic card, using a serial device as terminal.", "description" : "Select the VGA type.",
"enum" : [ "enum" : [
"std", "std",
"cirrus", "cirrus",
@ -11559,7 +11587,8 @@ var pveapi = [
"qxl4" "qxl4"
], ],
"optional" : 1, "optional" : 1,
"type" : "string" "type" : "string",
"verbose_description" : "Select the VGA type. If you want to use high resolution modes (>= 1280x1024x16) then you should use the options 'std' or 'vmware'. Default is 'std' for win8/win7/w2k8, and 'cirrus' for other OS types. The 'qxl' option enables the SPICE display sever. For win* OS you can select how many independent displays you want, Linux guests can add displays them self. You can also run without any graphic card, using a serial device as terminal."
}, },
"virtio[n]" : { "virtio[n]" : {
"description" : "Use volume as VIRTIO hard disk (n is 0 to 15).", "description" : "Use volume as VIRTIO hard disk (n is 0 to 15).",
@ -11811,10 +11840,11 @@ var pveapi = [
"type" : "integer" "type" : "integer"
}, },
"watchdog" : { "watchdog" : {
"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)", "description" : "Create a virtual hardware watchdog device.",
"format" : "pve-qm-watchdog", "format" : "pve-qm-watchdog",
"optional" : 1, "optional" : 1,
"type" : "string" "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)"
} }
} }
}, },
@ -11972,7 +12002,7 @@ var pveapi = [
"type" : "integer" "type" : "integer"
}, },
"mp[n]" : { "mp[n]" : {
"description" : "Use volume as container mount point (experimental feature).", "description" : "Use volume as container mount point.",
"format" : { "format" : {
"acl" : { "acl" : {
"description" : "Explicitly enable or disable ACL support.", "description" : "Explicitly enable or disable ACL support.",
@ -12095,7 +12125,7 @@ var pveapi = [
"tag" : { "tag" : {
"description" : "VLAN tag for this interface.", "description" : "VLAN tag for this interface.",
"maximum" : "4094", "maximum" : "4094",
"minimum" : "2", "minimum" : "1",
"optional" : 1, "optional" : 1,
"type" : "integer" "type" : "integer"
}, },
@ -12158,11 +12188,6 @@ var pveapi = [
"optional" : 1, "optional" : 1,
"type" : "boolean" "type" : "boolean"
}, },
"backup" : {
"description" : "Whether to include the mountpoint in backups.",
"optional" : 1,
"type" : "boolean"
},
"quota" : { "quota" : {
"description" : "Enable user quotas inside the container (not supported with zfs subvolumes)", "description" : "Enable user quotas inside the container (not supported with zfs subvolumes)",
"optional" : 1, "optional" : 1,
@ -12232,7 +12257,7 @@ var pveapi = [
"type" : "boolean" "type" : "boolean"
}, },
"unused[n]" : { "unused[n]" : {
"description" : "Reference to unused volumes.", "description" : "Reference to unused volumes. This is used internally, and should not be modified manually.",
"format" : "pve-volume-id", "format" : "pve-volume-id",
"optional" : 1, "optional" : 1,
"type" : "string" "type" : "string"
@ -15401,7 +15426,7 @@ var pveapi = [
"type" : "integer" "type" : "integer"
}, },
"mp[n]" : { "mp[n]" : {
"description" : "Use volume as container mount point (experimental feature).", "description" : "Use volume as container mount point.",
"format" : { "format" : {
"acl" : { "acl" : {
"description" : "Explicitly enable or disable ACL support.", "description" : "Explicitly enable or disable ACL support.",
@ -15524,7 +15549,7 @@ var pveapi = [
"tag" : { "tag" : {
"description" : "VLAN tag for this interface.", "description" : "VLAN tag for this interface.",
"maximum" : "4094", "maximum" : "4094",
"minimum" : "2", "minimum" : "1",
"optional" : 1, "optional" : 1,
"type" : "integer" "type" : "integer"
}, },
@ -15609,11 +15634,6 @@ var pveapi = [
"optional" : 1, "optional" : 1,
"type" : "boolean" "type" : "boolean"
}, },
"backup" : {
"description" : "Whether to include the mountpoint in backups.",
"optional" : 1,
"type" : "boolean"
},
"quota" : { "quota" : {
"description" : "Enable user quotas inside the container (not supported with zfs subvolumes)", "description" : "Enable user quotas inside the container (not supported with zfs subvolumes)",
"optional" : 1, "optional" : 1,
@ -15695,7 +15715,7 @@ var pveapi = [
"type" : "boolean" "type" : "boolean"
}, },
"unused[n]" : { "unused[n]" : {
"description" : "Reference to unused volumes.", "description" : "Reference to unused volumes. This is used internally, and should not be modified manually.",
"format" : "pve-volume-id", "format" : "pve-volume-id",
"optional" : 1, "optional" : 1,
"type" : "string" "type" : "string"

17
datacenter.cfg.5-opts.adoc
View File

@ -1,8 +1,6 @@
`console`: `(applet | html5 | vv)` :: `console`: `(applet | html5 | vv)` ::
Select the default Console viewer. You can either use the builtin java Select the default Console viewer. You can either use the builtin java applet (VNC), an external virt-viewer comtatible application (SPICE), or an HTML5 based viewer (noVNC).
applet (VNC), an external virt-viewer comtatible application (SPICE), or an
HTML5 based viewer (noVNC).
`email_from`: `string` :: `email_from`: `string` ::
@ -10,16 +8,13 @@ Specify email address to send notification from (default is root@$hostname)
`fencing`: `(both | hardware | watchdog)` (default=`watchdog`):: `fencing`: `(both | hardware | watchdog)` (default=`watchdog`)::
Set the fencing mode of the HA cluster. Hardware mode needs a valid Set the fencing mode of the HA cluster. Hardware mode needs a valid configuration of fence devices in /etc/pve/ha/fence.cfg. With both all two modes are used.
configuration of fence devices in /etc/pve/ha/fence.cfg. With both all two
modes are used.
+ +
WARNING: 'hardware' and 'both' are EXPERIMENTAL & WIP WARNING: 'hardware' and 'both' are EXPERIMENTAL & WIP
`http_proxy`: `http://.*` :: `http_proxy`: `http://.*` ::
Specify external http proxy which is used for downloads (example: Specify external http proxy which is used for downloads (example: 'http://username:password@host:port/')
'http://username:password@host:port/')
`keyboard`: `(da | de | de-ch | 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 | sl | sv | tr)` :: `keyboard`: `(da | de | de-ch | 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 | sl | sv | tr)` ::
@ -31,11 +26,9 @@ Default GUI language.
`max_workers`: `integer (1 - N)` :: `max_workers`: `integer (1 - N)` ::
Defines how many workers (per node) are maximal started on actions like Defines how many workers (per node) are maximal started on actions like 'stopall VMs' or task from the ha-manager.
'stopall VMs' or task from the ha-manager.
`migration_unsecure`: `boolean` :: `migration_unsecure`: `boolean` ::
Migration is secure using SSH tunnel by default. For secure private Migration is secure using SSH tunnel by default. For secure private networks you can disable it to speed up migration.
networks you can disable it to speed up migration.

73
ha-manager.1-synopsis.adoc
View File

@ -6,10 +6,7 @@ Create a new HA resource.
`<sid>` `<type>:<name>` :: `<sid>` `<type>:<name>` ::
HA resource ID. This consists of a resource type followed by a resource HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).
specific name, separated with colon (example: vm:100 / ct:100). For virtual
machines and containers, you can simply use the VM or CT id as a shortcut
(example: 100).
`-comment` `string` :: `-comment` `string` ::
@ -25,8 +22,7 @@ Maximal number of service relocate tries when a service failes to start.
`-max_restart` `integer (0 - N)` (default=`1`):: `-max_restart` `integer (0 - N)` (default=`1`)::
Maximal number of tries to restart the service on a node after its start Maximal number of tries to restart the service on a node after its start failed.
failed.
`-state` `(disabled | enabled)` (default=`enabled`):: `-state` `(disabled | enabled)` (default=`enabled`)::
@ -55,10 +51,7 @@ Disable a HA resource.
`<sid>` `<type>:<name>` :: `<sid>` `<type>:<name>` ::
HA resource ID. This consists of a resource type followed by a resource HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).
specific name, separated with colon (example: vm:100 / ct:100). For virtual
machines and containers, you can simply use the VM or CT id as a shortcut
(example: 100).
@ -68,10 +61,7 @@ Enable a HA resource.
`<sid>` `<type>:<name>` :: `<sid>` `<type>:<name>` ::
HA resource ID. This consists of a resource type followed by a resource HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).
specific name, separated with colon (example: vm:100 / ct:100). For virtual
machines and containers, you can simply use the VM or CT id as a shortcut
(example: 100).
@ -90,22 +80,15 @@ Description.
`-nodes` `<node>[:<pri>]{,<node>[:<pri>]}*` :: `-nodes` `<node>[:<pri>]{,<node>[:<pri>]}*` ::
List of cluster node names with optional priority. We use priority '0' as List of cluster node names with optional priority. We use priority '0' as default. The CRM tries to run services on the node with highest priority (also see option 'nofailback').
default. The CRM tries to run services on the node with highest priority
(also see option 'nofailback').
`-nofailback` `boolean` (default=`0`):: `-nofailback` `boolean` (default=`0`)::
The CRM tries to run services on the node with the highest priority. If a The CRM tries to run services on the node with the highest priority. If a node with higher priority comes online, the CRM migrates the service to that node. Enabling nofailback prevents that behavior.
node with higher priority comes online, the CRM migrates the service to
that node. Enabling nofailback prevents that behavior.
`-restricted` `boolean` (default=`0`):: `-restricted` `boolean` (default=`0`)::
Services on unrestricted groups may run on any cluster members if all group Services on unrestricted groups may run on any cluster members if all group members are offline. But they will migrate back as soon as a group member comes online. One can implement a 'preferred node' behavior using an unrestricted group with one member.
members are offline. But they will migrate back as soon as a group member
comes online. One can implement a 'preferred node' behavior using an
unrestricted group with one member.
`-type` `(group)` :: `-type` `(group)` ::
@ -147,27 +130,19 @@ A list of settings you want to delete.
`-digest` `string` :: `-digest` `string` ::
Prevent changes if current configuration file has different SHA1 digest. Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
This can be used to prevent concurrent modifications.
`-nodes` `<node>[:<pri>]{,<node>[:<pri>]}*` :: `-nodes` `<node>[:<pri>]{,<node>[:<pri>]}*` ::
List of cluster node names with optional priority. We use priority '0' as List of cluster node names with optional priority. We use priority '0' as default. The CRM tries to run services on the node with highest priority (also see option 'nofailback').
default. The CRM tries to run services on the node with highest priority
(also see option 'nofailback').
`-nofailback` `boolean` (default=`0`):: `-nofailback` `boolean` (default=`0`)::
The CRM tries to run services on the node with the highest priority. If a The CRM tries to run services on the node with the highest priority. If a node with higher priority comes online, the CRM migrates the service to that node. Enabling nofailback prevents that behavior.
node with higher priority comes online, the CRM migrates the service to
that node. Enabling nofailback prevents that behavior.
`-restricted` `boolean` (default=`0`):: `-restricted` `boolean` (default=`0`)::
Services on unrestricted groups may run on any cluster members if all group Services on unrestricted groups may run on any cluster members if all group members are offline. But they will migrate back as soon as a group member comes online. One can implement a 'preferred node' behavior using an unrestricted group with one member.
members are offline. But they will migrate back as soon as a group member
comes online. One can implement a 'preferred node' behavior using an
unrestricted group with one member.
@ -193,10 +168,7 @@ Request resource migration (online) to another node.
`<sid>` `<type>:<name>` :: `<sid>` `<type>:<name>` ::
HA resource ID. This consists of a resource type followed by a resource HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).
specific name, separated with colon (example: vm:100 / ct:100). For virtual
machines and containers, you can simply use the VM or CT id as a shortcut
(example: 100).
`<node>` `string` :: `<node>` `string` ::
@ -211,10 +183,7 @@ old node, and restarts it on the target node.
`<sid>` `<type>:<name>` :: `<sid>` `<type>:<name>` ::
HA resource ID. This consists of a resource type followed by a resource HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).
specific name, separated with colon (example: vm:100 / ct:100). For virtual
machines and containers, you can simply use the VM or CT id as a shortcut
(example: 100).
`<node>` `string` :: `<node>` `string` ::
@ -228,10 +197,7 @@ Delete resource configuration.
`<sid>` `<type>:<name>` :: `<sid>` `<type>:<name>` ::
HA resource ID. This consists of a resource type followed by a resource HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).
specific name, separated with colon (example: vm:100 / ct:100). For virtual
machines and containers, you can simply use the VM or CT id as a shortcut
(example: 100).
@ -241,10 +207,7 @@ Update resource configuration.
`<sid>` `<type>:<name>` :: `<sid>` `<type>:<name>` ::
HA resource ID. This consists of a resource type followed by a resource HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).
specific name, separated with colon (example: vm:100 / ct:100). For virtual
machines and containers, you can simply use the VM or CT id as a shortcut
(example: 100).
`-comment` `string` :: `-comment` `string` ::
@ -256,8 +219,7 @@ A list of settings you want to delete.
`-digest` `string` :: `-digest` `string` ::
Prevent changes if current configuration file has different SHA1 digest. Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
This can be used to prevent concurrent modifications.
`-group` `string` :: `-group` `string` ::
@ -269,8 +231,7 @@ Maximal number of service relocate tries when a service failes to start.
`-max_restart` `integer (0 - N)` (default=`1`):: `-max_restart` `integer (0 - N)` (default=`1`)::
Maximal number of tries to restart the service on a node after its start Maximal number of tries to restart the service on a node after its start failed.
failed.
`-state` `(disabled | enabled)` (default=`enabled`):: `-state` `(disabled | enabled)` (default=`enabled`)::

2
pct-mountpoint-opts.adoc
View File

@ -1,4 +1,4 @@
`rootfs`: `[volume=]<volume> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=<DiskSize>]` `rootfs`: `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=<DiskSize>]`
`mp[n]`: `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=<DiskSize>]` `mp[n]`: `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=<DiskSize>]`

9
pct-network-opts.adoc
View File

@ -18,9 +18,7 @@ Default gateway for IPv6 traffic.
`hwaddr`: `<XX:XX:XX:XX:XX:XX>` :: `hwaddr`: `<XX:XX:XX:XX:XX:XX>` ::
The interface MAC address. This is dynamically allocated by default, but The interface MAC address. This is dynamically allocated by default, but you can set that statically if needed, for example to always have the same link-local IPv6 address. (lxc.network.hwaddr)
you can set that statically if needed, for example to always have the same
link-local IPv6 address. (lxc.network.hwaddr)
`ip`: `<IPv4Format/CIDR>` :: `ip`: `<IPv4Format/CIDR>` ::
@ -36,14 +34,13 @@ Maximum transfer unit of the interface. (lxc.network.mtu)
`name`: `<string>` :: `name`: `<string>` ::
Name of the network device as seen from inside the container. Name of the network device as seen from inside the container. (lxc.network.name)
(lxc.network.name)
`rate`: `<mbps>` :: `rate`: `<mbps>` ::
Apply rate limiting to the interface Apply rate limiting to the interface
`tag`: `integer (2 - 4094)` :: `tag`: `integer (1 - 4094)` ::
VLAN tag for this interface. VLAN tag for this interface.

154
pct.1-synopsis.adoc
View File

@ -18,13 +18,11 @@ Description for the new CT.
`-experimental` `boolean` (default=`0`):: `-experimental` `boolean` (default=`0`)::
The clone feature is experimental, set this flag if you know what you are The clone feature is experimental, set this flag if you know what you are doing.
doing.
`-full` `boolean` (default=`0`):: `-full` `boolean` (default=`0`)::
Create a full copy of all disk. This is always done when you clone a normal Create a full copy of all disk. This is always done when you clone a normal CT. For CT templates, we try to create a linked clone by default.
CT. For CT templates, we try to create a linked clone by default.
`-hostname` `string` :: `-hostname` `string` ::
@ -87,10 +85,7 @@ OS architecture type.
`-cmode` `(console | shell | tty)` (default=`tty`):: `-cmode` `(console | shell | tty)` (default=`tty`)::
Console mode. By default, the console command tries to open a connection to Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login).
one of the available tty devices. By setting cmode to 'console' it tries to
attach to /dev/console instead. If you set cmode to 'shell', it simply
invokes a shell inside the container (no login).
`-console` `boolean` (default=`1`):: `-console` `boolean` (default=`1`)::
@ -100,14 +95,11 @@ Attach a console device (/dev/console) to the container.
Limit of CPU usage. Limit of CPU usage.
+ +
NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.
indicates no CPU limit.
`-cpuunits` `integer (0 - 500000)` (default=`1024`):: `-cpuunits` `integer (0 - 500000)` (default=`1024`)::
CPU weight for a VM. Argument is used in the kernel fair scheduler. The 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 the weights of all the other running VMs.
larger the number is, the more CPU time this VM gets. Number is relative to
the weights of all the other running VMs.
+ +
NOTE: You can disable fair-scheduler configuration by setting this to 0. NOTE: You can disable fair-scheduler configuration by setting this to 0.
@ -137,12 +129,11 @@ Amount of RAM for the VM in MB.
`-mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=<DiskSize>]` :: `-mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=<DiskSize>]` ::
Use volume as container mount point (experimental feature). Use volume as container mount point.
`-nameserver` `string` :: `-nameserver` `string` ::
Sets DNS server IP address for a container. Create will automatically use Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
the setting from the host if you neither set searchdomain nor nameserver.
`-net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` :: `-net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
@ -154,10 +145,7 @@ Specifies whether a VM will be started during system bootup.
`-ostype` `(alpine | archlinux | centos | debian | fedora | opensuse | ubuntu | unmanaged)` :: `-ostype` `(alpine | archlinux | centos | debian | fedora | opensuse | ubuntu | unmanaged)` ::
OS type. This is used to setup configuration inside the container, and OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup.
corresponds to lxc setup scripts in
/usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used
to skip and OS specific setup.
`-password` :: `-password` ::
@ -169,21 +157,19 @@ Add the VM to the specified pool.
`-protection` `boolean` (default=`0`):: `-protection` `boolean` (default=`0`)::
Sets the protection flag of the container. This will prevent the CT or CT's Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
disk remove/update operation.
`-restore` `boolean` :: `-restore` `boolean` ::
Mark this as restore task. Mark this as restore task.
`-rootfs` `[volume=]<volume> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=<DiskSize>]` :: `-rootfs` `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=<DiskSize>]` ::
Use volume as container root. Use volume as container root.
`-searchdomain` `string` :: `-searchdomain` `string` ::
Sets DNS search domains for a container. Create will automatically use the Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
setting from the host if you neither set searchdomain nor nameserver.
`-ssh-public-keys` `filepath` :: `-ssh-public-keys` `filepath` ::
@ -191,10 +177,7 @@ Setup public SSH keys (one key per line, OpenSSH format).
`-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` :: `-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
Startup and shutdown behavior. Order is a non-negative number defining the 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.
general startup order. Shutdown in done with reverse ordering. Additionally
you can set the 'up' or 'down' delay in seconds, which specifies a delay to
wait before the next VM is started or stopped.
`-storage` `string` (default=`local`):: `-storage` `string` (default=`local`)::
@ -214,12 +197,11 @@ Specify the number of tty available to the container
`-unprivileged` `boolean` (default=`0`):: `-unprivileged` `boolean` (default=`0`)::
Makes the container run as unprivileged user. (Should not be modified Makes the container run as unprivileged user. (Should not be modified manually.)
manually.)
`-unused[n]` `string` :: `-unused[n]` `string` ::
Reference to unused volumes. Reference to unused volumes. This is used internally, and should not be modified manually.
@ -344,8 +326,7 @@ Target node.
`-force` `boolean` :: `-force` `boolean` ::
Force migration despite local bind / device mounts. WARNING: identical bind Force migration despite local bind / device mounts. WARNING: identical bind / device mounts need to be available on the target node.
/ device mounts need to be available on the target node.
`-online` `boolean` :: `-online` `boolean` ::
@ -388,8 +369,7 @@ Owner group name or id.
`-perms` `string` :: `-perms` `string` ::
File permissions to use (octal by default, prefix with '0x' for File permissions to use (octal by default, prefix with '0x' for hexadecimal).
hexadecimal).
`-user` `string` :: `-user` `string` ::
@ -415,18 +395,15 @@ Destination inside the container to write to.
`-group` `string` :: `-group` `string` ::
Owner group name or id. When using a name it must exist inside the Owner group name or id. When using a name it must exist inside the container.
container.
`-perms` `string` :: `-perms` `string` ::
File permissions to use (octal by default, prefix with '0x' for File permissions to use (octal by default, prefix with '0x' for hexadecimal).
hexadecimal).
`-user` `string` :: `-user` `string` ::
Owner user name or id. When using a name it must exist inside the Owner user name or id. When using a name it must exist inside the container.
container.
@ -445,14 +422,11 @@ The disk you want to resize.
`<size>` `\+?\d+(\.\d+)?[KMGT]?` :: `<size>` `\+?\d+(\.\d+)?[KMGT]?` ::
The new size. With the '+' sign the value is added to the actual size of 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.
the volume and without it, the value is taken as an absolute one. Shrinking
disk size is not supported.
`-digest` `string` :: `-digest` `string` ::
Prevent changes if current configuration file has different SHA1 digest. Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
This can be used to prevent concurrent modifications.
@ -474,10 +448,7 @@ OS architecture type.
`-cmode` `(console | shell | tty)` (default=`tty`):: `-cmode` `(console | shell | tty)` (default=`tty`)::
Console mode. By default, the console command tries to open a connection to Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login).
one of the available tty devices. By setting cmode to 'console' it tries to
attach to /dev/console instead. If you set cmode to 'shell', it simply
invokes a shell inside the container (no login).
`-console` `boolean` (default=`1`):: `-console` `boolean` (default=`1`)::
@ -487,14 +458,11 @@ Attach a console device (/dev/console) to the container.
Limit of CPU usage. Limit of CPU usage.
+ +
NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.
indicates no CPU limit.
`-cpuunits` `integer (0 - 500000)` (default=`1024`):: `-cpuunits` `integer (0 - 500000)` (default=`1024`)::
CPU weight for a VM. Argument is used in the kernel fair scheduler. The 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 the weights of all the other running VMs.
larger the number is, the more CPU time this VM gets. Number is relative to
the weights of all the other running VMs.
+ +
NOTE: You can disable fair-scheduler configuration by setting this to 0. NOTE: You can disable fair-scheduler configuration by setting this to 0.
@ -524,12 +492,11 @@ Amount of RAM for the VM in MB.
`-mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=<DiskSize>]` :: `-mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=<DiskSize>]` ::
Use volume as container mount point (experimental feature). Use volume as container mount point.
`-nameserver` `string` :: `-nameserver` `string` ::
Sets DNS server IP address for a container. Create will automatically use Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
the setting from the host if you neither set searchdomain nor nameserver.
`-net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` :: `-net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
@ -541,10 +508,7 @@ Specifies whether a VM will be started during system bootup.
`-ostype` `(alpine | archlinux | centos | debian | fedora | opensuse | ubuntu | unmanaged)` :: `-ostype` `(alpine | archlinux | centos | debian | fedora | opensuse | ubuntu | unmanaged)` ::
OS type. This is used to setup configuration inside the container, and OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup.
corresponds to lxc setup scripts in
/usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used
to skip and OS specific setup.
`-password` :: `-password` ::
@ -556,17 +520,15 @@ Add the VM to the specified pool.
`-protection` `boolean` (default=`0`):: `-protection` `boolean` (default=`0`)::
Sets the protection flag of the container. This will prevent the CT or CT's Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
disk remove/update operation.
`-rootfs` `[volume=]<volume> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=<DiskSize>]` :: `-rootfs` `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=<DiskSize>]` ::
Use volume as container root. Use volume as container root.
`-searchdomain` `string` :: `-searchdomain` `string` ::
Sets DNS search domains for a container. Create will automatically use the Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
setting from the host if you neither set searchdomain nor nameserver.
`-ssh-public-keys` `filepath` :: `-ssh-public-keys` `filepath` ::
@ -574,10 +536,7 @@ Setup public SSH keys (one key per line, OpenSSH format).
`-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` :: `-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
Startup and shutdown behavior. Order is a non-negative number defining the 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.
general startup order. Shutdown in done with reverse ordering. Additionally
you can set the 'up' or 'down' delay in seconds, which specifies a delay to
wait before the next VM is started or stopped.
`-storage` `string` (default=`local`):: `-storage` `string` (default=`local`)::
@ -597,12 +556,11 @@ Specify the number of tty available to the container
`-unprivileged` `boolean` (default=`0`):: `-unprivileged` `boolean` (default=`0`)::
Makes the container run as unprivileged user. (Should not be modified Makes the container run as unprivileged user. (Should not be modified manually.)
manually.)
`-unused[n]` `string` :: `-unused[n]` `string` ::
Reference to unused volumes. Reference to unused volumes. This is used internally, and should not be modified manually.
@ -647,10 +605,7 @@ OS architecture type.
`-cmode` `(console | shell | tty)` (default=`tty`):: `-cmode` `(console | shell | tty)` (default=`tty`)::
Console mode. By default, the console command tries to open a connection to Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login).
one of the available tty devices. By setting cmode to 'console' it tries to
attach to /dev/console instead. If you set cmode to 'shell', it simply
invokes a shell inside the container (no login).
`-console` `boolean` (default=`1`):: `-console` `boolean` (default=`1`)::
@ -660,14 +615,11 @@ Attach a console device (/dev/console) to the container.
Limit of CPU usage. Limit of CPU usage.
+ +
NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.
indicates no CPU limit.
`-cpuunits` `integer (0 - 500000)` (default=`1024`):: `-cpuunits` `integer (0 - 500000)` (default=`1024`)::
CPU weight for a VM. Argument is used in the kernel fair scheduler. The 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 the weights of all the other running VMs.
larger the number is, the more CPU time this VM gets. Number is relative to
the weights of all the other running VMs.
+ +
NOTE: You can disable fair-scheduler configuration by setting this to 0. NOTE: You can disable fair-scheduler configuration by setting this to 0.
@ -681,8 +633,7 @@ Container description. Only used on the configuration web interface.
`-digest` `string` :: `-digest` `string` ::
Prevent changes if current configuration file has different SHA1 digest. Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
This can be used to prevent concurrent modifications.
`-hostname` `string` :: `-hostname` `string` ::
@ -698,12 +649,11 @@ Amount of RAM for the VM in MB.
`-mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=<DiskSize>]` :: `-mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=<DiskSize>]` ::
Use volume as container mount point (experimental feature). Use volume as container mount point.
`-nameserver` `string` :: `-nameserver` `string` ::
Sets DNS server IP address for a container. Create will automatically use Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
the setting from the host if you neither set searchdomain nor nameserver.
`-net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` :: `-net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
@ -715,31 +665,23 @@ Specifies whether a VM will be started during system bootup.
`-ostype` `(alpine | archlinux | centos | debian | fedora | opensuse | ubuntu | unmanaged)` :: `-ostype` `(alpine | archlinux | centos | debian | fedora | opensuse | ubuntu | unmanaged)` ::
OS type. This is used to setup configuration inside the container, and OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup.
corresponds to lxc setup scripts in
/usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used
to skip and OS specific setup.
`-protection` `boolean` (default=`0`):: `-protection` `boolean` (default=`0`)::
Sets the protection flag of the container. This will prevent the CT or CT's Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
disk remove/update operation.
`-rootfs` `[volume=]<volume> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=<DiskSize>]` :: `-rootfs` `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=<DiskSize>]` ::
Use volume as container root. Use volume as container root.
`-searchdomain` `string` :: `-searchdomain` `string` ::
Sets DNS search domains for a container. Create will automatically use the Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
setting from the host if you neither set searchdomain nor nameserver.
`-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` :: `-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
Startup and shutdown behavior. Order is a non-negative number defining the 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.
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.
`-swap` `integer (0 - N)` (default=`512`):: `-swap` `integer (0 - N)` (default=`512`)::
@ -755,12 +697,11 @@ Specify the number of tty available to the container
`-unprivileged` `boolean` (default=`0`):: `-unprivileged` `boolean` (default=`0`)::
Makes the container run as unprivileged user. (Should not be modified Makes the container run as unprivileged user. (Should not be modified manually.)
manually.)
`-unused[n]` `string` :: `-unused[n]` `string` ::
Reference to unused volumes. Reference to unused volumes. This is used internally, and should not be modified manually.
@ -854,8 +795,7 @@ The (unique) ID of the VM.
`-experimental` `boolean` (default=`0`):: `-experimental` `boolean` (default=`0`)::
The template feature is experimental, set this flag if you know what you The template feature is experimental, set this flag if you know what you are doing.
are doing.

140
pct.conf.5-opts.adoc
View File

@ -4,10 +4,7 @@ OS architecture type.
`cmode`: `(console | shell | tty)` (default=`tty`):: `cmode`: `(console | shell | tty)` (default=`tty`)::
Console mode. By default, the console command tries to open a connection to Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login).
one of the available tty devices. By setting cmode to 'console' it tries to
attach to /dev/console instead. If you set cmode to 'shell', it simply
invokes a shell inside the container (no login).
`console`: `boolean` (default=`1`):: `console`: `boolean` (default=`1`)::
@ -17,14 +14,11 @@ Attach a console device (/dev/console) to the container.
Limit of CPU usage. Limit of CPU usage.
+ +
NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.
indicates no CPU limit.
`cpuunits`: `integer (0 - 500000)` (default=`1024`):: `cpuunits`: `integer (0 - 500000)` (default=`1024`)::
CPU weight for a VM. Argument is used in the kernel fair scheduler. The 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 the weights of all the other running VMs.
larger the number is, the more CPU time this VM gets. Number is relative to
the weights of all the other running VMs.
+ +
NOTE: You can disable fair-scheduler configuration by setting this to 0. NOTE: You can disable fair-scheduler configuration by setting this to 0.
@ -46,48 +40,139 @@ Amount of RAM for the VM in MB.
`mp[n]`: `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=<DiskSize>]` :: `mp[n]`: `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=<DiskSize>]` ::
Use volume as container mount point (experimental feature). Use volume as container mount point.
`acl`=`boolean` ;;
Explicitly enable or disable ACL support.
`backup`=`boolean` ;;
Whether to include the mountpoint in backups.
`mp`=`<Path>` ;;
Path to the mountpoint as seen from inside the container.
`quota`=`boolean` ;;
Enable user quotas inside the container (not supported with zfs subvolumes)
`ro`=`boolean` ;;
Read-only mountpoint (not supported with bind mounts)
`size`=`<DiskSize>` ;;
Volume size (read only value).
`volume`=`<volume>` ;;
Volume, device or directory to mount into the container.
`nameserver`: `string` :: `nameserver`: `string` ::
Sets DNS server IP address for a container. Create will automatically use Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
the setting from the host if you neither set searchdomain nor nameserver.
`net[n]`: `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` :: `net[n]`: `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
Specifies network interfaces for the container. Specifies network interfaces for the container.
`bridge`=`<bridge>` ;;
Bridge to attach the network device to.
`firewall`=`boolean` ;;
Controls whether this interface's firewall rules should be used.
`gw`=`<GatewayIPv4>` ;;
Default gateway for IPv4 traffic.
`gw6`=`<GatewayIPv6>` ;;
Default gateway for IPv6 traffic.
`hwaddr`=`<XX:XX:XX:XX:XX:XX>` ;;
The interface MAC address. This is dynamically allocated by default, but you can set that statically if needed, for example to always have the same link-local IPv6 address. (lxc.network.hwaddr)
`ip`=`<IPv4Format/CIDR>` ;;
IPv4 address in CIDR format.
`ip6`=`<IPv6Format/CIDR>` ;;
IPv6 address in CIDR format.
`mtu`=`integer (64 - N)` ;;
Maximum transfer unit of the interface. (lxc.network.mtu)
`name`=`<string>` ;;
Name of the network device as seen from inside the container. (lxc.network.name)
`rate`=`<mbps>` ;;
Apply rate limiting to the interface
`tag`=`integer (1 - 4094)` ;;
VLAN tag for this interface.
`trunks`=`<vlanid[;vlanid...]>` ;;
VLAN ids to pass through the interface
`type`=`(veth)` ;;
Network interface type.
`onboot`: `boolean` (default=`0`):: `onboot`: `boolean` (default=`0`)::
Specifies whether a VM will be started during system bootup. Specifies whether a VM will be started during system bootup.
`ostype`: `(alpine | archlinux | centos | debian | fedora | opensuse | ubuntu | unmanaged)` :: `ostype`: `(alpine | archlinux | centos | debian | fedora | opensuse | ubuntu | unmanaged)` ::
OS type. This is used to setup configuration inside the container, and OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup.
corresponds to lxc setup scripts in
/usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used
to skip and OS specific setup.
`protection`: `boolean` (default=`0`):: `protection`: `boolean` (default=`0`)::
Sets the protection flag of the container. This will prevent the CT or CT's Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
disk remove/update operation.
`rootfs`: `[volume=]<volume> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=<DiskSize>]` :: `rootfs`: `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=<DiskSize>]` ::
Use volume as container root. Use volume as container root.
`acl`=`boolean` ;;
Explicitly enable or disable ACL support.
`quota`=`boolean` ;;
Enable user quotas inside the container (not supported with zfs subvolumes)
`ro`=`boolean` ;;
Read-only mountpoint (not supported with bind mounts)
`size`=`<DiskSize>` ;;
Volume size (read only value).
`volume`=`<volume>` ;;
Volume, device or directory to mount into the container.
`searchdomain`: `string` :: `searchdomain`: `string` ::
Sets DNS search domains for a container. Create will automatically use the Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
setting from the host if you neither set searchdomain nor nameserver.
`startup`: `[[order=]\d+] [,up=\d+] [,down=\d+] ` :: `startup`: `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
Startup and shutdown behavior. Order is a non-negative number defining the 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.
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.
`swap`: `integer (0 - N)` (default=`512`):: `swap`: `integer (0 - N)` (default=`512`)::
@ -103,10 +188,9 @@ Specify the number of tty available to the container
`unprivileged`: `boolean` (default=`0`):: `unprivileged`: `boolean` (default=`0`)::
Makes the container run as unprivileged user. (Should not be modified Makes the container run as unprivileged user. (Should not be modified manually.)
manually.)
`unused[n]`: `string` :: `unused[n]`: `string` ::
Reference to unused volumes. Reference to unused volumes. This is used internally, and should not be modified manually.

3
pveceph.1-synopsis.adoc
View File

@ -114,8 +114,7 @@ Use specific network for all ceph related traffic
`-pg_bits` `integer (6 - 14)` (default=`6`):: `-pg_bits` `integer (6 - 14)` (default=`6`)::
Placement group bits, used to specify the default number of placement Placement group bits, used to specify the default number of placement groups.
groups.
+ +
NOTE: 'osd pool default pg num' does not work for default pools. NOTE: 'osd pool default pg num' does not work for default pools.

27
pvecm.1-synopsis.adoc
View File

@ -18,13 +18,11 @@ Node id for this node.
`-ring0_addr` `string` :: `-ring0_addr` `string` ::
Hostname (or IP) of the corosync ring0 address of this node. Defaults to Hostname (or IP) of the corosync ring0 address of this node. Defaults to nodes hostname.
nodes hostname.
`-ring1_addr` `string` :: `-ring1_addr` `string` ::
Hostname (or IP) of the corosync ring1 address, this needs an valid Hostname (or IP) of the corosync ring1 address, this needs an valid configured ring 1 interface in the cluster.
configured ring 1 interface in the cluster.
`-votes` `integer (0 - N)` :: `-votes` `integer (0 - N)` ::
@ -50,13 +48,11 @@ Node id for this node.
`-ring0_addr` `string` :: `-ring0_addr` `string` ::
Hostname (or IP) of the corosync ring0 address of this node. Defaults to Hostname (or IP) of the corosync ring0 address of this node. Defaults to nodes hostname.
nodes hostname.
`-ring1_addr` `string` :: `-ring1_addr` `string` ::
Hostname (or IP) of the corosync ring1 address, this needs an valid Hostname (or IP) of the corosync ring1 address, this needs an valid bindnet1_addr.
bindnet1_addr.
`-votes` `integer (0 - N)` :: `-votes` `integer (0 - N)` ::
@ -74,13 +70,11 @@ The name of the cluster.
`-bindnet0_addr` `string` :: `-bindnet0_addr` `string` ::
This specifies the network address the corosync ring 0 executive should This specifies the network address the corosync ring 0 executive should bind to and defaults to the local IP address of the node.
bind to and defaults to the local IP address of the node.
`-bindnet1_addr` `string` :: `-bindnet1_addr` `string` ::
This specifies the network address the corosync ring 1 executive should This specifies the network address the corosync ring 1 executive should bind to and is optional.
bind to and is optional.
`-nodeid` `integer (1 - N)` :: `-nodeid` `integer (1 - N)` ::
@ -88,18 +82,15 @@ Node id for this node.
`-ring0_addr` `string` :: `-ring0_addr` `string` ::
Hostname (or IP) of the corosync ring0 address of this node. Defaults to Hostname (or IP) of the corosync ring0 address of this node. Defaults to the hostname of the node.
the hostname of the node.
`-ring1_addr` `string` :: `-ring1_addr` `string` ::
Hostname (or IP) of the corosync ring1 address, this needs an valid Hostname (or IP) of the corosync ring1 address, this needs an valid bindnet1_addr.
bindnet1_addr.
`-rrp_mode` `(active | none | passive)` (default=`none`):: `-rrp_mode` `(active | none | passive)` (default=`none`)::
This specifies the mode of redundant ring, which may be none, active or This specifies the mode of redundant ring, which may be none, active or passive. Using multiple interfaces only allows 'active' or 'passive'.
passive. Using multiple interfaces only allows 'active' or 'passive'.
`-votes` `integer (1 - N)` :: `-votes` `integer (1 - N)` ::

23
pvesm.1-synopsis.adoc
View File

@ -36,8 +36,7 @@ target group for comstar views
Allowed content types. Allowed content types.
+ +
NOTE: the value 'rootdir' is used for Containers, and value 'images' for NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
VMs.
`-disable` `boolean` :: `-disable` `boolean` ::
@ -93,9 +92,7 @@ iSCSI portal (IP or DNS name with optional port).
`-redundancy` `integer (1 - 16)` (default=`2`):: `-redundancy` `integer (1 - 16)` (default=`2`)::
The redundancy count specifies the number of nodes to which the resource The redundancy count specifies the number of nodes to which the resource should be deployed. It must be at least 1 and at most the number of nodes in the cluster.
should be deployed. It must be at least 1 and at most the number of nodes
in the cluster.
`-saferemove` `boolean` :: `-saferemove` `boolean` ::
@ -168,8 +165,7 @@ The name of the file to create.
`<size>` `\d+[MG]?` :: `<size>` `\d+[MG]?` ::
Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and 'G' (gigabyte, 1024M)
'G' (gigabyte, 1024M)
`-format` `(qcow2 | raw | subvol)` :: `-format` `(qcow2 | raw | subvol)` ::
@ -322,8 +318,7 @@ target group for comstar views
Allowed content types. Allowed content types.
+ +
NOTE: the value 'rootdir' is used for Containers, and value 'images' for NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
VMs.
`-delete` `string` :: `-delete` `string` ::
@ -331,8 +326,7 @@ A list of settings you want to delete.
`-digest` `string` :: `-digest` `string` ::
Prevent changes if current configuration file has different SHA1 digest. Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
This can be used to prevent concurrent modifications.
`-disable` `boolean` :: `-disable` `boolean` ::
@ -368,9 +362,7 @@ Pool.
`-redundancy` `integer (1 - 16)` (default=`2`):: `-redundancy` `integer (1 - 16)` (default=`2`)::
The redundancy count specifies the number of nodes to which the resource The redundancy count specifies the number of nodes to which the resource should be deployed. It must be at least 1 and at most the number of nodes in the cluster.
should be deployed. It must be at least 1 and at most the number of nodes
in the cluster.
`-saferemove` `boolean` :: `-saferemove` `boolean` ::
@ -427,8 +419,7 @@ Only list status for specified storage
`-target` `string` :: `-target` `string` ::
If target is different to 'node', we only lists shared storages which If target is different to 'node', we only lists shared storages which content is accessible on this 'node' and the specified 'target' node.
content is accessible on this 'node' and the specified 'target' node.

3
pvesubscription.1-synopsis.adoc
View File

@ -38,8 +38,7 @@ Update subscription info.
`-force` `boolean` (default=`0`):: `-force` `boolean` (default=`0`)::
Always connect to server, even if we have up to date info inside local Always connect to server, even if we have up to date info inside local cache.
cache.

9
pveum.1-synopsis.adoc
View File

@ -189,8 +189,7 @@ NOTE: Requires option(s): `path`
`-realm` `string` :: `-realm` `string` ::
You can optionally pass the realm using this parameter. Normally the realm You can optionally pass the realm using this parameter. Normally the realm is simply added to the username <username>@<relam>.
is simply added to the username <username>@<relam>.
@ -217,8 +216,7 @@ Enable the account (default). You can set this to '0' to disable the accout
`-expire` `integer (0 - N)` :: `-expire` `integer (0 - N)` ::
Account expiration date (seconds since epoch). '0' means no expiration Account expiration date (seconds since epoch). '0' means no expiration date.
date.
`-firstname` `string` :: `-firstname` `string` ::
@ -280,8 +278,7 @@ Enable/disable the account.
`-expire` `integer (0 - N)` :: `-expire` `integer (0 - N)` ::
Account expiration date (seconds since epoch). '0' means no expiration Account expiration date (seconds since epoch). '0' means no expiration date.
date.
`-firstname` `string` :: `-firstname` `string` ::

353
qm.1-synopsis.adoc
View File

@ -24,8 +24,7 @@ NOTE: Requires option(s): `full`
`-full` `boolean` (default=`0`):: `-full` `boolean` (default=`0`)::
Create a full copy of all disk. This is always done when you clone a normal Create a full copy of all disk. This is always done when you clone a normal VM. For VM templates, we try to create a linked clone by default.
VM. For VM templates, we try to create a linked clone by default.
`-name` `string` :: `-name` `string` ::
@ -88,11 +87,7 @@ The backup file.
`-args` `string` :: `-args` `string` ::
Arbitrary arguments passed to kvm, for example: Arbitrary arguments passed to kvm.
+
args: -no-reboot -no-hpet
+
NOTE: this option is for experts only.
`-autostart` `boolean` (default=`0`):: `-autostart` `boolean` (default=`0`)::
@ -100,8 +95,7 @@ Automatic restart after crash (currently ignored).
`-balloon` `integer (0 - N)` :: `-balloon` `integer (0 - N)` ::
Amount of target RAM for the VM in MB. Using zero disables the ballon Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
driver.
`-bios` `(ovmf | seabios)` (default=`seabios`):: `-bios` `(ovmf | seabios)` (default=`seabios`)::
@ -130,22 +124,14 @@ Emulated CPU type.
`-cpulimit` `number (0 - 128)` (default=`0`):: `-cpulimit` `number (0 - 128)` (default=`0`)::
Limit of CPU usage. Limit of CPU usage.
+
NOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0'
indicates no CPU limit.
`-cpuunits` `integer (0 - 500000)` (default=`1000`):: `-cpuunits` `integer (0 - 500000)` (default=`1000`)::
CPU weight for a VM. Argument is used in the kernel fair scheduler. The CPU weight for a VM.
larger the number is, the more CPU time this VM gets. Number is relative to
weights of all the other running VMs.
+
NOTE: You can disable fair-scheduler configuration by setting this to 0.
`-description` `string` :: `-description` `string` ::
Description for the VM. Only used on the configuration web interface. This Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
is saved as comment inside the configuration file.
`-force` `boolean` :: `-force` `boolean` ::
@ -159,26 +145,11 @@ Freeze CPU at startup (use 'c' monitor command to start execution).
`-hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]` :: `-hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]` ::
Map host pci devices. HOSTPCIDEVICE syntax is: Map host PCI devices into guest.
+
'bus:dev.func' (hexadecimal numbers)
+
You can us the 'lspci' command to list existing pci devices.
+
The 'rombar' option determines whether or not the device's ROM will be
visible in the guest's memory map (default is 'on').
+
NOTE: This option allows direct access to host hardware. So it is no longer
possible to migrate such machines - use with special care.
+
Experimental: user reported problems with this option.
`-hotplug` `string` (default=`network,disk,usb`):: `-hotplug` `string` (default=`network,disk,usb`)::
Selectively enable hotplug features. This is a comma separated list of Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to disable hotplug completely. Value '1' is an alias for the default 'network,disk,usb'.
hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to
disable hotplug completely. Value '1' is an alias for the default
'network,disk,usb'.
`-ide[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<image format>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` :: `-ide[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<image format>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
@ -186,8 +157,7 @@ Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
`-keyboard` `(da | de | de-ch | 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 | sl | sv | tr)` (default=`en-us`):: `-keyboard` `(da | de | de-ch | 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 | sl | sv | tr)` (default=`en-us`)::
Keybord layout for vnc server. Default is read from the datacenter Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.
configuration file.
`-kvm` `boolean` (default=`1`):: `-kvm` `boolean` (default=`1`)::
@ -195,8 +165,7 @@ Enable/disable KVM hardware virtualization.
`-localtime` `boolean` :: `-localtime` `boolean` ::
Set the real time clock to local time. This is enabled by default if ostype Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
indicates a Microsoft OS.
`-lock` `(backup | migrate | rollback | snapshot)` :: `-lock` `(backup | migrate | rollback | snapshot)` ::
@ -208,8 +177,7 @@ Specific the Qemu machine type.
`-memory` `integer (16 - N)` (default=`512`):: `-memory` `integer (16 - N)` (default=`512`)::
Amount of RAM for the VM in MB. This is the maximum available memory when Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
you use the balloon device.
`-migrate_downtime` `number (0 - N)` (default=`0.1`):: `-migrate_downtime` `number (0 - N)` (default=`0.1`)::
@ -226,28 +194,6 @@ Set a name for the VM. Only used on the configuration web interface.
`-net[n]` `[model=]<model> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` :: `-net[n]` `[model=]<model> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` ::
Specify network devices. Specify network devices.
+
MODEL is one of: e1000 e1000-82540em e1000-82544gc e1000-82545em i82551
i82557b i82559er ne2k_isa ne2k_pci pcnet rtl8139 virtio vmxnet3
+
XX:XX:XX:XX:XX:XX should be an unique MAC address. This is
automatically generated if not specified.
+
The bridge parameter can be used to automatically add the interface to a
bridge device. The Proxmox VE standard bridge is called 'vmbr0'.
+
Option 'rate' is used to limit traffic bandwidth from and to this
interface. It is specified as floating point number, unit is 'Megabytes per
second'.
+
If you specify no bridge, we create a kvm 'user' (NATed) network device,
which provides DHCP and DNS services. The following addresses are used:
+
10.0.2.2 Gateway
10.0.2.3 DNS Server
10.0.2.4 SMB Server
+
The DHCP server assign addresses to the guest starting from 10.0.2.15.
`-numa` `boolean` (default=`0`):: `-numa` `boolean` (default=`0`)::
@ -255,7 +201,7 @@ Enable/disable NUMA.
`-numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` :: `-numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
numa topology NUMA topology.
`-onboot` `boolean` (default=`0`):: `-onboot` `boolean` (default=`0`)::
@ -263,32 +209,11 @@ Specifies whether a VM will be started during system bootup.
`-ostype` `(l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win7 | win8 | wvista | wxp)` :: `-ostype` `(l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win7 | win8 | wvista | wxp)` ::
Used to enable special optimization/features for specific Specify guest operating system.
operating systems:
+
other => unspecified OS
wxp => Microsoft Windows XP
w2k => Microsoft Windows 2000
w2k3 => Microsoft Windows 2003
w2k8 => Microsoft Windows 2008
wvista => Microsoft Windows Vista
win7 => Microsoft Windows 7
win8 => Microsoft Windows 8/2012
l24 => Linux 2.4 Kernel
l26 => Linux 2.6/3.X Kernel
solaris => solaris/opensolaris/openindiania kernel
+
other|l24|l26|solaris ... no special behaviour
wxp|w2k|w2k3|w2k8|wvista|win7|win8 ... use --localtime switch
`-parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` :: `-parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
Map host parallel devices (n is 0 to 2). Map host parallel devices (n is 0 to 2).
+
NOTE: This option allows direct access to host hardware. So it is no longer
possible to migrate such machines - use with special care.
+
Experimental: user reported problems with this option.
`-pool` `string` :: `-pool` `string` ::
@ -296,7 +221,7 @@ Add the VM to the specified pool.
`-protection` `boolean` (default=`0`):: `-protection` `boolean` (default=`0`)::
Sets the protection flag of the VM. This will prevent the remove operation. Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
`-reboot` `boolean` (default=`1`):: `-reboot` `boolean` (default=`1`)::
@ -312,24 +237,15 @@ Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
`-scsihw` `(lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single)` (default=`lsi`):: `-scsihw` `(lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single)` (default=`lsi`)::
scsi controller model SCSI controller model
`-serial[n]` `(/dev/.+|socket)` :: `-serial[n]` `(/dev/.+|socket)` ::
Create a serial device inside the VM (n is 0 to 3), and pass through a host Create a serial device inside the VM (n is 0 to 3)
serial device (i.e. /dev/ttyS0), or create a unix socket on the host side
(use 'qm terminal' to open a terminal connection).
+
NOTE: If you pass through a host serial device, it is no longer possible to
migrate such machines - use with special care.
+
Experimental: user reported problems with this option.
`-shares` `integer (0 - 50000)` (default=`1000`):: `-shares` `integer (0 - 50000)` (default=`1000`)::
Amount of memory shares for auto-ballooning. The larger the number is, the 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
more memory this VM gets. Number is relative to weights of all other
running VMs. Using zero disables auto-ballooning
`-smbios1` `[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` :: `-smbios1` `[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` ::
@ -345,15 +261,11 @@ The number of CPU sockets.
`-startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` (default=`now`):: `-startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` (default=`now`)::
Set the initial date of the real time clock. Valid format for date are: 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'.
'now' or '2006-06-17T16:01:21' or '2006-06-17'.
`-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` :: `-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
Startup and shutdown behavior. Order is a non-negative number defining the 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.
general startup order. Shutdown in done with reverse ordering. Additionally
you can set the 'up' or 'down' delay in seconds, which specifies a delay to
wait before the next VM is started or stopped.
`-storage` `string` :: `-storage` `string` ::
@ -361,11 +273,7 @@ Default storage.
`-tablet` `boolean` (default=`1`):: `-tablet` `boolean` (default=`1`)::
Enable/disable the USB tablet device. This device is usually needed to Enable/disable the USB tablet device.
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 (-vga=qxl).
`-tdf` `boolean` (default=`0`):: `-tdf` `boolean` (default=`0`)::
@ -383,27 +291,11 @@ NOTE: Requires option(s): `archive`
`-unused[n]` `string` :: `-unused[n]` `string` ::
Reference to unused volumes. Reference to unused volumes. This is used internally, and should not be modified manually.
`-usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` :: `-usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
Configure an USB device (n is 0 to 4). This can be used to Configure an USB device (n is 0 to 4).
pass-through usb devices to the guest. HOSTUSBDEVICE syntax is:
+
'bus-port(.port)*' (decimal numbers) or
'vendor_id:product_id' (hexadeciaml numbers) or
'spice'
+
You can use the 'lsusb -t' command to list existing usb devices.
+
NOTE: This option allows direct access to host hardware. So it is no longer
possible to migrate such machines - use with special care.
+
The value 'spice' can be used to add a usb redirection devices for spice.
+
The 'usb3' option determines whether the device is a USB3 device or not
(this does currently not work reliably with spice redirection and is then
ignored).
`-vcpus` `integer (1 - N)` (default=`0`):: `-vcpus` `integer (1 - N)` (default=`0`)::
@ -411,12 +303,7 @@ Number of hotplugged vcpus.
`-vga` `(cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware)` :: `-vga` `(cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware)` ::
Select the VGA type. If you want to use high resolution modes (>= Select the VGA type.
1280x1024x16) then you should use the options 'std' or 'vmware'. Default is
'std' for win8/win7/w2k8, and 'cirrus' for other OS types. The 'qxl' option
enables the SPICE display sever. For win* OS you can select how many
independent displays you want, Linux guests can add displays them self. You
can also run without any graphic card, using a serial device as terminal.
`-virtio[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<image format>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,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>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` :: `-virtio[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<image format>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,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>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
@ -424,10 +311,7 @@ Use volume as VIRTIO hard disk (n is 0 to 15).
`-watchdog` `[[model=]<i6300esb|ib700>] [,action=<reset|shutdown|poweroff|pause|debug|none>]` :: `-watchdog` `[[model=]<i6300esb|ib700>] [,action=<reset|shutdown|poweroff|pause|debug|none>]` ::
Create a virtual hardware watchdog device. Once enabled (by a guest Create a virtual hardware watchdog device.
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)
@ -503,8 +387,7 @@ Target node.
`-force` `boolean` :: `-force` `boolean` ::
Allow to migrate VMs which use local devices. Only root may use this Allow to migrate VMs which use local devices. Only root may use this option.
option.
`-online` `boolean` :: `-online` `boolean` ::
@ -542,13 +425,11 @@ Target storage.
`-delete` `boolean` (default=`0`):: `-delete` `boolean` (default=`0`)::
Delete the original disk after successful copy. By default the original Delete the original disk after successful copy. By default the original disk is kept as unused disk.
disk is kept as unused disk.
`-digest` `string` :: `-digest` `string` ::
Prevent changes if current configuration file has different SHA1 digest. Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
This can be used to prevent concurrent modifications.
`-format` `(qcow2 | raw | vmdk)` :: `-format` `(qcow2 | raw | vmdk)` ::
@ -614,14 +495,11 @@ The disk you want to resize.
`<size>` `\+?\d+(\.\d+)?[KMGT]?` :: `<size>` `\+?\d+(\.\d+)?[KMGT]?` ::
The new size. With the '+' sign the value is added to the actual size of 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.
the volume and without it, the value is taken as an absolute one. Shrinking
disk size is not supported.
`-digest` `string` :: `-digest` `string` ::
Prevent changes if current configuration file has different SHA1 digest. Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
This can be used to prevent concurrent modifications.
`-skiplock` `boolean` :: `-skiplock` `boolean` ::
@ -699,11 +577,7 @@ Enable/disable Qemu GuestAgent.
`-args` `string` :: `-args` `string` ::
Arbitrary arguments passed to kvm, for example: Arbitrary arguments passed to kvm.
+
args: -no-reboot -no-hpet
+
NOTE: this option is for experts only.
`-autostart` `boolean` (default=`0`):: `-autostart` `boolean` (default=`0`)::
@ -711,8 +585,7 @@ Automatic restart after crash (currently ignored).
`-balloon` `integer (0 - N)` :: `-balloon` `integer (0 - N)` ::
Amount of target RAM for the VM in MB. Using zero disables the ballon Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
driver.
`-bios` `(ovmf | seabios)` (default=`seabios`):: `-bios` `(ovmf | seabios)` (default=`seabios`)::
@ -741,17 +614,10 @@ Emulated CPU type.
`-cpulimit` `number (0 - 128)` (default=`0`):: `-cpulimit` `number (0 - 128)` (default=`0`)::
Limit of CPU usage. Limit of CPU usage.
+
NOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0'
indicates no CPU limit.
`-cpuunits` `integer (0 - 500000)` (default=`1000`):: `-cpuunits` `integer (0 - 500000)` (default=`1000`)::
CPU weight for a VM. Argument is used in the kernel fair scheduler. The CPU weight for a VM.
larger the number is, the more CPU time this VM gets. Number is relative to
weights of all the other running VMs.
+
NOTE: You can disable fair-scheduler configuration by setting this to 0.
`-delete` `string` :: `-delete` `string` ::
@ -759,20 +625,15 @@ A list of settings you want to delete.
`-description` `string` :: `-description` `string` ::
Description for the VM. Only used on the configuration web interface. This Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
is saved as comment inside the configuration file.
`-digest` `string` :: `-digest` `string` ::
Prevent changes if current configuration file has different SHA1 digest. Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
This can be used to prevent concurrent modifications.
`-force` `boolean` :: `-force` `boolean` ::
Force physical removal. Without this, we simple remove the disk from the 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.
config file and create an additional configuration entry called
'unused[n]', which contains the volume ID. Unlink of unused[n] always cause
physical removal.
+ +
NOTE: Requires option(s): `delete` NOTE: Requires option(s): `delete`
@ -782,26 +643,11 @@ Freeze CPU at startup (use 'c' monitor command to start execution).
`-hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]` :: `-hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]` ::
Map host pci devices. HOSTPCIDEVICE syntax is: Map host PCI devices into guest.
+
'bus:dev.func' (hexadecimal numbers)
+
You can us the 'lspci' command to list existing pci devices.
+
The 'rombar' option determines whether or not the device's ROM will be
visible in the guest's memory map (default is 'on').
+
NOTE: This option allows direct access to host hardware. So it is no longer
possible to migrate such machines - use with special care.
+
Experimental: user reported problems with this option.
`-hotplug` `string` (default=`network,disk,usb`):: `-hotplug` `string` (default=`network,disk,usb`)::
Selectively enable hotplug features. This is a comma separated list of Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to disable hotplug completely. Value '1' is an alias for the default 'network,disk,usb'.
hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to
disable hotplug completely. Value '1' is an alias for the default
'network,disk,usb'.
`-ide[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<image format>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` :: `-ide[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<image format>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
@ -809,8 +655,7 @@ Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
`-keyboard` `(da | de | de-ch | 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 | sl | sv | tr)` (default=`en-us`):: `-keyboard` `(da | de | de-ch | 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 | sl | sv | tr)` (default=`en-us`)::
Keybord layout for vnc server. Default is read from the datacenter Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.
configuration file.
`-kvm` `boolean` (default=`1`):: `-kvm` `boolean` (default=`1`)::
@ -818,8 +663,7 @@ Enable/disable KVM hardware virtualization.
`-localtime` `boolean` :: `-localtime` `boolean` ::
Set the real time clock to local time. This is enabled by default if ostype Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
indicates a Microsoft OS.
`-lock` `(backup | migrate | rollback | snapshot)` :: `-lock` `(backup | migrate | rollback | snapshot)` ::
@ -831,8 +675,7 @@ Specific the Qemu machine type.
`-memory` `integer (16 - N)` (default=`512`):: `-memory` `integer (16 - N)` (default=`512`)::
Amount of RAM for the VM in MB. This is the maximum available memory when Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
you use the balloon device.
`-migrate_downtime` `number (0 - N)` (default=`0.1`):: `-migrate_downtime` `number (0 - N)` (default=`0.1`)::
@ -849,28 +692,6 @@ Set a name for the VM. Only used on the configuration web interface.
`-net[n]` `[model=]<model> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` :: `-net[n]` `[model=]<model> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` ::
Specify network devices. Specify network devices.
+
MODEL is one of: e1000 e1000-82540em e1000-82544gc e1000-82545em i82551
i82557b i82559er ne2k_isa ne2k_pci pcnet rtl8139 virtio vmxnet3
+
XX:XX:XX:XX:XX:XX should be an unique MAC address. This is
automatically generated if not specified.
+
The bridge parameter can be used to automatically add the interface to a
bridge device. The Proxmox VE standard bridge is called 'vmbr0'.
+
Option 'rate' is used to limit traffic bandwidth from and to this
interface. It is specified as floating point number, unit is 'Megabytes per
second'.
+
If you specify no bridge, we create a kvm 'user' (NATed) network device,
which provides DHCP and DNS services. The following addresses are used:
+
10.0.2.2 Gateway
10.0.2.3 DNS Server
10.0.2.4 SMB Server
+
The DHCP server assign addresses to the guest starting from 10.0.2.15.
`-numa` `boolean` (default=`0`):: `-numa` `boolean` (default=`0`)::
@ -878,7 +699,7 @@ Enable/disable NUMA.
`-numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` :: `-numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
numa topology NUMA topology.
`-onboot` `boolean` (default=`0`):: `-onboot` `boolean` (default=`0`)::
@ -886,36 +707,15 @@ Specifies whether a VM will be started during system bootup.
`-ostype` `(l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win7 | win8 | wvista | wxp)` :: `-ostype` `(l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win7 | win8 | wvista | wxp)` ::
Used to enable special optimization/features for specific Specify guest operating system.
operating systems:
+
other => unspecified OS
wxp => Microsoft Windows XP
w2k => Microsoft Windows 2000
w2k3 => Microsoft Windows 2003
w2k8 => Microsoft Windows 2008
wvista => Microsoft Windows Vista
win7 => Microsoft Windows 7
win8 => Microsoft Windows 8/2012
l24 => Linux 2.4 Kernel
l26 => Linux 2.6/3.X Kernel
solaris => solaris/opensolaris/openindiania kernel
+
other|l24|l26|solaris ... no special behaviour
wxp|w2k|w2k3|w2k8|wvista|win7|win8 ... use --localtime switch
`-parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` :: `-parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
Map host parallel devices (n is 0 to 2). Map host parallel devices (n is 0 to 2).
+
NOTE: This option allows direct access to host hardware. So it is no longer
possible to migrate such machines - use with special care.
+
Experimental: user reported problems with this option.
`-protection` `boolean` (default=`0`):: `-protection` `boolean` (default=`0`)::
Sets the protection flag of the VM. This will prevent the remove operation. Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
`-reboot` `boolean` (default=`1`):: `-reboot` `boolean` (default=`1`)::
@ -935,24 +735,15 @@ Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
`-scsihw` `(lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single)` (default=`lsi`):: `-scsihw` `(lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single)` (default=`lsi`)::
scsi controller model SCSI controller model
`-serial[n]` `(/dev/.+|socket)` :: `-serial[n]` `(/dev/.+|socket)` ::
Create a serial device inside the VM (n is 0 to 3), and pass through a host Create a serial device inside the VM (n is 0 to 3)
serial device (i.e. /dev/ttyS0), or create a unix socket on the host side
(use 'qm terminal' to open a terminal connection).
+
NOTE: If you pass through a host serial device, it is no longer possible to
migrate such machines - use with special care.
+
Experimental: user reported problems with this option.
`-shares` `integer (0 - 50000)` (default=`1000`):: `-shares` `integer (0 - 50000)` (default=`1000`)::
Amount of memory shares for auto-ballooning. The larger the number is, the 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
more memory this VM gets. Number is relative to weights of all other
running VMs. Using zero disables auto-ballooning
`-skiplock` `boolean` :: `-skiplock` `boolean` ::
@ -972,23 +763,15 @@ The number of CPU sockets.
`-startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` (default=`now`):: `-startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` (default=`now`)::
Set the initial date of the real time clock. Valid format for date are: 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'.
'now' or '2006-06-17T16:01:21' or '2006-06-17'.
`-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` :: `-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
Startup and shutdown behavior. Order is a non-negative number defining the 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.
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.
`-tablet` `boolean` (default=`1`):: `-tablet` `boolean` (default=`1`)::
Enable/disable the USB tablet device. This device is usually needed to Enable/disable the USB tablet device.
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 (-vga=qxl).
`-tdf` `boolean` (default=`0`):: `-tdf` `boolean` (default=`0`)::
@ -1000,27 +783,11 @@ Enable/disable Template.
`-unused[n]` `string` :: `-unused[n]` `string` ::
Reference to unused volumes. Reference to unused volumes. This is used internally, and should not be modified manually.
`-usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` :: `-usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
Configure an USB device (n is 0 to 4). This can be used to Configure an USB device (n is 0 to 4).
pass-through usb devices to the guest. HOSTUSBDEVICE syntax is:
+
'bus-port(.port)*' (decimal numbers) or
'vendor_id:product_id' (hexadeciaml numbers) or
'spice'
+
You can use the 'lsusb -t' command to list existing usb devices.
+
NOTE: This option allows direct access to host hardware. So it is no longer
possible to migrate such machines - use with special care.
+
The value 'spice' can be used to add a usb redirection devices for spice.
+
The 'usb3' option determines whether the device is a USB3 device or not
(this does currently not work reliably with spice redirection and is then
ignored).
`-vcpus` `integer (1 - N)` (default=`0`):: `-vcpus` `integer (1 - N)` (default=`0`)::
@ -1028,12 +795,7 @@ Number of hotplugged vcpus.
`-vga` `(cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware)` :: `-vga` `(cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware)` ::
Select the VGA type. If you want to use high resolution modes (>= Select the VGA type.
1280x1024x16) then you should use the options 'std' or 'vmware'. Default is
'std' for win8/win7/w2k8, and 'cirrus' for other OS types. The 'qxl' option
enables the SPICE display sever. For win* OS you can select how many
independent displays you want, Linux guests can add displays them self. You
can also run without any graphic card, using a serial device as terminal.
`-virtio[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<image format>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,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>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` :: `-virtio[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<image format>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,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>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
@ -1041,10 +803,7 @@ Use volume as VIRTIO hard disk (n is 0 to 15).
`-watchdog` `[[model=]<i6300esb|ib700>] [,action=<reset|shutdown|poweroff|pause|debug|none>]` :: `-watchdog` `[[model=]<i6300esb|ib700>] [,action=<reset|shutdown|poweroff|pause|debug|none>]` ::
Create a virtual hardware watchdog device. Once enabled (by a guest Create a virtual hardware watchdog device.
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)
@ -1219,8 +978,7 @@ The (unique) ID of the VM.
`-iface` `(serial0 | serial1 | serial2 | serial3)` :: `-iface` `(serial0 | serial1 | serial2 | serial3)` ::
Select the serial device. By default we simply use the first suitable Select the serial device. By default we simply use the first suitable device.
device.
@ -1235,10 +993,7 @@ The (unique) ID of the VM.
`-force` `boolean` :: `-force` `boolean` ::
Force physical removal. Without this, we simple remove the disk from the 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.
config file and create an additional configuration entry called
'unused[n]', which contains the volume ID. Unlink of unused[n] always cause
physical removal.
`-idlist` `string` :: `-idlist` `string` ::

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

@ -20,8 +20,7 @@ Automatic restart after crash (currently ignored).
`balloon`: `integer (0 - N)` :: `balloon`: `integer (0 - N)` ::
Amount of target RAM for the VM in MB. Using zero disables the ballon Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
driver.
`bios`: `(ovmf | seabios)` (default=`seabios`):: `bios`: `(ovmf | seabios)` (default=`seabios`)::
@ -47,25 +46,29 @@ The number of cores per socket.
Emulated CPU type. Emulated CPU type.
`cputype`=`<cputype>` (default=`kvm64`);;
Emulated CPU type.
`hidden`=`boolean` (default=`0`);;
Do not identify as a KVM virtual machine.
`cpulimit`: `number (0 - 128)` (default=`0`):: `cpulimit`: `number (0 - 128)` (default=`0`)::
Limit of CPU usage. Limit of CPU usage.
+ +
NOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' NOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit.
indicates no CPU limit.
`cpuunits`: `integer (0 - 500000)` (default=`1000`):: `cpuunits`: `integer (0 - 500000)` (default=`1000`)::
CPU weight for a VM. Argument is used in the kernel fair scheduler. The 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.
larger the number is, the more CPU time this VM gets. Number is relative to
weights of all the other running VMs.
+ +
NOTE: You can disable fair-scheduler configuration by setting this to 0. NOTE: You can disable fair-scheduler configuration by setting this to 0.
`description`: `string` :: `description`: `string` ::
Description for the VM. Only used on the configuration web interface. This Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
is saved as comment inside the configuration file.
`freeze`: `boolean` :: `freeze`: `boolean` ::
@ -73,35 +76,177 @@ Freeze CPU at startup (use 'c' monitor command to start execution).
`hostpci[n]`: `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]` :: `hostpci[n]`: `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]` ::
Map host pci devices. HOSTPCIDEVICE syntax is: Map host PCI devices into guest.
`host`=`<HOSTPCIID[;HOSTPCIID2...]>` ;;
Host PCI device pass through. The PCI ID of a host's PCI device or a list
of PCI virtual functions of the host. HOSTPCIID syntax is:
+ +
'bus:dev.func' (hexadecimal numbers) 'bus:dev.func' (hexadecimal numbers)
+ +
You can us the 'lspci' command to list existing pci devices. You can us the 'lspci' command to list existing PCI devices.
+
The 'rombar' option determines whether or not the device's ROM will be
visible in the guest's memory map (default is 'on').
+ +
NOTE: This option allows direct access to host hardware. So it is no longer NOTE: This option allows direct access to host hardware. So it is no longer
possible to migrate such machines - use with special care. possible to migrate such machines - use with special care.
+ +
Experimental: user reported problems with this option. CAUTION: Experimental! User reported problems with this option.
`pcie`=`boolean` (default=`0`);;
Choose the PCI-express bus (needs the 'q35' machine model).
`rombar`=`boolean` (default=`1`);;
Specify whether or not the device's ROM will be visible in the guest's memory map.
`x-vga`=`boolean` (default=`0`);;
Enable vfio-vga device support.
`hotplug`: `string` (default=`network,disk,usb`):: `hotplug`: `string` (default=`network,disk,usb`)::
Selectively enable hotplug features. This is a comma separated list of Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to disable hotplug completely. Value '1' is an alias for the default 'network,disk,usb'.
hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to
disable hotplug completely. Value '1' is an alias for the default
'network,disk,usb'.
`ide[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<image format>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` :: `ide[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<image format>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
`aio`=`(native | threads)` ;;
AIO type to use.
`backup`=`boolean` ;;
Whether the drive should be included when making backups.
`bps`=`<bps>` ;;
Maximum r/w speed speed in bytes per second.
`bps_rd`=`<bps>` ;;
Maximum read speed speed in bytes per second.
`bps_wr`=`<bps>` ;;
Maximum write speed speed in bytes per second.
`cache`=`(directsync | none | unsafe | writeback | writethrough)` ;;
The drive's cache mode
`cyls`=`integer` ;;
Force the drive's physical geometry to have a specific cylinder count.
`detect_zeroes`=`boolean` ;;
Controls whether to detect and try to optimize writes of zeroes.
`discard`=`(ignore | on)` ;;
Controls whether to pass discard/trim requests to the underlying storage.
`file`=`<volume>` ;;
The drive's backing volume.
`format`=`<image format>` ;;
The drive's backing file's data format.
`heads`=`integer` ;;
Force the drive's physical geometry to have a specific head count.
`iops`=`<iops>` ;;
Maximum r/w I/O speed in operations per second.
`iops_max`=`<iops>` ;;
Maximum unthrottled r/w I/O pool speed in operations per second.
`iops_rd`=`<iops>` ;;
Maximum read I/O speed in operations per second.
`iops_rd_max`=`<iops>` ;;
Maximum unthrottled read I/O pool speed in operations per second.
`iops_wr`=`<iops>` ;;
Maximum write I/O speed in operations per second.
`iops_wr_max`=`<iops>` ;;
Maximum unthrottled write I/O pool speed in operations per second.
`mbps`=`<mbps>` ;;
Maximum r/w speed speed in megabytes per second.
`mbps_max`=`<mbps>` ;;
Maximum unthrottled r/w pool speed in megabytes per second.
`mbps_rd`=`<mbps>` ;;
Maximum read speed speed in megabytes per second.
`mbps_rd_max`=`<mbps>` ;;
Maximum unthrottled read pool speed in megabytes per second.
`mbps_wr`=`<mbps>` ;;
Maximum write speed speed in megabytes per second.
`mbps_wr_max`=`<mbps>` ;;
Maximum unthrottled write pool speed in megabytes per second.
`media`=`(cdrom | disk)` (default=`disk`);;
The drive's media type.
`model`=`<model>` ;;
The drive's reported model name, url-encoded, up to 40 bytes long.
`rerror`=`(ignore | report | stop)` ;;
Read error action.
`secs`=`integer` ;;
Force the drive's physical geometry to have a specific sector count.
`serial`=`<serial>` ;;
The drive's reported serial number, url-encoded, up to 20 bytes long.
`size`=`<DiskSize>` ;;
Disk size. This is purely informational and has no effect.
`snapshot`=`boolean` ;;
Whether the drive should be included when making snapshots.
`trans`=`(auto | lba | none)` ;;
Force disk geometry bios translation mode.
`werror`=`(enospc | ignore | report | stop)` ;;
Write error action.
`keyboard`: `(da | de | de-ch | 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 | sl | sv | tr)` (default=`en-us`):: `keyboard`: `(da | de | de-ch | 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 | sl | sv | tr)` (default=`en-us`)::
Keybord layout for vnc server. Default is read from the datacenter Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.
configuration file.
`kvm`: `boolean` (default=`1`):: `kvm`: `boolean` (default=`1`)::
@ -109,8 +254,7 @@ Enable/disable KVM hardware virtualization.
`localtime`: `boolean` :: `localtime`: `boolean` ::
Set the real time clock to local time. This is enabled by default if ostype Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
indicates a Microsoft OS.
`lock`: `(backup | migrate | rollback | snapshot)` :: `lock`: `(backup | migrate | rollback | snapshot)` ::
@ -122,8 +266,7 @@ Specific the Qemu machine type.
`memory`: `integer (16 - N)` (default=`512`):: `memory`: `integer (16 - N)` (default=`512`)::
Amount of RAM for the VM in MB. This is the maximum available memory when Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
you use the balloon device.
`migrate_downtime`: `number (0 - N)` (default=`0.1`):: `migrate_downtime`: `number (0 - N)` (default=`0.1`)::
@ -140,22 +283,15 @@ Set a name for the VM. Only used on the configuration web interface.
`net[n]`: `[model=]<model> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` :: `net[n]`: `[model=]<model> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` ::
Specify network devices. Specify network devices.
`bridge`=`<bridge>` ;;
Bridge to attach the network device to. The Proxmox VE standard bridge
is called 'vmbr0'.
+ +
MODEL is one of: e1000 e1000-82540em e1000-82544gc e1000-82545em i82551 If you do not specify a bridge, we create a kvm user (NATed) network
i82557b i82559er ne2k_isa ne2k_pci pcnet rtl8139 virtio vmxnet3 device, which provides DHCP and DNS services. The following addresses
+ are used:
XX:XX:XX:XX:XX:XX should be an unique MAC address. This is
automatically generated if not specified.
+
The bridge parameter can be used to automatically add the interface to a
bridge device. The Proxmox VE standard bridge is called 'vmbr0'.
+
Option 'rate' is used to limit traffic bandwidth from and to this
interface. It is specified as floating point number, unit is 'Megabytes per
second'.
+
If you specify no bridge, we create a kvm 'user' (NATed) network device,
which provides DHCP and DNS services. The following addresses are used:
+ +
10.0.2.2 Gateway 10.0.2.2 Gateway
10.0.2.3 DNS Server 10.0.2.3 DNS Server
@ -163,13 +299,61 @@ which provides DHCP and DNS services. The following addresses are used:
+ +
The DHCP server assign addresses to the guest starting from 10.0.2.15. The DHCP server assign addresses to the guest starting from 10.0.2.15.
`firewall`=`boolean` ;;
Whether this interface should be protected by the firewall.
`link_down`=`boolean` ;;
Whether this interface should be disconnected (like pulling the plug).
`macaddr`=`<XX:XX:XX:XX:XX:XX>` ;;
MAC address. That address must be unique withing your network. This is automatically generated if not specified.
`model`=`<model>` ;;
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'.
`queues`=`integer (0 - 16)` ;;
Number of packet queues to be used on the device.
`rate`=`number (0 - N)` ;;
Rate limit in mbps (megabytes per second) as floating point number.
`tag`=`integer (1 - 4094)` ;;
VLAN tag to apply to packets on this interface.
`trunks`=`<vlanid[;vlanid...]>` ;;
VLAN trunks to pass through this interface.
`numa`: `boolean` (default=`0`):: `numa`: `boolean` (default=`0`)::
Enable/disable NUMA. Enable/disable NUMA.
`numa[n]`: `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` :: `numa[n]`: `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
numa topology NUMA topology.
`cpus`=`<id[-id];...>` ;;
CPUs accessing this NUMA node.
`hostnodes`=`<id[-id];...>` ;;
Host NUMA nodes to use.
`memory`=`number` ;;
Amount of memory this NUMA node provides.
`policy`=`(bind | interleave | preferred)` ;;
NUMA allocation policy.
`onboot`: `boolean` (default=`0`):: `onboot`: `boolean` (default=`0`)::
@ -177,36 +361,33 @@ Specifies whether a VM will be started during system bootup.
`ostype`: `(l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win7 | win8 | wvista | wxp)` :: `ostype`: `(l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win7 | win8 | wvista | wxp)` ::
Used to enable special optimization/features for specific Specify guest operating system. This is used to enable special
operating systems: optimization/features for specific operating systems:
+ +
other => unspecified OS [horizontal]
wxp => Microsoft Windows XP other;; unspecified OS
w2k => Microsoft Windows 2000 wxp;; Microsoft Windows XP
w2k3 => Microsoft Windows 2003 w2k;; Microsoft Windows 2000
w2k8 => Microsoft Windows 2008 w2k3;; Microsoft Windows 2003
wvista => Microsoft Windows Vista w2k8;; Microsoft Windows 2008
win7 => Microsoft Windows 7 wvista;; Microsoft Windows Vista
win8 => Microsoft Windows 8/2012 win7;; Microsoft Windows 7
l24 => Linux 2.4 Kernel win8;; Microsoft Windows 8/2012
l26 => Linux 2.6/3.X Kernel l24;; Linux 2.4 Kernel
solaris => solaris/opensolaris/openindiania kernel l26;; Linux 2.6/3.X Kernel
+ solaris;; Solaris/OpenSolaris/OpenIndiania kernel
other|l24|l26|solaris ... no special behaviour
wxp|w2k|w2k3|w2k8|wvista|win7|win8 ... use --localtime switch
`parallel[n]`: `/dev/parport\d+|/dev/usb/lp\d+` :: `parallel[n]`: `/dev/parport\d+|/dev/usb/lp\d+` ::
Map host parallel devices (n is 0 to 2). Map host parallel devices (n is 0 to 2).
+ +
NOTE: This option allows direct access to host hardware. So it is no longer NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.
possible to migrate such machines - use with special care.
+ +
Experimental: user reported problems with this option. CAUTION: Experimental! User reported problems with this option.
`protection`: `boolean` (default=`0`):: `protection`: `boolean` (default=`0`)::
Sets the protection flag of the VM. This will prevent the remove operation. Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
`reboot`: `boolean` (default=`1`):: `reboot`: `boolean` (default=`1`)::
@ -216,35 +397,321 @@ Allow reboot. If set to '0' the VM exit on reboot.
Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
`aio`=`(native | threads)` ;;
AIO type to use.
`backup`=`boolean` ;;
Whether the drive should be included when making backups.
`bps`=`<bps>` ;;
Maximum r/w speed speed in bytes per second.
`bps_rd`=`<bps>` ;;
Maximum read speed speed in bytes per second.
`bps_wr`=`<bps>` ;;
Maximum write speed speed in bytes per second.
`cache`=`(directsync | none | unsafe | writeback | writethrough)` ;;
The drive's cache mode
`cyls`=`integer` ;;
Force the drive's physical geometry to have a specific cylinder count.
`detect_zeroes`=`boolean` ;;
Controls whether to detect and try to optimize writes of zeroes.
`discard`=`(ignore | on)` ;;
Controls whether to pass discard/trim requests to the underlying storage.
`file`=`<volume>` ;;
The drive's backing volume.
`format`=`<image format>` ;;
The drive's backing file's data format.
`heads`=`integer` ;;
Force the drive's physical geometry to have a specific head count.
`iops`=`<iops>` ;;
Maximum r/w I/O speed in operations per second.
`iops_max`=`<iops>` ;;
Maximum unthrottled r/w I/O pool speed in operations per second.
`iops_rd`=`<iops>` ;;
Maximum read I/O speed in operations per second.
`iops_rd_max`=`<iops>` ;;
Maximum unthrottled read I/O pool speed in operations per second.
`iops_wr`=`<iops>` ;;
Maximum write I/O speed in operations per second.
`iops_wr_max`=`<iops>` ;;
Maximum unthrottled write I/O pool speed in operations per second.
`mbps`=`<mbps>` ;;
Maximum r/w speed speed in megabytes per second.
`mbps_max`=`<mbps>` ;;
Maximum unthrottled r/w pool speed in megabytes per second.
`mbps_rd`=`<mbps>` ;;
Maximum read speed speed in megabytes per second.
`mbps_rd_max`=`<mbps>` ;;
Maximum unthrottled read pool speed in megabytes per second.
`mbps_wr`=`<mbps>` ;;
Maximum write speed speed in megabytes per second.
`mbps_wr_max`=`<mbps>` ;;
Maximum unthrottled write pool speed in megabytes per second.
`media`=`(cdrom | disk)` (default=`disk`);;
The drive's media type.
`rerror`=`(ignore | report | stop)` ;;
Read error action.
`secs`=`integer` ;;
Force the drive's physical geometry to have a specific sector count.
`serial`=`<serial>` ;;
The drive's reported serial number, url-encoded, up to 20 bytes long.
`size`=`<DiskSize>` ;;
Disk size. This is purely informational and has no effect.
`snapshot`=`boolean` ;;
Whether the drive should be included when making snapshots.
`trans`=`(auto | lba | none)` ;;
Force disk geometry bios translation mode.
`werror`=`(enospc | ignore | report | stop)` ;;
Write error action.
`scsi[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<image format>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,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>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` :: `scsi[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<image format>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,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>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
Use volume as SCSI hard disk or CD-ROM (n is 0 to 13). Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
`aio`=`(native | threads)` ;;
AIO type to use.
`backup`=`boolean` ;;
Whether the drive should be included when making backups.
`bps`=`<bps>` ;;
Maximum r/w speed speed in bytes per second.
`bps_rd`=`<bps>` ;;
Maximum read speed speed in bytes per second.
`bps_wr`=`<bps>` ;;
Maximum write speed speed in bytes per second.
`cache`=`(directsync | none | unsafe | writeback | writethrough)` ;;
The drive's cache mode
`cyls`=`integer` ;;
Force the drive's physical geometry to have a specific cylinder count.
`detect_zeroes`=`boolean` ;;
Controls whether to detect and try to optimize writes of zeroes.
`discard`=`(ignore | on)` ;;
Controls whether to pass discard/trim requests to the underlying storage.
`file`=`<volume>` ;;
The drive's backing volume.
`format`=`<image format>` ;;
The drive's backing file's data format.
`heads`=`integer` ;;
Force the drive's physical geometry to have a specific head count.
`iops`=`<iops>` ;;
Maximum r/w I/O speed in operations per second.
`iops_max`=`<iops>` ;;
Maximum unthrottled r/w I/O pool speed in operations per second.
`iops_rd`=`<iops>` ;;
Maximum read I/O speed in operations per second.
`iops_rd_max`=`<iops>` ;;
Maximum unthrottled read I/O pool speed in operations per second.
`iops_wr`=`<iops>` ;;
Maximum write I/O speed in operations per second.
`iops_wr_max`=`<iops>` ;;
Maximum unthrottled write I/O pool speed in operations per second.
`iothread`=`boolean` ;;
Whether to use iothreads for this drive
`mbps`=`<mbps>` ;;
Maximum r/w speed speed in megabytes per second.
`mbps_max`=`<mbps>` ;;
Maximum unthrottled r/w pool speed in megabytes per second.
`mbps_rd`=`<mbps>` ;;
Maximum read speed speed in megabytes per second.
`mbps_rd_max`=`<mbps>` ;;
Maximum unthrottled read pool speed in megabytes per second.
`mbps_wr`=`<mbps>` ;;
Maximum write speed speed in megabytes per second.
`mbps_wr_max`=`<mbps>` ;;
Maximum unthrottled write pool speed in megabytes per second.
`media`=`(cdrom | disk)` (default=`disk`);;
The drive's media type.
`queues`=`integer (2 - N)` ;;
Number of queues.
`secs`=`integer` ;;
Force the drive's physical geometry to have a specific sector count.
`serial`=`<serial>` ;;
The drive's reported serial number, url-encoded, up to 20 bytes long.
`size`=`<DiskSize>` ;;
Disk size. This is purely informational and has no effect.
`snapshot`=`boolean` ;;
Whether the drive should be included when making snapshots.
`trans`=`(auto | lba | none)` ;;
Force disk geometry bios translation mode.
`werror`=`(enospc | ignore | report | stop)` ;;
Write error action.
`scsihw`: `(lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single)` (default=`lsi`):: `scsihw`: `(lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single)` (default=`lsi`)::
scsi controller model SCSI controller model
`serial[n]`: `(/dev/.+|socket)` :: `serial[n]`: `(/dev/.+|socket)` ::
Create a serial device inside the VM (n is 0 to 3), and pass through a host
serial device (i.e. /dev/ttyS0), or create a unix socket on the host side
(use 'qm terminal' to open a terminal connection).
+ +
NOTE: If you pass through a host serial device, it is no longer possible to Create a serial device inside the VM (n is 0 to 3), and pass through a
migrate such machines - use with special care. host serial device (i.e. /dev/ttyS0), or create a unix socket on the
host side (use 'qm terminal' to open a terminal connection).
+ +
Experimental: user reported problems with this option. NOTE: If you pass through a host serial device, it is no longer possible to migrate such machines - use with special care.
+
CAUTION: Experimental! User reported problems with this option.
`shares`: `integer (0 - 50000)` (default=`1000`):: `shares`: `integer (0 - 50000)` (default=`1000`)::
Amount of memory shares for auto-ballooning. The larger the number is, the 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
more memory this VM gets. Number is relative to weights of all other
running VMs. Using zero disables auto-ballooning
`smbios1`: `[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` :: `smbios1`: `[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` ::
Specify SMBIOS type 1 fields. Specify SMBIOS type 1 fields.
`family`=`<string>` ;;
Set SMBIOS1 family string.
`manufacturer`=`<string>` ;;
Set SMBIOS1 manufacturer.
`product`=`<string>` ;;
Set SMBIOS1 product ID.
`serial`=`<string>` ;;
Set SMBIOS1 serial number.
`sku`=`<string>` ;;
Set SMBIOS1 SKU string.
`uuid`=`<UUID>` ;;
Set SMBIOS1 UUID.
`version`=`<string>` ;;
Set SMBIOS1 version.
`smp`: `integer (1 - N)` (default=`1`):: `smp`: `integer (1 - N)` (default=`1`)::
The number of CPUs. Please use option -sockets instead. The number of CPUs. Please use option -sockets instead.
@ -255,23 +722,15 @@ The number of CPU sockets.
`startdate`: `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` (default=`now`):: `startdate`: `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` (default=`now`)::
Set the initial date of the real time clock. Valid format for date are: 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'.
'now' or '2006-06-17T16:01:21' or '2006-06-17'.
`startup`: `[[order=]\d+] [,up=\d+] [,down=\d+] ` :: `startup`: `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
Startup and shutdown behavior. Order is a non-negative number defining the 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.
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.
`tablet`: `boolean` (default=`1`):: `tablet`: `boolean` (default=`1`)::
Enable/disable the USB tablet device. This device is usually needed to 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 (-vga=qxl).
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 (-vga=qxl).
`tdf`: `boolean` (default=`0`):: `tdf`: `boolean` (default=`0`)::
@ -283,12 +742,15 @@ Enable/disable Template.
`unused[n]`: `string` :: `unused[n]`: `string` ::
Reference to unused volumes. Reference to unused volumes. This is used internally, and should not be modified manually.
`usb[n]`: `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` :: `usb[n]`: `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
Configure an USB device (n is 0 to 4). This can be used to Configure an USB device (n is 0 to 4).
pass-through usb devices to the guest. HOSTUSBDEVICE syntax is:
`host`=`<HOSTUSBDEVICE|spice>` ;;
The Host USB device or port or the value 'spice'. HOSTUSBDEVICE syntax is:
+ +
'bus-port(.port)*' (decimal numbers) or 'bus-port(.port)*' (decimal numbers) or
'vendor_id:product_id' (hexadeciaml numbers) or 'vendor_id:product_id' (hexadeciaml numbers) or
@ -296,14 +758,13 @@ pass-through usb devices to the guest. HOSTUSBDEVICE syntax is:
+ +
You can use the 'lsusb -t' command to list existing usb devices. You can use the 'lsusb -t' command to list existing usb devices.
+ +
NOTE: This option allows direct access to host hardware. So it is no longer NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.
possible to migrate such machines - use with special care.
+ +
The value 'spice' can be used to add a usb redirection devices for spice. The value 'spice' can be used to add a usb redirection devices for spice.
+
The 'usb3' option determines whether the device is a USB3 device or not `usb3`=`boolean` (default=`0`);;
(this does currently not work reliably with spice redirection and is then
ignored). Specifies whether if given host option is a USB3 device or port (this does currently not work reliably with spice redirection and is then ignored).
`vcpus`: `integer (1 - N)` (default=`0`):: `vcpus`: `integer (1 - N)` (default=`0`)::
@ -311,21 +772,153 @@ Number of hotplugged vcpus.
`vga`: `(cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware)` :: `vga`: `(cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware)` ::
Select the VGA type. If you want to use high resolution modes (>= Select the VGA type. If you want to use high resolution modes (>= 1280x1024x16) then you should use the options 'std' or 'vmware'. Default is 'std' for win8/win7/w2k8, and 'cirrus' for other OS types. The 'qxl' option enables the SPICE display sever. For win* OS you can select how many independent displays you want, Linux guests can add displays them self. You can also run without any graphic card, using a serial device as terminal.
1280x1024x16) then you should use the options 'std' or 'vmware'. Default is
'std' for win8/win7/w2k8, and 'cirrus' for other OS types. The 'qxl' option
enables the SPICE display sever. For win* OS you can select how many
independent displays you want, Linux guests can add displays them self. You
can also run without any graphic card, using a serial device as terminal.
`virtio[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<image format>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,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>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` :: `virtio[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<image format>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,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>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
Use volume as VIRTIO hard disk (n is 0 to 15). Use volume as VIRTIO hard disk (n is 0 to 15).
`aio`=`(native | threads)` ;;
AIO type to use.
`backup`=`boolean` ;;
Whether the drive should be included when making backups.
`bps`=`<bps>` ;;
Maximum r/w speed speed in bytes per second.
`bps_rd`=`<bps>` ;;
Maximum read speed speed in bytes per second.
`bps_wr`=`<bps>` ;;
Maximum write speed speed in bytes per second.
`cache`=`(directsync | none | unsafe | writeback | writethrough)` ;;
The drive's cache mode
`cyls`=`integer` ;;
Force the drive's physical geometry to have a specific cylinder count.
`detect_zeroes`=`boolean` ;;
Controls whether to detect and try to optimize writes of zeroes.
`discard`=`(ignore | on)` ;;
Controls whether to pass discard/trim requests to the underlying storage.
`file`=`<volume>` ;;
The drive's backing volume.
`format`=`<image format>` ;;
The drive's backing file's data format.
`heads`=`integer` ;;
Force the drive's physical geometry to have a specific head count.
`iops`=`<iops>` ;;
Maximum r/w I/O speed in operations per second.
`iops_max`=`<iops>` ;;
Maximum unthrottled r/w I/O pool speed in operations per second.
`iops_rd`=`<iops>` ;;
Maximum read I/O speed in operations per second.
`iops_rd_max`=`<iops>` ;;
Maximum unthrottled read I/O pool speed in operations per second.
`iops_wr`=`<iops>` ;;
Maximum write I/O speed in operations per second.
`iops_wr_max`=`<iops>` ;;
Maximum unthrottled write I/O pool speed in operations per second.
`iothread`=`boolean` ;;
Whether to use iothreads for this drive
`mbps`=`<mbps>` ;;
Maximum r/w speed speed in megabytes per second.
`mbps_max`=`<mbps>` ;;
Maximum unthrottled r/w pool speed in megabytes per second.
`mbps_rd`=`<mbps>` ;;
Maximum read speed speed in megabytes per second.
`mbps_rd_max`=`<mbps>` ;;
Maximum unthrottled read pool speed in megabytes per second.
`mbps_wr`=`<mbps>` ;;
Maximum write speed speed in megabytes per second.
`mbps_wr_max`=`<mbps>` ;;
Maximum unthrottled write pool speed in megabytes per second.
`media`=`(cdrom | disk)` (default=`disk`);;
The drive's media type.
`rerror`=`(ignore | report | stop)` ;;
Read error action.
`secs`=`integer` ;;
Force the drive's physical geometry to have a specific sector count.
`serial`=`<serial>` ;;
The drive's reported serial number, url-encoded, up to 20 bytes long.
`size`=`<DiskSize>` ;;
Disk size. This is purely informational and has no effect.
`snapshot`=`boolean` ;;
Whether the drive should be included when making snapshots.
`trans`=`(auto | lba | none)` ;;
Force disk geometry bios translation mode.
`werror`=`(enospc | ignore | report | stop)` ;;
Write error action.
`watchdog`: `[[model=]<i6300esb|ib700>] [,action=<reset|shutdown|poweroff|pause|debug|none>]` :: `watchdog`: `[[model=]<i6300esb|ib700>] [,action=<reset|shutdown|poweroff|pause|debug|none>]` ::
Create a virtual hardware watchdog device. Once enabled (by a guest 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)
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`=`(debug | none | pause | poweroff | reset | shutdown)` ;;
action specified)
The action to perform if after activation the guest fails to poll the watchdog in time.
`model`=`(i6300esb | ib700)` (default=`i6300esb`);;
Watchdog type to emulate.

6
vzdump.1-synopsis.adoc
View File

@ -46,8 +46,7 @@ Specify when to send an email
`-mailto` `string` :: `-mailto` `string` ::
Comma-separated list of email addresses that should receive email Comma-separated list of email addresses that should receive email notifications.
notifications.
`-maxfiles` `integer (1 - N)` (default=`1`):: `-maxfiles` `integer (1 - N)` (default=`1`)::
@ -63,8 +62,7 @@ Only run if executed on this node.
`-pigz` `integer` (default=`0`):: `-pigz` `integer` (default=`0`)::
Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count.
thread count.
`-quiet` `boolean` (default=`0`):: `-quiet` `boolean` (default=`0`)::

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

@ -28,8 +28,7 @@ Specify when to send an email
`mailto`: `string` :: `mailto`: `string` ::
Comma-separated list of email addresses that should receive email Comma-separated list of email addresses that should receive email notifications.
notifications.
`maxfiles`: `integer (1 - N)` (default=`1`):: `maxfiles`: `integer (1 - N)` (default=`1`)::
@ -41,8 +40,7 @@ Backup mode.
`pigz`: `integer` (default=`0`):: `pigz`: `integer` (default=`0`)::
Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count.
thread count.
`remove`: `boolean` (default=`1`):: `remove`: `boolean` (default=`1`)::