`-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` ::
-Note: this option is for experts only. It allows you to pass arbitrary
-arguments to kvm, for example:
-
-args: -no-reboot -no-hpet
+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`)::
The number of cores per socket.
-`-cpu` `(486 | Broadwell | Conroe | Haswell | IvyBridge | Nehalem | Opteron_G1 | Opteron_G2 | Opteron_G3 | Opteron_G4 | Opteron_G5 | Penryn | SandyBridge | Westmere | athlon | core2duo | coreduo | host | kvm32 | kvm64 | pentium | pentium2 | pentium3 | phenom | qemu32 | qemu64)` (default=`kvm64`)::
+`-cpu` `[cputype=]<cputype> [,hidden=<1|0>]` ::
Emulated CPU type.
`-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.
+Limit of CPU usage.
`-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` ::
Freeze CPU at startup (use 'c' monitor command to start execution).
-`-hostpci[n]` `[host=]HOSTPCIDEVICE [,rombar=on|off] [,pcie=0|1] [,x-vga=on|off]` ::
-
-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.
+`-hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]` ::
-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]` `[volume=]volume,] [,media=cdrom|disk] [,cyls=c,heads=h,secs=s[,trans=t]] [,snapshot=on|off] [,cache=none|writethrough|writeback|unsafe|directsync] [,format=f] [,backup=yes|no] [,rerror=ignore|report|stop] [,werror=enospc|ignore|report|stop] [,aio=native|threads] [,discard=ignore|on] [,detect_zeroes=on|off] [,serial=serial][,model=model]` ::
+`-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).
`-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`)::
Set a name for the VM. Only used on the configuration web interface.
-`-net[n]` `MODEL=XX:XX:XX:XX:XX:XX [,bridge=<dev>][,queues=<nbqueues>][,rate=<mbps>] [,tag=<vlanid>][,firewall=0|1],link_down=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`)::
-Enable/disable Numa.
+Enable/disable NUMA.
-`-numa[n]` `cpus=<id[-id],memory=<mb>[[,hostnodes=<id[-id]>] [,policy=<preferred|bind|interleave>]]` ::
+`-numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
-numa topology
+NUMA topology.
`-onboot` `boolean` (default=`0`)::
`-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` ::
Add the VM to the specified pool.
`-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`)::
Allow reboot. If set to '0' the VM exit on reboot.
-`-sata[n]` `[volume=]volume,] [,media=cdrom|disk] [,cyls=c,heads=h,secs=s[,trans=t]] [,snapshot=on|off] [,cache=none|writethrough|writeback|unsafe|directsync] [,format=f] [,backup=yes|no] [,rerror=ignore|report|stop] [,werror=enospc|ignore|report|stop] [,aio=native|threads] [,discard=ignore|on] [,detect_zeroes=on|off] [,serial=serial]` ::
+`-sata[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>] [,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 SATA hard disk or CD-ROM (n is 0 to 5).
-`-scsi[n]` `[volume=]volume,] [,media=cdrom|disk] [,cyls=c,heads=h,secs=s[,trans=t]] [,snapshot=on|off] [,cache=none|writethrough|writeback|unsafe|directsync] [,format=f] [,backup=yes|no] [,rerror=ignore|report|stop] [,werror=enospc|ignore|report|stop] [,aio=native|threads] [,discard=ignore|on] [,detect_zeroes=on|off] [,iothread=on] [,queues=<nbqueues>] [,serial=serial]` ::
+`-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).
`-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
-`-smbios[n]` `[manufacturer=str][,product=str][,version=str][,serial=str] [,uuid=uuid][,sku=str][,family=str]` ::
+`-smbios1` `[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` ::
Specify SMBIOS type 1 fields.
`-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 of 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` ::
-
-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)
-
-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.
+`-usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
+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 VGA type. If you want to use high resolution modes (>= 1280x1024x16)
-then you should use option 'std' or 'vmware'. Default is 'std' for
-win8/win7/w2k8, and 'cirrur' for other OS types. Option 'qxl' enables the
-SPICE display sever. You can also run without any graphic card using a
-serial devive as terminal.
+Select the VGA type.
-`-virtio[n]` `[volume=]volume,] [,media=cdrom|disk] [,cyls=c,heads=h,secs=s[,trans=t]] [,snapshot=on|off] [,cache=none|writethrough|writeback|unsafe|directsync] [,format=f] [,backup=yes|no] [,rerror=ignore|report|stop] [,werror=enospc|ignore|report|stop] [,aio=native|threads] [,discard=ignore|on] [,detect_zeroes=on|off] [,iothread=on] [,serial=serial]` ::
+`-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).
-`-watchdog` `[[model=]i6300esb|ib700] [,[action=]reset|shutdown|poweroff|pause|debug|none]` ::
+`-watchdog` `[[model=]<i6300esb|ib700>] [,action=<reset|shutdown|poweroff|pause|debug|none>]` ::
-Create a virtual hardware watchdog device. Once enabled (by a guest
-action), the watchdog must be periodically polled by an agent inside the
-guest or else the guest will be restarted (or execute the action specified)
+Create a virtual hardware watchdog device.
-*qm list*
+*qm list* `[OPTIONS]`
Virtual machine index (per node).
+`-full` `boolean` ::
+
+Determine the full status of active VMs.
+
*qm migrate* `<vmid> <target>` `[OPTIONS]`
`-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` ::
-Note: this option is for experts only. It allows you to pass arbitrary
-arguments to kvm, for example:
-
-args: -no-reboot -no-hpet
+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`)::
The number of cores per socket.
-`-cpu` `(486 | Broadwell | Conroe | Haswell | IvyBridge | Nehalem | Opteron_G1 | Opteron_G2 | Opteron_G3 | Opteron_G4 | Opteron_G5 | Penryn | SandyBridge | Westmere | athlon | core2duo | coreduo | host | kvm32 | kvm64 | pentium | pentium2 | pentium3 | phenom | qemu32 | qemu64)` (default=`kvm64`)::
+`-cpu` `[cputype=]<cputype> [,hidden=<1|0>]` ::
Emulated CPU type.
`-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.
+Limit of CPU usage.
`-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`
Freeze CPU at startup (use 'c' monitor command to start execution).
-`-hostpci[n]` `[host=]HOSTPCIDEVICE [,rombar=on|off] [,pcie=0|1] [,x-vga=on|off]` ::
-
-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').
+`-hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]` ::
-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]` `[volume=]volume,] [,media=cdrom|disk] [,cyls=c,heads=h,secs=s[,trans=t]] [,snapshot=on|off] [,cache=none|writethrough|writeback|unsafe|directsync] [,format=f] [,backup=yes|no] [,rerror=ignore|report|stop] [,werror=enospc|ignore|report|stop] [,aio=native|threads] [,discard=ignore|on] [,detect_zeroes=on|off] [,serial=serial][,model=model]` ::
+`-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).
`-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`)::
Set a name for the VM. Only used on the configuration web interface.
-`-net[n]` `MODEL=XX:XX:XX:XX:XX:XX [,bridge=<dev>][,queues=<nbqueues>][,rate=<mbps>] [,tag=<vlanid>][,firewall=0|1],link_down=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`)::
-Enable/disable Numa.
+Enable/disable NUMA.
-`-numa[n]` `cpus=<id[-id],memory=<mb>[[,hostnodes=<id[-id]>] [,policy=<preferred|bind|interleave>]]` ::
+`-numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
-numa topology
+NUMA topology.
`-onboot` `boolean` (default=`0`)::
`-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`)::
Revert a pending change.
-`-sata[n]` `[volume=]volume,] [,media=cdrom|disk] [,cyls=c,heads=h,secs=s[,trans=t]] [,snapshot=on|off] [,cache=none|writethrough|writeback|unsafe|directsync] [,format=f] [,backup=yes|no] [,rerror=ignore|report|stop] [,werror=enospc|ignore|report|stop] [,aio=native|threads] [,discard=ignore|on] [,detect_zeroes=on|off] [,serial=serial]` ::
+`-sata[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>] [,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 SATA hard disk or CD-ROM (n is 0 to 5).
-`-scsi[n]` `[volume=]volume,] [,media=cdrom|disk] [,cyls=c,heads=h,secs=s[,trans=t]] [,snapshot=on|off] [,cache=none|writethrough|writeback|unsafe|directsync] [,format=f] [,backup=yes|no] [,rerror=ignore|report|stop] [,werror=enospc|ignore|report|stop] [,aio=native|threads] [,discard=ignore|on] [,detect_zeroes=on|off] [,iothread=on] [,queues=<nbqueues>] [,serial=serial]` ::
+`-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).
`-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` ::
Ignore locks - only root is allowed to use this option.
-`-smbios[n]` `[manufacturer=str][,product=str][,version=str][,serial=str] [,uuid=uuid][,sku=str][,family=str]` ::
+`-smbios1` `[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` ::
Specify SMBIOS type 1 fields.
`-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 of 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.
-
-`-usb[n]` `host=HOSTUSBDEVICE|spice` ::
-
-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)
-
-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.
+Reference to unused volumes. This is used internally, and should not be modified manually.
-The value 'spice' can be used to add a usb redirection devices for spice.
+`-usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
+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 VGA type. If you want to use high resolution modes (>= 1280x1024x16)
-then you should use option 'std' or 'vmware'. Default is 'std' for
-win8/win7/w2k8, and 'cirrur' for other OS types. Option 'qxl' enables the
-SPICE display sever. You can also run without any graphic card using a
-serial devive as terminal.
+Select the VGA type.
-`-virtio[n]` `[volume=]volume,] [,media=cdrom|disk] [,cyls=c,heads=h,secs=s[,trans=t]] [,snapshot=on|off] [,cache=none|writethrough|writeback|unsafe|directsync] [,format=f] [,backup=yes|no] [,rerror=ignore|report|stop] [,werror=enospc|ignore|report|stop] [,aio=native|threads] [,discard=ignore|on] [,detect_zeroes=on|off] [,iothread=on] [,serial=serial]` ::
+`-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).
-`-watchdog` `[[model=]i6300esb|ib700] [,[action=]reset|shutdown|poweroff|pause|debug|none]` ::
+`-watchdog` `[[model=]<i6300esb|ib700>] [,action=<reset|shutdown|poweroff|pause|debug|none>]` ::
-Create a virtual hardware watchdog device. Once enabled (by a guest
-action), the watchdog must be periodically polled by an agent inside the
-guest or else the guest will be restarted (or execute the action specified)
+Create a virtual hardware watchdog device.
*qm shutdown* `<vmid>` `[OPTIONS]`
-Shutdown virtual machine.
+Shutdown virtual machine. This is similar to pressing the power button on a
+physical machine.This will send an ACPI event for the guest OS, which
+should then proceed to a clean shutdown.
`<vmid>` `integer (1 - N)` ::
*qm stop* `<vmid>` `[OPTIONS]`
-Stop virtual machine.
+Stop virtual machine. The qemu process will exit immediately. Thisis akin
+to pulling the power plug of a running computer and may damage the VM data
`<vmid>` `integer (1 - N)` ::
`-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` ::
projects / pve-docs.git / blobdiff