"type" : "boolean"
},
"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,
- "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" : {
"default" : 0,
},
"cpulimit" : {
"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,
"minimum" : 0,
"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" : {
"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,
"minimum" : 0,
"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" : {
"description" : "A list of settings you want to delete.",
"type" : "boolean"
},
"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",
"optional" : 1,
"type" : "string"
},
"keyboard" : {
"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" : [
"de",
"de-ch",
"type" : "string"
},
"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" : {
"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",
"optional" : 1,
"type" : "string"
"keyAlias" : "model"
},
"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,
"type" : "boolean"
},
"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",
"optional" : 1,
"pattern" : "(?^i:[0-9a-f]{2}(?::[0-9a-f]{2}){5})",
},
"model" : {
"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" : [
"rtl8139",
"ne2k_pci",
"type" : "integer"
},
"rate" : {
- "description" : "Rate limit in mbps as floating point number.",
+ "description" : "Rate limit in mbps (megabytes per second) as floating point number.",
"minimum" : 0,
"optional" : 1,
"type" : "number"
"tag" : {
"description" : "VLAN tag to apply to packets on this interface.",
"maximum" : 4094,
- "minimum" : 2,
+ "minimum" : 1,
"optional" : 1,
"type" : "integer"
},
"type" : "boolean"
},
"numa[n]" : {
- "description" : "numa topology",
+ "description" : "NUMA topology.",
"format" : {
"cpus" : {
- "description" : "CPUs accessing this numa node.",
+ "description" : "CPUs accessing this NUMA node.",
"format_description" : "id[-id];...",
"pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)",
"type" : "string"
},
"hostnodes" : {
- "description" : "host numa nodes to use",
+ "description" : "Host NUMA nodes to use.",
"format_description" : "id[-id];...",
"optional" : 1,
"pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)",
"type" : "string"
},
"memory" : {
- "description" : "Amount of memory this numa node provides.",
+ "description" : "Amount of memory this NUMA node provides.",
"optional" : 1,
"type" : "number"
},
"policy" : {
- "description" : "numa allocation policy.",
+ "description" : "NUMA allocation policy.",
"enum" : [
"preferred",
"bind",
"type" : "boolean"
},
"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" : [
"other",
"wxp",
"solaris"
],
"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]" : {
- "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,
"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" : {
"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,
"type" : "boolean"
},
},
"scsihw" : {
"default" : "lsi",
- "description" : "scsi controller model",
+ "description" : "SCSI controller model",
"enum" : [
"lsi",
"lsi53c810",
"type" : "string"
},
"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,
"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" : {
"default" : 1000,
},
"tablet" : {
"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,
- "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" : {
"default" : 0,
"type" : "boolean"
},
"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",
"optional" : 1,
"type" : "string"
},
"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" : {
"host" : {
"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_description" : "HOSTUSBDEVICE|spice",
"type" : "string"
},
"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,
"type" : "boolean"
}
"type" : "integer"
},
"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" : [
"std",
"cirrus",
"qxl4"
],
"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]" : {
"description" : "Use volume as VIRTIO hard disk (n is 0 to 15).",
"type" : "integer"
},
"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",
"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)"
}
}
},
"type" : "boolean"
},
"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,
- "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" : {
"default" : 0,
},
"cpulimit" : {
"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,
"minimum" : 0,
"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" : {
"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,
"minimum" : 0,
"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" : {
"description" : "A list of settings you want to delete.",
"type" : "boolean"
},
"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",
"optional" : 1,
"type" : "string"
},
"keyboard" : {
"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" : [
"de",
"de-ch",
"type" : "string"
},
"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" : {
"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",
"optional" : 1,
"type" : "string"
"keyAlias" : "model"
},
"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,
"type" : "boolean"
},
"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",
"optional" : 1,
"pattern" : "(?^i:[0-9a-f]{2}(?::[0-9a-f]{2}){5})",
},
"model" : {
"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" : [
"rtl8139",
"ne2k_pci",
"type" : "integer"
},
"rate" : {
- "description" : "Rate limit in mbps as floating point number.",
+ "description" : "Rate limit in mbps (megabytes per second) as floating point number.",
"minimum" : 0,
"optional" : 1,
"type" : "number"
"tag" : {
"description" : "VLAN tag to apply to packets on this interface.",
"maximum" : 4094,
- "minimum" : 2,
+ "minimum" : 1,
"optional" : 1,
"type" : "integer"
},
"type" : "boolean"
},
"numa[n]" : {
- "description" : "numa topology",
+ "description" : "NUMA topology.",
"format" : {
"cpus" : {
- "description" : "CPUs accessing this numa node.",
+ "description" : "CPUs accessing this NUMA node.",
"format_description" : "id[-id];...",
"pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)",
"type" : "string"
},
"hostnodes" : {
- "description" : "host numa nodes to use",
+ "description" : "Host NUMA nodes to use.",
"format_description" : "id[-id];...",
"optional" : 1,
"pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)",
"type" : "string"
},
"memory" : {
- "description" : "Amount of memory this numa node provides.",
+ "description" : "Amount of memory this NUMA node provides.",
"optional" : 1,
"type" : "number"
},
"policy" : {
- "description" : "numa allocation policy.",
+ "description" : "NUMA allocation policy.",
"enum" : [
"preferred",
"bind",
"type" : "boolean"
},
"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" : [
"other",
"wxp",
"solaris"
],
"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]" : {
- "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,
"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" : {
"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,
"type" : "boolean"
},
},
"scsihw" : {
"default" : "lsi",
- "description" : "scsi controller model",
+ "description" : "SCSI controller model",
"enum" : [
"lsi",
"lsi53c810",
"type" : "string"
},
"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,
"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" : {
"default" : 1000,
},
"tablet" : {
"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,
- "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" : {
"default" : 0,
"type" : "boolean"
},
"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",
"optional" : 1,
"type" : "string"
},
"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" : {
"host" : {
"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_description" : "HOSTUSBDEVICE|spice",
"type" : "string"
},
"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,
"type" : "boolean"
}
"type" : "integer"
},
"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" : [
"std",
"cirrus",
"qxl4"
],
"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]" : {
"description" : "Use volume as VIRTIO hard disk (n is 0 to 15).",
"type" : "integer"
},
"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",
"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)"
}
}
},
"type" : "string"
},
"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,
- "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" : {
"default" : 0,
},
"cpulimit" : {
"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,
"minimum" : 0,
"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" : {
"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,
"minimum" : 0,
"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 for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.",
"type" : "boolean"
},
"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",
"optional" : 1,
"type" : "string"
},
"keyboard" : {
"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" : [
"de",
"de-ch",
"type" : "string"
},
"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" : {
"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",
"optional" : 1,
"type" : "string"
"keyAlias" : "model"
},
"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,
"type" : "boolean"
},
"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",
"optional" : 1,
"pattern" : "(?^i:[0-9a-f]{2}(?::[0-9a-f]{2}){5})",
},
"model" : {
"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" : [
"rtl8139",
"ne2k_pci",
"type" : "integer"
},
"rate" : {
- "description" : "Rate limit in mbps as floating point number.",
+ "description" : "Rate limit in mbps (megabytes per second) as floating point number.",
"minimum" : 0,
"optional" : 1,
"type" : "number"
"tag" : {
"description" : "VLAN tag to apply to packets on this interface.",
"maximum" : 4094,
- "minimum" : 2,
+ "minimum" : 1,
"optional" : 1,
"type" : "integer"
},
"type" : "boolean"
},
"numa[n]" : {
- "description" : "numa topology",
+ "description" : "NUMA topology.",
"format" : {
"cpus" : {
- "description" : "CPUs accessing this numa node.",
+ "description" : "CPUs accessing this NUMA node.",
"format_description" : "id[-id];...",
"pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)",
"type" : "string"
},
"hostnodes" : {
- "description" : "host numa nodes to use",
+ "description" : "Host NUMA nodes to use.",
"format_description" : "id[-id];...",
"optional" : 1,
"pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)",
"type" : "string"
},
"memory" : {
- "description" : "Amount of memory this numa node provides.",
+ "description" : "Amount of memory this NUMA node provides.",
"optional" : 1,
"type" : "number"
},
"policy" : {
- "description" : "numa allocation policy.",
+ "description" : "NUMA allocation policy.",
"enum" : [
"preferred",
"bind",
"type" : "boolean"
},
"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" : [
"other",
"wxp",
"solaris"
],
"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]" : {
- "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,
"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" : {
"description" : "Add the VM to the specified pool.",
},
"protection" : {
"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,
"type" : "boolean"
},
},
"scsihw" : {
"default" : "lsi",
- "description" : "scsi controller model",
+ "description" : "SCSI controller model",
"enum" : [
"lsi",
"lsi53c810",
"type" : "string"
},
"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,
"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" : {
"default" : 1000,
},
"tablet" : {
"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,
- "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" : {
"default" : 0,
"type" : "boolean"
},
"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",
"optional" : 1,
"type" : "string"
},
"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" : {
"host" : {
"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_description" : "HOSTUSBDEVICE|spice",
"type" : "string"
},
"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,
"type" : "boolean"
}
"type" : "integer"
},
"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" : [
"std",
"cirrus",
"qxl4"
],
"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]" : {
"description" : "Use volume as VIRTIO hard disk (n is 0 to 15).",
"type" : "integer"
},
"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",
"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)"
}
}
},
"type" : "integer"
},
"mp[n]" : {
- "description" : "Use volume as container mount point (experimental feature).",
+ "description" : "Use volume as container mount point.",
"format" : {
"acl" : {
"description" : "Explicitly enable or disable ACL support.",
"tag" : {
"description" : "VLAN tag for this interface.",
"maximum" : "4094",
- "minimum" : "2",
+ "minimum" : "1",
"optional" : 1,
"type" : "integer"
},
"optional" : 1,
"type" : "boolean"
},
- "backup" : {
- "description" : "Whether to include the mountpoint in backups.",
- "optional" : 1,
- "type" : "boolean"
- },
"quota" : {
"description" : "Enable user quotas inside the container (not supported with zfs subvolumes)",
"optional" : 1,
"type" : "boolean"
},
"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",
"optional" : 1,
"type" : "string"
"type" : "integer"
},
"mp[n]" : {
- "description" : "Use volume as container mount point (experimental feature).",
+ "description" : "Use volume as container mount point.",
"format" : {
"acl" : {
"description" : "Explicitly enable or disable ACL support.",
"tag" : {
"description" : "VLAN tag for this interface.",
"maximum" : "4094",
- "minimum" : "2",
+ "minimum" : "1",
"optional" : 1,
"type" : "integer"
},
"optional" : 1,
"type" : "boolean"
},
- "backup" : {
- "description" : "Whether to include the mountpoint in backups.",
- "optional" : 1,
- "type" : "boolean"
- },
"quota" : {
"description" : "Enable user quotas inside the container (not supported with zfs subvolumes)",
"optional" : 1,
"type" : "boolean"
},
"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",
"optional" : 1,
"type" : "string"
`console`: `(applet | html5 | vv)` ::
-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).
+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).
`email_from`: `string` ::
`fencing`: `(both | hardware | watchdog)` (default=`watchdog`)::
-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.
+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.
+
WARNING: 'hardware' and 'both' are EXPERIMENTAL & WIP
`http_proxy`: `http://.*` ::
-Specify external http proxy which is used for downloads (example:
-'http://username:password@host:port/')
+Specify external http proxy which is used for downloads (example: '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)` ::
`max_workers`: `integer (1 - N)` ::
-Defines how many workers (per node) are maximal started on actions like
-'stopall VMs' or task from the ha-manager.
+Defines how many workers (per node) are maximal started on actions like 'stopall VMs' or task from the ha-manager.
`migration_unsecure`: `boolean` ::
-Migration is secure using SSH tunnel by default. For secure private
-networks you can disable it to speed up migration.
+Migration is secure using SSH tunnel by default. For secure private networks you can disable it to speed up migration.
`<sid>` `<type>:<name>` ::
-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).
+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).
`-comment` `string` ::
`-max_restart` `integer (0 - N)` (default=`1`)::
-Maximal number of tries to restart the service on a node after its start
-failed.
+Maximal number of tries to restart the service on a node after its start failed.
`-state` `(disabled | enabled)` (default=`enabled`)::
`<sid>` `<type>:<name>` ::
-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).
+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).
`<sid>` `<type>:<name>` ::
-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).
+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).
`-nodes` `<node>[:<pri>]{,<node>[:<pri>]}*` ::
-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').
+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').
`-nofailback` `boolean` (default=`0`)::
-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.
+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.
`-restricted` `boolean` (default=`0`)::
-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.
+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.
`-type` `(group)` ::
`-digest` `string` ::
-Prevent changes if current configuration file has different SHA1 digest.
-This can be used to prevent concurrent modifications.
+Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
`-nodes` `<node>[:<pri>]{,<node>[:<pri>]}*` ::
-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').
+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').
`-nofailback` `boolean` (default=`0`)::
-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.
+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.
`-restricted` `boolean` (default=`0`)::
-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.
+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.
`<sid>` `<type>:<name>` ::
-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).
+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).
`<node>` `string` ::
`<sid>` `<type>:<name>` ::
-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).
+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).
`<node>` `string` ::
`<sid>` `<type>:<name>` ::
-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).
+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).
`<sid>` `<type>:<name>` ::
-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).
+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).
`-comment` `string` ::
`-digest` `string` ::
-Prevent changes if current configuration file has different SHA1 digest.
-This can be used to prevent concurrent modifications.
+Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
`-group` `string` ::
`-max_restart` `integer (0 - N)` (default=`1`)::
-Maximal number of tries to restart the service on a node after its start
-failed.
+Maximal number of tries to restart the service on a node after its start failed.
`-state` `(disabled | enabled)` (default=`enabled`)::
-`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>]`
`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)
+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>` ::
`name`: `<string>` ::
-Name of the network device as seen from inside the container.
-(lxc.network.name)
+Name of the network device as seen from inside the container. (lxc.network.name)
`rate`: `<mbps>` ::
Apply rate limiting to the interface
-`tag`: `integer (2 - 4094)` ::
+`tag`: `integer (1 - 4094)` ::
VLAN tag for this interface.
`-experimental` `boolean` (default=`0`)::
-The clone feature is experimental, set this flag if you know what you are
-doing.
+The clone feature is experimental, set this flag if you know what you are doing.
`-full` `boolean` (default=`0`)::
-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.
+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.
`-hostname` `string` ::
`-cmode` `(console | shell | tty)` (default=`tty`)::
-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).
+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).
`-console` `boolean` (default=`1`)::
Limit of CPU usage.
+
-NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0'
-indicates no CPU limit.
+NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.
`-cpuunits` `integer (0 - 500000)` (default=`1024`)::
-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.
+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.
+
NOTE: You can disable fair-scheduler configuration by setting this to 0.
`-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` ::
-Sets DNS server IP address for a container. Create will automatically use
-the setting from the host if you neither set searchdomain nor nameserver.
+Sets DNS server IP address for a container. Create will automatically use 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>]` ::
`-ostype` `(alpine | archlinux | centos | debian | fedora | opensuse | ubuntu | unmanaged)` ::
-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.
+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.
`-password` ::
`-protection` `boolean` (default=`0`)::
-Sets the protection flag of the container. This will prevent the CT or CT's
-disk remove/update operation.
+Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
`-restore` `boolean` ::
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.
`-searchdomain` `string` ::
-Sets DNS search domains for a container. Create will automatically use the
-setting from the host if you neither set searchdomain nor nameserver.
+Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
`-ssh-public-keys` `filepath` ::
`-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
-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.
+Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.
`-storage` `string` (default=`local`)::
`-unprivileged` `boolean` (default=`0`)::
-Makes the container run as unprivileged user. (Should not be modified
-manually.)
+Makes the container run as unprivileged user. (Should not be modified manually.)
`-unused[n]` `string` ::
-Reference to unused volumes.
+Reference to unused volumes. This is used internally, and should not be modified manually.
`-force` `boolean` ::
-Force migration despite local bind / device mounts. WARNING: identical bind
-/ device mounts need to be available on the target node.
+Force migration despite local bind / device mounts. WARNING: identical bind / device mounts need to be available on the target node.
`-online` `boolean` ::
`-perms` `string` ::
-File permissions to use (octal by default, prefix with '0x' for
-hexadecimal).
+File permissions to use (octal by default, prefix with '0x' for hexadecimal).
`-user` `string` ::
`-group` `string` ::
-Owner group name or id. When using a name it must exist inside the
-container.
+Owner group name or id. When using a name it must exist inside the container.
`-perms` `string` ::
-File permissions to use (octal by default, prefix with '0x' for
-hexadecimal).
+File permissions to use (octal by default, prefix with '0x' for hexadecimal).
`-user` `string` ::
-Owner user name or id. When using a name it must exist inside the
-container.
+Owner user name or id. When using a name it must exist inside the container.
`<size>` `\+?\d+(\.\d+)?[KMGT]?` ::
-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 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.
`-digest` `string` ::
-Prevent changes if current configuration file has different SHA1 digest.
-This can be used to prevent concurrent modifications.
+Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
`-cmode` `(console | shell | tty)` (default=`tty`)::
-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).
+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).
`-console` `boolean` (default=`1`)::
Limit of CPU usage.
+
-NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0'
-indicates no CPU limit.
+NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.
`-cpuunits` `integer (0 - 500000)` (default=`1024`)::
-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.
+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.
+
NOTE: You can disable fair-scheduler configuration by setting this to 0.
`-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` ::
-Sets DNS server IP address for a container. Create will automatically use
-the setting from the host if you neither set searchdomain nor nameserver.
+Sets DNS server IP address for a container. Create will automatically use 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>]` ::
`-ostype` `(alpine | archlinux | centos | debian | fedora | opensuse | ubuntu | unmanaged)` ::
-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.
+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.
`-password` ::
`-protection` `boolean` (default=`0`)::
-Sets the protection flag of the container. This will prevent the CT or CT's
-disk remove/update operation.
+Sets the protection flag of the container. This will prevent the CT or CT's 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.
`-searchdomain` `string` ::
-Sets DNS search domains for a container. Create will automatically use the
-setting from the host if you neither set searchdomain nor nameserver.
+Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
`-ssh-public-keys` `filepath` ::
`-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
-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.
+Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.
`-storage` `string` (default=`local`)::
`-unprivileged` `boolean` (default=`0`)::
-Makes the container run as unprivileged user. (Should not be modified
-manually.)
+Makes the container run as unprivileged user. (Should not be modified manually.)
`-unused[n]` `string` ::
-Reference to unused volumes.
+Reference to unused volumes. This is used internally, and should not be modified manually.
`-cmode` `(console | shell | tty)` (default=`tty`)::
-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).
+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).
`-console` `boolean` (default=`1`)::
Limit of CPU usage.
+
-NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0'
-indicates no CPU limit.
+NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.
`-cpuunits` `integer (0 - 500000)` (default=`1024`)::
-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.
+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.
+
NOTE: You can disable fair-scheduler configuration by setting this to 0.
`-digest` `string` ::
-Prevent changes if current configuration file has different SHA1 digest.
-This can be used to prevent concurrent modifications.
+Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
`-hostname` `string` ::
`-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` ::
-Sets DNS server IP address for a container. Create will automatically use
-the setting from the host if you neither set searchdomain nor nameserver.
+Sets DNS server IP address for a container. Create will automatically use 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>]` ::
`-ostype` `(alpine | archlinux | centos | debian | fedora | opensuse | ubuntu | unmanaged)` ::
-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.
+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.
`-protection` `boolean` (default=`0`)::
-Sets the protection flag of the container. This will prevent the CT or CT's
-disk remove/update operation.
+Sets the protection flag of the container. This will prevent the CT or CT's 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.
`-searchdomain` `string` ::
-Sets DNS search domains for a container. Create will automatically use the
-setting from the host if you neither set searchdomain nor nameserver.
+Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
`-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
-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.
+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.
`-swap` `integer (0 - N)` (default=`512`)::
`-unprivileged` `boolean` (default=`0`)::
-Makes the container run as unprivileged user. (Should not be modified
-manually.)
+Makes the container run as unprivileged user. (Should not be modified manually.)
`-unused[n]` `string` ::
-Reference to unused volumes.
+Reference to unused volumes. This is used internally, and should not be modified manually.
`-experimental` `boolean` (default=`0`)::
-The template feature is experimental, set this flag if you know what you
-are doing.
+The template feature is experimental, set this flag if you know what you are doing.
`cmode`: `(console | shell | tty)` (default=`tty`)::
-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).
+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).
`console`: `boolean` (default=`1`)::
Limit of CPU usage.
+
-NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0'
-indicates no CPU limit.
+NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.
`cpuunits`: `integer (0 - 500000)` (default=`1024`)::
-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.
+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.
+
NOTE: You can disable fair-scheduler configuration by setting this to 0.
`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` ::
-Sets DNS server IP address for a container. Create will automatically use
-the setting from the host if you neither set searchdomain nor nameserver.
+Sets DNS server IP address for a container. Create will automatically use 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>]` ::
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`)::
Specifies whether a VM will be started during system bootup.
`ostype`: `(alpine | archlinux | centos | debian | fedora | opensuse | ubuntu | unmanaged)` ::
-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.
+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.
`protection`: `boolean` (default=`0`)::
-Sets the protection flag of the container. This will prevent the CT or CT's
-disk remove/update operation.
+Sets the protection flag of the container. This will prevent the CT or CT's 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.
+`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` ::
-Sets DNS search domains for a container. Create will automatically use the
-setting from the host if you neither set searchdomain nor nameserver.
+Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
`startup`: `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
-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.
+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.
`swap`: `integer (0 - N)` (default=`512`)::
`unprivileged`: `boolean` (default=`0`)::
-Makes the container run as unprivileged user. (Should not be modified
-manually.)
+Makes the container run as unprivileged user. (Should not be modified manually.)
`unused[n]`: `string` ::
-Reference to unused volumes.
+Reference to unused volumes. This is used internally, and should not be modified manually.
`-pg_bits` `integer (6 - 14)` (default=`6`)::
-Placement group bits, used to specify the default number of placement
-groups.
+Placement group bits, used to specify the default number of placement groups.
+
NOTE: 'osd pool default pg num' does not work for default pools.
`-ring0_addr` `string` ::
-Hostname (or IP) of the corosync ring0 address of this node. Defaults to
-nodes hostname.
+Hostname (or IP) of the corosync ring0 address of this node. Defaults to nodes hostname.
`-ring1_addr` `string` ::
-Hostname (or IP) of the corosync ring1 address, this needs an valid
-configured ring 1 interface in the cluster.
+Hostname (or IP) of the corosync ring1 address, this needs an valid configured ring 1 interface in the cluster.
`-votes` `integer (0 - N)` ::
`-ring0_addr` `string` ::
-Hostname (or IP) of the corosync ring0 address of this node. Defaults to
-nodes hostname.
+Hostname (or IP) of the corosync ring0 address of this node. Defaults to nodes hostname.
`-ring1_addr` `string` ::
-Hostname (or IP) of the corosync ring1 address, this needs an valid
-bindnet1_addr.
+Hostname (or IP) of the corosync ring1 address, this needs an valid bindnet1_addr.
`-votes` `integer (0 - N)` ::
`-bindnet0_addr` `string` ::
-This specifies the network address the corosync ring 0 executive should
-bind to and defaults to the local IP address of the node.
+This specifies the network address the corosync ring 0 executive should bind to and defaults to the local IP address of the node.
`-bindnet1_addr` `string` ::
-This specifies the network address the corosync ring 1 executive should
-bind to and is optional.
+This specifies the network address the corosync ring 1 executive should bind to and is optional.
`-nodeid` `integer (1 - N)` ::
`-ring0_addr` `string` ::
-Hostname (or IP) of the corosync ring0 address of this node. Defaults to
-the hostname of the node.
+Hostname (or IP) of the corosync ring0 address of this node. Defaults to the hostname of the node.
`-ring1_addr` `string` ::
-Hostname (or IP) of the corosync ring1 address, this needs an valid
-bindnet1_addr.
+Hostname (or IP) of the corosync ring1 address, this needs an valid bindnet1_addr.
`-rrp_mode` `(active | none | passive)` (default=`none`)::
-This specifies the mode of redundant ring, which may be none, active or
-passive. Using multiple interfaces only allows 'active' or 'passive'.
+This specifies the mode of redundant ring, which may be none, active or passive. Using multiple interfaces only allows 'active' or 'passive'.
`-votes` `integer (1 - N)` ::
Allowed content types.
+
-NOTE: the value 'rootdir' is used for Containers, and value 'images' for
-VMs.
+NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
`-disable` `boolean` ::
`-redundancy` `integer (1 - 16)` (default=`2`)::
-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.
+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.
`-saferemove` `boolean` ::
`<size>` `\d+[MG]?` ::
-Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and
-'G' (gigabyte, 1024M)
+Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and 'G' (gigabyte, 1024M)
`-format` `(qcow2 | raw | subvol)` ::
Allowed content types.
+
-NOTE: the value 'rootdir' is used for Containers, and value 'images' for
-VMs.
+NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
`-delete` `string` ::
`-digest` `string` ::
-Prevent changes if current configuration file has different SHA1 digest.
-This can be used to prevent concurrent modifications.
+Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
`-disable` `boolean` ::
`-redundancy` `integer (1 - 16)` (default=`2`)::
-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.
+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.
`-saferemove` `boolean` ::
`-target` `string` ::
-If target is different to 'node', we only lists shared storages which
-content is accessible on this 'node' and the specified 'target' node.
+If target is different to 'node', we only lists shared storages which content is accessible on this 'node' and the specified 'target' node.
`-force` `boolean` (default=`0`)::
-Always connect to server, even if we have up to date info inside local
-cache.
+Always connect to server, even if we have up to date info inside local cache.
`-realm` `string` ::
-You can optionally pass the realm using this parameter. Normally the realm
-is simply added to the username <username>@<relam>.
+You can optionally pass the realm using this parameter. Normally the realm is simply added to the username <username>@<relam>.
`-expire` `integer (0 - N)` ::
-Account expiration date (seconds since epoch). '0' means no expiration
-date.
+Account expiration date (seconds since epoch). '0' means no expiration date.
`-firstname` `string` ::
`-expire` `integer (0 - N)` ::
-Account expiration date (seconds since epoch). '0' means no expiration
-date.
+Account expiration date (seconds since epoch). '0' means no expiration date.
`-firstname` `string` ::
`-full` `boolean` (default=`0`)::
-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.
+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.
`-name` `string` ::
`-args` `string` ::
-Arbitrary arguments passed to kvm, for example:
-+
-args: -no-reboot -no-hpet
-+
-NOTE: this option is for experts only.
+Arbitrary arguments passed to kvm.
`-autostart` `boolean` (default=`0`)::
`-balloon` `integer (0 - N)` ::
-Amount of target RAM for the VM in MB. Using zero disables the ballon
-driver.
+Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
`-bios` `(ovmf | seabios)` (default=`seabios`)::
`-cpulimit` `number (0 - 128)` (default=`0`)::
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`)::
-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.
-+
-NOTE: You can disable fair-scheduler configuration by setting this to 0.
+CPU weight for a VM.
`-description` `string` ::
-Description for the VM. Only used on the configuration web interface. This
-is saved as comment inside the configuration file.
+Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
`-force` `boolean` ::
`-hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]` ::
-Map host pci devices. HOSTPCIDEVICE syntax is:
-+
-'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.
+Map host PCI devices into guest.
`-hotplug` `string` (default=`network,disk,usb`)::
-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'.
+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'.
`-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>]` ::
`-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
-configuration file.
+Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.
`-kvm` `boolean` (default=`1`)::
`-localtime` `boolean` ::
-Set the real time clock to local time. This is enabled by default if ostype
-indicates a Microsoft OS.
+Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
`-lock` `(backup | migrate | rollback | snapshot)` ::
`-memory` `integer (16 - N)` (default=`512`)::
-Amount of RAM for the VM in MB. This is the maximum available memory when
-you use the balloon device.
+Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
`-migrate_downtime` `number (0 - N)` (default=`0.1`)::
`-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.
-+
-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[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
-numa topology
+NUMA topology.
`-onboot` `boolean` (default=`0`)::
`-ostype` `(l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win7 | win8 | wvista | wxp)` ::
-Used to enable special optimization/features for specific
-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
+Specify guest operating system.
`-parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
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` ::
`-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`)::
`-scsihw` `(lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single)` (default=`lsi`)::
-scsi controller model
+SCSI controller model
`-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
-migrate such machines - use with special care.
-+
-Experimental: user reported problems with this option.
+Create a serial device inside the VM (n is 0 to 3)
`-shares` `integer (0 - 50000)` (default=`1000`)::
-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
+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
`-smbios1` `[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` ::
`-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:
-'now' or '2006-06-17T16:01:21' or '2006-06-17'.
+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'.
`-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
-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.
+Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.
`-storage` `string` ::
`-tablet` `boolean` (default=`1`)::
-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).
+Enable/disable the USB tablet device.
`-tdf` `boolean` (default=`0`)::
`-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>]` ::
-Configure an USB device (n is 0 to 4). This can be used to
-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).
+Configure an USB device (n is 0 to 4).
`-vcpus` `integer (1 - N)` (default=`0`)::
`-vga` `(cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware)` ::
-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.
+Select the VGA type.
`-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>]` ::
`-watchdog` `[[model=]<i6300esb|ib700>] [,action=<reset|shutdown|poweroff|pause|debug|none>]` ::
-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)
+Create a virtual hardware watchdog device.
`-force` `boolean` ::
-Allow to migrate VMs which use local devices. Only root may use this
-option.
+Allow to migrate VMs which use local devices. Only root may use this option.
`-online` `boolean` ::
`-delete` `boolean` (default=`0`)::
-Delete the original disk after successful copy. By default the original
-disk is kept as unused disk.
+Delete the original disk after successful copy. By default the original disk is kept as unused disk.
`-digest` `string` ::
-Prevent changes if current configuration file has different SHA1 digest.
-This can be used to prevent concurrent modifications.
+Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
`-format` `(qcow2 | raw | vmdk)` ::
`<size>` `\+?\d+(\.\d+)?[KMGT]?` ::
-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 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.
`-digest` `string` ::
-Prevent changes if current configuration file has different SHA1 digest.
-This can be used to prevent concurrent modifications.
+Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
`-skiplock` `boolean` ::
`-args` `string` ::
-Arbitrary arguments passed to kvm, for example:
-+
-args: -no-reboot -no-hpet
-+
-NOTE: this option is for experts only.
+Arbitrary arguments passed to kvm.
`-autostart` `boolean` (default=`0`)::
`-balloon` `integer (0 - N)` ::
-Amount of target RAM for the VM in MB. Using zero disables the ballon
-driver.
+Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
`-bios` `(ovmf | seabios)` (default=`seabios`)::
`-cpulimit` `number (0 - 128)` (default=`0`)::
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`)::
-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.
-+
-NOTE: You can disable fair-scheduler configuration by setting this to 0.
+CPU weight for a VM.
`-delete` `string` ::
`-description` `string` ::
-Description for the VM. Only used on the configuration web interface. This
-is saved as comment inside the configuration file.
+Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
`-digest` `string` ::
-Prevent changes if current configuration file has different SHA1 digest.
-This can be used to prevent concurrent modifications.
+Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
`-force` `boolean` ::
-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.
+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.
+
NOTE: Requires option(s): `delete`
`-hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]` ::
-Map host pci devices. HOSTPCIDEVICE syntax is:
-+
-'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.
+Map host PCI devices into guest.
`-hotplug` `string` (default=`network,disk,usb`)::
-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'.
+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'.
`-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>]` ::
`-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
-configuration file.
+Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.
`-kvm` `boolean` (default=`1`)::
`-localtime` `boolean` ::
-Set the real time clock to local time. This is enabled by default if ostype
-indicates a Microsoft OS.
+Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
`-lock` `(backup | migrate | rollback | snapshot)` ::
`-memory` `integer (16 - N)` (default=`512`)::
-Amount of RAM for the VM in MB. This is the maximum available memory when
-you use the balloon device.
+Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
`-migrate_downtime` `number (0 - N)` (default=`0.1`)::
`-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.
-+
-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[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
-numa topology
+NUMA topology.
`-onboot` `boolean` (default=`0`)::
`-ostype` `(l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win7 | win8 | wvista | wxp)` ::
-Used to enable special optimization/features for specific
-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
+Specify guest operating system.
`-parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
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`)::
-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`)::
`-scsihw` `(lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single)` (default=`lsi`)::
-scsi controller model
+SCSI controller model
`-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
-migrate such machines - use with special care.
-+
-Experimental: user reported problems with this option.
+Create a serial device inside the VM (n is 0 to 3)
`-shares` `integer (0 - 50000)` (default=`1000`)::
-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
+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
`-skiplock` `boolean` ::
`-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:
-'now' or '2006-06-17T16:01:21' or '2006-06-17'.
+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'.
`-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
-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.
+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.
`-tablet` `boolean` (default=`1`)::
-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).
+Enable/disable the USB tablet device.
`-tdf` `boolean` (default=`0`)::
`-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>]` ::
-Configure an USB device (n is 0 to 4). This can be used to
-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).
+Configure an USB device (n is 0 to 4).
`-vcpus` `integer (1 - N)` (default=`0`)::
`-vga` `(cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware)` ::
-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.
+Select the VGA type.
`-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>]` ::
`-watchdog` `[[model=]<i6300esb|ib700>] [,action=<reset|shutdown|poweroff|pause|debug|none>]` ::
-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)
+Create a virtual hardware watchdog device.
`-iface` `(serial0 | serial1 | serial2 | serial3)` ::
-Select the serial device. By default we simply use the first suitable
-device.
+Select the serial device. By default we simply use the first suitable device.
`-force` `boolean` ::
-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.
+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.
`-idlist` `string` ::
`balloon`: `integer (0 - N)` ::
-Amount of target RAM for the VM in MB. Using zero disables the ballon
-driver.
+Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
`bios`: `(ovmf | seabios)` (default=`seabios`)::
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`)::
Limit of CPU usage.
+
-NOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0'
-indicates no CPU limit.
+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`)::
-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.
+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.
+
NOTE: You can disable fair-scheduler configuration by setting this to 0.
`description`: `string` ::
-Description for the VM. Only used on the configuration web interface. This
-is saved as comment inside the configuration file.
+Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
`freeze`: `boolean` ::
`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)
+
-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').
+You can us the 'lspci' command to list existing PCI 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.
+
-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`)::
-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'.
+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'.
`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).
+`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`)::
-Keybord layout for vnc server. Default is read from the datacenter
-configuration file.
+Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.
`kvm`: `boolean` (default=`1`)::
`localtime`: `boolean` ::
-Set the real time clock to local time. This is enabled by default if ostype
-indicates a Microsoft OS.
+Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
`lock`: `(backup | migrate | rollback | snapshot)` ::
`memory`: `integer (16 - N)` (default=`512`)::
-Amount of RAM for the VM in MB. This is the maximum available memory when
-you use the balloon device.
+Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
`migrate_downtime`: `number (0 - N)` (default=`0.1`)::
`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.
+
+`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
-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:
+If you do not specify a 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
+ 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.
+`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`)::
Enable/disable NUMA.
`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`)::
`ostype`: `(l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win7 | win8 | wvista | wxp)` ::
-Used to enable special optimization/features for specific
-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
+Specify guest operating system. This is used to enable special
+optimization/features for specific operating systems:
+
-other|l24|l26|solaris ... no special behaviour
-wxp|w2k|w2k3|w2k8|wvista|win7|win8 ... use --localtime switch
+[horizontal]
+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
`parallel[n]`: `/dev/parport\d+|/dev/usb/lp\d+` ::
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.
+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.
+CAUTION: Experimental! User reported problems with this option.
`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`)::
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>]` ::
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`)::
-scsi controller model
+SCSI controller model
`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
-migrate such machines - use with special care.
+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 migrate such machines - use with special care.
+
-Experimental: user reported problems with this option.
+CAUTION: Experimental! User reported problems with this option.
`shares`: `integer (0 - 50000)` (default=`1000`)::
-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
+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
`smbios1`: `[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` ::
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`)::
The number of CPUs. Please use option -sockets instead.
`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:
-'now' or '2006-06-17T16:01:21' or '2006-06-17'.
+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'.
`startup`: `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
-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.
+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.
`tablet`: `boolean` (default=`1`)::
-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).
+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`: `boolean` (default=`0`)::
`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>]` ::
-Configure an USB device (n is 0 to 4). This can be used to
-pass-through usb devices to the guest. HOSTUSBDEVICE syntax is:
+Configure an USB device (n is 0 to 4).
+
+`host`=`<HOSTUSBDEVICE|spice>` ;;
+
+The Host USB device or port or the value 'spice'. HOSTUSBDEVICE syntax is:
+
-'bus-port(.port)*' (decimal numbers) or
-'vendor_id:product_id' (hexadeciaml numbers) or
-'spice'
+ '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.
+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).
+
+`usb3`=`boolean` (default=`0`);;
+
+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`)::
`vga`: `(cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware)` ::
-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.
+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]`: `[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).
+`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>]` ::
-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)
+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`=`(debug | none | pause | poweroff | reset | shutdown)` ;;
+
+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.
`-mailto` `string` ::
-Comma-separated list of email addresses that should receive email
-notifications.
+Comma-separated list of email addresses that should receive email notifications.
`-maxfiles` `integer (1 - N)` (default=`1`)::
`-pigz` `integer` (default=`0`)::
-Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as
-thread count.
+Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count.
`-quiet` `boolean` (default=`0`)::
`mailto`: `string` ::
-Comma-separated list of email addresses that should receive email
-notifications.
+Comma-separated list of email addresses that should receive email notifications.
`maxfiles`: `integer (1 - N)` (default=`1`)::
`pigz`: `integer` (default=`0`)::
-Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as
-thread count.
+Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count.
`remove`: `boolean` (default=`1`)::
projects / pve-docs.git / commitdiff