X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=qm.1-synopsis.adoc;h=054436e45dbb91ac3a33162240954d25d20f5433;hp=c19292f63120f531b57abec013ada966641d3b8e;hb=266cb17b871843ba94f074b6f2175adae75506e0;hpb=7aacca6f1d325ac2014e98852a40d3e967ccb216 diff --git a/qm.1-synopsis.adoc b/qm.1-synopsis.adoc index c19292f..054436e 100644 --- a/qm.1-synopsis.adoc +++ b/qm.1-synopsis.adoc @@ -1,51 +1,64 @@ *qm* ` [ARGS] [OPTIONS]` +*qm agent* ` ` + +Execute Qemu Guest Agent commands. + +``: ` (1 - N)` :: + +The (unique) ID of the VM. + +``: `` :: + +The QGA command. + + + *qm clone* ` ` `[OPTIONS]` Create a copy of virtual machine/template. -`` `integer (1 - N)` :: +``: ` (1 - N)` :: The (unique) ID of the VM. -`` `integer (1 - N)` :: +``: ` (1 - N)` :: VMID for the clone. -`-description` `string` :: +`--description` `` :: Description for the new VM. -`-format` `(qcow2 | raw | vmdk)` :: +`--format` `` :: Target format for file storage. + NOTE: Requires option(s): `full` -`-full` `boolean` (default=`0`):: +`--full` `` ('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` :: +`--name` `` :: Set a name for the new VM. -`-pool` `string` :: +`--pool` `` :: Add the new VM to the specified pool. -`-snapname` `string` :: +`--snapname` `` :: The name of the snapshot. -`-storage` `string` :: +`--storage` `` :: Target storage for full clone. + NOTE: Requires option(s): `full` -`-target` `string` :: +`--target` `` :: Target node. Only allowed if the original VM is on shared storage. @@ -56,11 +69,11 @@ Target node. Only allowed if the original VM is on shared storage. Get current virtual machine configuration. This does not include pending configuration changes (see 'pending' API). -`` `integer (1 - N)` :: +``: ` (1 - N)` :: The (unique) ID of the VM. -`-current` `boolean` (default=`0`):: +`--current` `` ('default =' `0`):: Get current values (instead of pending values). @@ -70,364 +83,261 @@ Get current values (instead of pending values). Create or restore a virtual machine. -`` `integer (1 - N)` :: +``: ` (1 - N)` :: The (unique) ID of the VM. -`-acpi` `boolean` (default=`1`):: +`--acpi` `` ('default =' `1`):: Enable/disable ACPI. -`-agent` `boolean` (default=`0`):: +`--agent` `` ('default =' `0`):: Enable/disable Qemu GuestAgent. -`-archive` `string` :: +`--archive` `` :: The backup file. -`-args` `string` :: +`--args` `` :: -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`):: +`--autostart` `` ('default =' `0`):: Automatic restart after crash (currently ignored). -`-balloon` `integer (0 - N)` :: +`--balloon` ` (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`):: +`--bios` `` ('default =' `seabios`):: Select BIOS implementation. -`-boot` `[acdn]{1,4}` (default=`cdn`):: +`--boot` `[acdn]{1,4}` ('default =' `cdn`):: Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n). -`-bootdisk` `(ide|sata|scsi|virtio)\d+` :: +`--bootdisk` `(ide|sata|scsi|virtio)\d+` :: Enable booting from specified disk. -`-cdrom` `volume` :: +`--cdrom` `` :: This is an alias for option -ide2 -`-cores` `integer (1 - N)` (default=`1`):: +`--cores` ` (1 - N)` ('default =' `1`):: The number of cores per socket. -`-cpu` `[cputype=] [,hidden=<1|0>]` :: +`--cpu` `[cputype=] [,hidden=<1|0>]` :: Emulated CPU type. -`-cpulimit` `number (0 - 128)` (default=`0`):: +`--cpulimit` ` (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`):: +`--cpuunits` ` (2 - 262144)` ('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 -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` `` :: -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` :: +`--efidisk0` `[file=] [,format=] [,size=]` :: + +Configure a Disk for storing EFI vars + +`--force` `` :: Allow to overwrite existing VM. + NOTE: Requires option(s): `archive` -`-freeze` `boolean` :: +`--freeze` `` :: Freeze CPU at startup (use 'c' monitor command to start execution). -`-hostpci[n]` `[host=] [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]` :: +`--hostpci[n]` `[host=] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=] [,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` `` ('default =' `network,disk,usb`):: -`-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'. +`--hugepages` `<1024 | 2 | any>` :: -`-ide[n]` `[file=] [,aio=] [,backup=] [,bps=] [,bps_rd=] [,bps_wr=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_rd=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_max=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,rerror=] [,secs=] [,serial=] [,snapshot=] [,trans=] [,werror=]` :: +Enable/disable hugepages memory. + +`--ide[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). -`-keyboard` `(da | de | de-ch | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sl | sv | tr)` (default=`en-us`):: +`--keyboard` `` ('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`):: +`--kvm` `` ('default =' `1`):: Enable/disable KVM hardware virtualization. -`-localtime` `boolean` :: +`--localtime` `` :: -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)` :: +`--lock` `` :: Lock/unlock the VM. -`-machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` :: +`--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` :: Specific the Qemu machine type. -`-memory` `integer (16 - N)` (default=`512`):: +`--memory` ` (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`):: +`--migrate_downtime` ` (0 - N)` ('default =' `0.1`):: Set maximum tolerated downtime (in seconds) for migrations. -`-migrate_speed` `integer (0 - N)` (default=`0`):: +`--migrate_speed` ` (0 - N)` ('default =' `0`):: Set maximum speed (in MB/s) for migrations. Value 0 is no limit. -`-name` `string` :: +`--name` `` :: Set a name for the VM. Only used on the configuration web interface. -`-net[n]` `string` :: +`--net[n]` `[model=] [,bridge=] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=] [,queues=] [,rate=] [,tag=] [,trunks=] [,=]` :: 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` `` ('default =' `0`):: Enable/disable NUMA. -`-numa[n]` `cpus= [,hostnodes=] [,memory=] [,policy=]` :: +`--numa[n]` `cpus= [,hostnodes=] [,memory=] [,policy=]` :: -numa topology +NUMA topology. -`-onboot` `boolean` (default=`0`):: +`--onboot` `` ('default =' `0`):: Specifies whether a VM will be started during system bootup. -`-ostype` `(l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win7 | win8 | wvista | wxp)` :: +`--ostype` `` :: -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+` :: +`--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` :: +`--pool` `` :: Add the VM to the specified pool. -`-protection` `boolean` (default=`0`):: +`--protection` `` ('default =' `0`):: -Sets the protection flag of the VM. This will prevent the remove operation. +Sets the protection flag of the VM. This will disable the remove VM and remove disk operations. -`-reboot` `boolean` (default=`1`):: +`--reboot` `` ('default =' `1`):: Allow reboot. If set to '0' the VM exit on reboot. -`-sata[n]` `[file=] [,aio=] [,backup=] [,bps=] [,bps_rd=] [,bps_wr=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_rd=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_max=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,rerror=] [,secs=] [,serial=] [,snapshot=] [,trans=] [,werror=]` :: +`--sata[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). -`-scsi[n]` `[file=] [,aio=] [,backup=] [,bps=] [,bps_rd=] [,bps_wr=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_rd=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_max=] [,iothread=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,secs=] [,serial=] [,snapshot=] [,trans=] [,werror=]` :: +`--scsi[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,replicate=<1|0>] [,rerror=] [,scsiblock=<1|0>] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: Use volume as SCSI hard disk or CD-ROM (n is 0 to 13). -`-scsihw` `(lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single)` (default=`lsi`):: +`--scsihw` `` ('default =' `lsi`):: -scsi controller model +SCSI controller model -`-serial[n]` `(/dev/.+|socket)` :: +`--serial[n]` `(/dev/.+|socket)` :: -Create a serial device inside the VM (n is 0 to 3), and pass through a host -serial device (i.e. /dev/ttyS0), or create a unix socket on the host side -(use 'qm terminal' to open a terminal connection). -+ -NOTE: If you pass through a host serial device, it is no longer possible to -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`):: +`--shares` ` (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=] [,manufacturer=] [,product=] [,serial=] [,sku=] [,uuid=] [,version=]` :: +`--smbios1` `[family=] [,manufacturer=] [,product=] [,serial=] [,sku=] [,uuid=] [,version=]` :: Specify SMBIOS type 1 fields. -`-smp` `integer (1 - N)` (default=`1`):: +`--smp` ` (1 - N)` ('default =' `1`):: The number of CPUs. Please use option -sockets instead. -`-sockets` `integer (1 - N)` (default=`1`):: +`--sockets` ` (1 - N)` ('default =' `1`):: The number of CPU sockets. -`-startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` (default=`now`):: +`--startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`):: -Set the initial date of the real time clock. Valid format for date are: -'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` `[[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` :: +`--storage` `` :: Default storage. -`-tablet` `boolean` (default=`1`):: +`--tablet` `` ('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`):: +`--tdf` `` ('default =' `0`):: Enable/disable time drift fix. -`-template` `boolean` (default=`0`):: +`--template` `` ('default =' `0`):: Enable/disable Template. -`-unique` `boolean` :: +`--unique` `` :: Assign a unique random ethernet address. + NOTE: Requires option(s): `archive` -`-unused[n]` `string` :: +`--unused[n]` `` :: -Reference to unused volumes. +Reference to unused volumes. This is used internally, and should not be modified manually. -`-usb[n]` `[host=] [,usb3=]` :: +`--usb[n]` `[host=] [,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`):: +`--vcpus` ` (1 - N)` ('default =' `0`):: Number of hotplugged vcpus. -`-vga` `(cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware)` :: +`--vga` `` :: -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=] [,aio=] [,backup=] [,bps=] [,bps_rd=] [,bps_wr=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_rd=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_max=] [,iothread=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,rerror=] [,secs=] [,serial=] [,snapshot=] [,trans=] [,werror=]` :: +`--virtio[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: Use volume as VIRTIO hard disk (n is 0 to 15). -`-watchdog` `[action=] [,[model=]]` :: +`--vmstatestorage` `` :: + +Default storage for VM state volumes/files. + +`--watchdog` `[[model=]] [,action=]` :: -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. @@ -435,15 +345,15 @@ action specified) Delete a VM snapshot. -`` `integer (1 - N)` :: +``: ` (1 - N)` :: The (unique) ID of the VM. -`` `string` :: +``: `` :: The name of the snapshot. -`-force` `boolean` :: +`--force` `` :: For removal from config file, even if removing disk snapshots fails. @@ -453,11 +363,11 @@ For removal from config file, even if removing disk snapshots fails. Destroy the vm (also delete all used/owned volumes). -`` `integer (1 - N)` :: +``: ` (1 - N)` :: The (unique) ID of the VM. -`-skiplock` `boolean` :: +`--skiplock` `` :: Ignore locks - only root is allowed to use this option. @@ -468,48 +378,123 @@ Ignore locks - only root is allowed to use this option. Get help about specified command. -`` `string` :: +``: `` :: Command name -`-verbose` `boolean` :: +`--verbose` `` :: Verbose output format. +*qm importdisk* ` ` `[OPTIONS]` + +Import an external disk image as an unused disk in a VM. The + image format has to be supported by qemu-img(1). + +``: ` (1 - N)` :: + +The (unique) ID of the VM. + +``: `` :: + +Path to the disk image to import + +``: `` :: + +Target storage ID + +`--format` `` :: + +Target format + + + +*qm importovf* ` ` `[OPTIONS]` + +Create a new VM using parameters read from an OVF manifest + +``: ` (1 - N)` :: + +The (unique) ID of the VM. + +``: `` :: + +path to the ovf file + +``: `` :: + +Target storage ID + +`--dryrun` `` :: + +Print a parsed representation of the extracted OVF parameters, but do not create a VM + +`--format` `` :: + +Target format + + + + *qm list* `[OPTIONS]` Virtual machine index (per node). -`-full` `boolean` :: +`--full` `` :: Determine the full status of active VMs. +*qm listsnapshot* `` + +List all snapshots. + +``: ` (1 - N)` :: + +The (unique) ID of the VM. + + + *qm migrate* ` ` `[OPTIONS]` Migrate virtual machine. Creates a new migration task. -`` `integer (1 - N)` :: +``: ` (1 - N)` :: The (unique) ID of the VM. -`` `string` :: +``: `` :: Target node. -`-force` `boolean` :: +`--force` `` :: + +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. +`--migration_network` `` :: -`-online` `boolean` :: +CIDR of the (sub) network that is used for migration. + +`--migration_type` `` :: + +Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance. + +`--online` `` :: Use online/live migration. +`--targetstorage` `` :: + +Default target storage. + +`--with-local-disks` `` :: + +Enable live storage migration for local disk + @@ -517,7 +502,7 @@ Use online/live migration. Enter Qemu Monitor interface. -`` `integer (1 - N)` :: +``: ` (1 - N)` :: The (unique) ID of the VM. @@ -528,29 +513,27 @@ The (unique) ID of the VM. Move volume to different storage. -`` `integer (1 - N)` :: +``: ` (1 - N)` :: The (unique) ID of the VM. -`` `(ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi2 | scsi3 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9)` :: +``: `` :: The disk you want to move. -`` `string` :: +``: `` :: Target storage. -`-delete` `boolean` (default=`0`):: +`--delete` `` ('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` :: +`--digest` `` :: -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)` :: +`--format` `` :: Target Format. @@ -563,12 +546,22 @@ Used by qmigrate - do not use manually. +*qm nbdstop* `` + +Stop embedded nbd server. + +``: ` (1 - N)` :: + +The (unique) ID of the VM. + + + *qm pending* `` Get virtual machine configuration, including pending changes. -`` `integer (1 - N)` :: +``: ` (1 - N)` :: The (unique) ID of the VM. @@ -579,7 +572,7 @@ The (unique) ID of the VM. Rescan all storages and update disk sizes and unused disk images. -`-vmid` `integer (1 - N)` :: +`--vmid` ` (1 - N)` :: The (unique) ID of the VM. @@ -590,11 +583,11 @@ The (unique) ID of the VM. Reset virtual machine. -`` `integer (1 - N)` :: +``: ` (1 - N)` :: The (unique) ID of the VM. -`-skiplock` `boolean` :: +`--skiplock` `` :: Ignore locks - only root is allowed to use this option. @@ -604,26 +597,23 @@ Ignore locks - only root is allowed to use this option. Extend volume size. -`` `integer (1 - N)` :: +``: ` (1 - N)` :: The (unique) ID of the VM. -`` `(ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi2 | scsi3 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9)` :: +``: `` :: The disk you want to resize. -`` `\+?\d+(\.\d+)?[KMGT]?` :: +``: `\+?\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` :: +`--digest` `` :: -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` :: +`--skiplock` `` :: Ignore locks - only root is allowed to use this option. @@ -633,15 +623,15 @@ Ignore locks - only root is allowed to use this option. Resume virtual machine. -`` `integer (1 - N)` :: +``: ` (1 - N)` :: The (unique) ID of the VM. -`-nocheck` `boolean` :: +`--nocheck` `` :: no description available -`-skiplock` `boolean` :: +`--skiplock` `` :: Ignore locks - only root is allowed to use this option. @@ -651,11 +641,11 @@ Ignore locks - only root is allowed to use this option. Rollback VM state to specified snapshot. -`` `integer (1 - N)` :: +``: ` (1 - N)` :: The (unique) ID of the VM. -`` `string` :: +``: `` :: The name of the snapshot. @@ -665,15 +655,15 @@ The name of the snapshot. Send key event to virtual machine. -`` `integer (1 - N)` :: +``: ` (1 - N)` :: The (unique) ID of the VM. -`` `string` :: +``: `` :: The key (qemu monitor encoding). -`-skiplock` `boolean` :: +`--skiplock` `` :: Ignore locks - only root is allowed to use this option. @@ -685,366 +675,259 @@ Set virtual machine options (synchrounous API) - You should consider using the POST method instead for any actions involving hotplug or storage allocation. -`` `integer (1 - N)` :: +``: ` (1 - N)` :: The (unique) ID of the VM. -`-acpi` `boolean` (default=`1`):: +`--acpi` `` ('default =' `1`):: Enable/disable ACPI. -`-agent` `boolean` (default=`0`):: +`--agent` `` ('default =' `0`):: Enable/disable Qemu GuestAgent. -`-args` `string` :: +`--args` `` :: -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`):: +`--autostart` `` ('default =' `0`):: Automatic restart after crash (currently ignored). -`-balloon` `integer (0 - N)` :: +`--balloon` ` (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`):: +`--bios` `` ('default =' `seabios`):: Select BIOS implementation. -`-boot` `[acdn]{1,4}` (default=`cdn`):: +`--boot` `[acdn]{1,4}` ('default =' `cdn`):: Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n). -`-bootdisk` `(ide|sata|scsi|virtio)\d+` :: +`--bootdisk` `(ide|sata|scsi|virtio)\d+` :: Enable booting from specified disk. -`-cdrom` `volume` :: +`--cdrom` `` :: This is an alias for option -ide2 -`-cores` `integer (1 - N)` (default=`1`):: +`--cores` ` (1 - N)` ('default =' `1`):: The number of cores per socket. -`-cpu` `[cputype=] [,hidden=<1|0>]` :: +`--cpu` `[cputype=] [,hidden=<1|0>]` :: Emulated CPU type. -`-cpulimit` `number (0 - 128)` (default=`0`):: +`--cpulimit` ` (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`):: +`--cpuunits` ` (2 - 262144)` ('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 -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` :: +`--delete` `` :: A list of settings you want to delete. -`-description` `string` :: +`--description` `` :: + +Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file. + +`--digest` `` :: -Description for the VM. Only used on the configuration web interface. This -is saved as comment inside the configuration file. +Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. -`-digest` `string` :: +`--efidisk0` `[file=] [,format=] [,size=]` :: -Prevent changes if current configuration file has different SHA1 digest. -This can be used to prevent concurrent modifications. +Configure a Disk for storing EFI vars -`-force` `boolean` :: +`--force` `` :: -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` `boolean` :: +`--freeze` `` :: Freeze CPU at startup (use 'c' monitor command to start execution). -`-hostpci[n]` `[host=] [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]` :: +`--hostpci[n]` `[host=] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=] [,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`):: +`--hotplug` `` ('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=] [,aio=] [,backup=] [,bps=] [,bps_rd=] [,bps_wr=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_rd=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_max=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,rerror=] [,secs=] [,serial=] [,snapshot=] [,trans=] [,werror=]` :: +`--hugepages` `<1024 | 2 | any>` :: + +Enable/disable hugepages memory. + +`--ide[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). -`-keyboard` `(da | de | de-ch | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sl | sv | tr)` (default=`en-us`):: +`--keyboard` `` ('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`):: +`--kvm` `` ('default =' `1`):: Enable/disable KVM hardware virtualization. -`-localtime` `boolean` :: +`--localtime` `` :: -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)` :: +`--lock` `` :: Lock/unlock the VM. -`-machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` :: +`--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` :: Specific the Qemu machine type. -`-memory` `integer (16 - N)` (default=`512`):: +`--memory` ` (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`):: +`--migrate_downtime` ` (0 - N)` ('default =' `0.1`):: Set maximum tolerated downtime (in seconds) for migrations. -`-migrate_speed` `integer (0 - N)` (default=`0`):: +`--migrate_speed` ` (0 - N)` ('default =' `0`):: Set maximum speed (in MB/s) for migrations. Value 0 is no limit. -`-name` `string` :: +`--name` `` :: Set a name for the VM. Only used on the configuration web interface. -`-net[n]` `string` :: +`--net[n]` `[model=] [,bridge=] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=] [,queues=] [,rate=] [,tag=] [,trunks=] [,=]` :: 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` `` ('default =' `0`):: Enable/disable NUMA. -`-numa[n]` `cpus= [,hostnodes=] [,memory=] [,policy=]` :: +`--numa[n]` `cpus= [,hostnodes=] [,memory=] [,policy=]` :: -numa topology +NUMA topology. -`-onboot` `boolean` (default=`0`):: +`--onboot` `` ('default =' `0`):: Specifies whether a VM will be started during system bootup. -`-ostype` `(l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win7 | win8 | wvista | wxp)` :: +`--ostype` `` :: -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+` :: +`--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`):: +`--protection` `` ('default =' `0`):: -Sets the protection flag of the VM. This will prevent the remove operation. +Sets the protection flag of the VM. This will disable the remove VM and remove disk operations. -`-reboot` `boolean` (default=`1`):: +`--reboot` `` ('default =' `1`):: Allow reboot. If set to '0' the VM exit on reboot. -`-revert` `string` :: +`--revert` `` :: Revert a pending change. -`-sata[n]` `[file=] [,aio=] [,backup=] [,bps=] [,bps_rd=] [,bps_wr=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_rd=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_max=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,rerror=] [,secs=] [,serial=] [,snapshot=] [,trans=] [,werror=]` :: +`--sata[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). -`-scsi[n]` `[file=] [,aio=] [,backup=] [,bps=] [,bps_rd=] [,bps_wr=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_rd=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_max=] [,iothread=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,secs=] [,serial=] [,snapshot=] [,trans=] [,werror=]` :: +`--scsi[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,replicate=<1|0>] [,rerror=] [,scsiblock=<1|0>] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: Use volume as SCSI hard disk or CD-ROM (n is 0 to 13). -`-scsihw` `(lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single)` (default=`lsi`):: +`--scsihw` `` ('default =' `lsi`):: -scsi controller model +SCSI controller model -`-serial[n]` `(/dev/.+|socket)` :: +`--serial[n]` `(/dev/.+|socket)` :: -Create a serial device inside the VM (n is 0 to 3), and pass through a host -serial device (i.e. /dev/ttyS0), or create a unix socket on the host side -(use 'qm terminal' to open a terminal connection). -+ -NOTE: If you pass through a host serial device, it is no longer possible to -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`):: +`--shares` ` (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` :: +`--skiplock` `` :: Ignore locks - only root is allowed to use this option. -`-smbios1` `[family=] [,manufacturer=] [,product=] [,serial=] [,sku=] [,uuid=] [,version=]` :: +`--smbios1` `[family=] [,manufacturer=] [,product=] [,serial=] [,sku=] [,uuid=] [,version=]` :: Specify SMBIOS type 1 fields. -`-smp` `integer (1 - N)` (default=`1`):: +`--smp` ` (1 - N)` ('default =' `1`):: The number of CPUs. Please use option -sockets instead. -`-sockets` `integer (1 - N)` (default=`1`):: +`--sockets` ` (1 - N)` ('default =' `1`):: The number of CPU sockets. -`-startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` (default=`now`):: +`--startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`):: -Set the initial date of the real time clock. Valid format for date are: -'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` `[[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`):: +`--tablet` `` ('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`):: +`--tdf` `` ('default =' `0`):: Enable/disable time drift fix. -`-template` `boolean` (default=`0`):: +`--template` `` ('default =' `0`):: Enable/disable Template. -`-unused[n]` `string` :: +`--unused[n]` `` :: -Reference to unused volumes. +Reference to unused volumes. This is used internally, and should not be modified manually. -`-usb[n]` `[host=] [,usb3=]` :: +`--usb[n]` `[host=] [,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`):: +`--vcpus` ` (1 - N)` ('default =' `0`):: Number of hotplugged vcpus. -`-vga` `(cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware)` :: +`--vga` `` :: -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=] [,aio=] [,backup=] [,bps=] [,bps_rd=] [,bps_wr=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_rd=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_max=] [,iothread=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,rerror=] [,secs=] [,serial=] [,snapshot=] [,trans=] [,werror=]` :: +`--virtio[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: Use volume as VIRTIO hard disk (n is 0 to 15). -`-watchdog` `[action=] [,[model=]]` :: +`--vmstatestorage` `` :: -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) +Default storage for VM state volumes/files. + +`--watchdog` `[[model=]] [,action=]` :: + +Create a virtual hardware watchdog device. @@ -1053,7 +936,7 @@ action specified) Show command line which is used to start the VM (debug info). -`` `integer (1 - N)` :: +``: ` (1 - N)` :: The (unique) ID of the VM. @@ -1066,23 +949,23 @@ 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. -`` `integer (1 - N)` :: +``: ` (1 - N)` :: The (unique) ID of the VM. -`-forceStop` `boolean` (default=`0`):: +`--forceStop` `` ('default =' `0`):: Make sure the VM stops. -`-keepActive` `boolean` (default=`0`):: +`--keepActive` `` ('default =' `0`):: -Do not decativate storage volumes. +Do not deactivate storage volumes. -`-skiplock` `boolean` :: +`--skiplock` `` :: Ignore locks - only root is allowed to use this option. -`-timeout` `integer (0 - N)` :: +`--timeout` ` (0 - N)` :: Wait maximal timeout seconds. @@ -1092,19 +975,19 @@ Wait maximal timeout seconds. Snapshot a VM. -`` `integer (1 - N)` :: +``: ` (1 - N)` :: The (unique) ID of the VM. -`` `string` :: +``: `` :: The name of the snapshot. -`-description` `string` :: +`--description` `` :: A textual description or comment. -`-vmstate` `boolean` :: +`--vmstate` `` :: Save the vmstate @@ -1114,26 +997,38 @@ Save the vmstate Start virtual machine. -`` `integer (1 - N)` :: +``: ` (1 - N)` :: The (unique) ID of the VM. -`-machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` :: +`--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` :: Specific the Qemu machine type. -`-migratedfrom` `string` :: +`--migratedfrom` `` :: The cluster node name. -`-skiplock` `boolean` :: +`--migration_network` `` :: + +CIDR of the (sub) network that is used for migration. + +`--migration_type` `` :: + +Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance. + +`--skiplock` `` :: Ignore locks - only root is allowed to use this option. -`-stateuri` `string` :: +`--stateuri` `` :: Some command save/restore state from this location. +`--targetstorage` `` :: + +Target storage for the migration. (Can be '1' to use the same storage id as on the source node.) + @@ -1141,11 +1036,11 @@ Some command save/restore state from this location. Show VM status. -`` `integer (1 - N)` :: +``: ` (1 - N)` :: The (unique) ID of the VM. -`-verbose` `boolean` :: +`--verbose` `` :: Verbose output format @@ -1157,23 +1052,23 @@ Verbose output format 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 -`` `integer (1 - N)` :: +``: ` (1 - N)` :: The (unique) ID of the VM. -`-keepActive` `boolean` (default=`0`):: +`--keepActive` `` ('default =' `0`):: -Do not decativate storage volumes. +Do not deactivate storage volumes. -`-migratedfrom` `string` :: +`--migratedfrom` `` :: The cluster node name. -`-skiplock` `boolean` :: +`--skiplock` `` :: Ignore locks - only root is allowed to use this option. -`-timeout` `integer (0 - N)` :: +`--timeout` ` (0 - N)` :: Wait maximal timeout seconds. @@ -1183,11 +1078,11 @@ Wait maximal timeout seconds. Suspend virtual machine. -`` `integer (1 - N)` :: +``: ` (1 - N)` :: The (unique) ID of the VM. -`-skiplock` `boolean` :: +`--skiplock` `` :: Ignore locks - only root is allowed to use this option. @@ -1197,11 +1092,11 @@ Ignore locks - only root is allowed to use this option. Create a Template. -`` `integer (1 - N)` :: +``: ` (1 - N)` :: The (unique) ID of the VM. -`-disk` `(ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi2 | scsi3 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9)` :: +`--disk` `` :: If you want to convert only 1 disk to base image. @@ -1213,34 +1108,30 @@ If you want to convert only 1 disk to base image. Open a terminal using a serial device (The VM need to have a serial device configured, for example 'serial0: socket') -`` `integer (1 - N)` :: +``: ` (1 - N)` :: The (unique) ID of the VM. -`-iface` `(serial0 | serial1 | serial2 | serial3)` :: +`--iface` `` :: -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. -*qm unlink* ` -idlist ` `[OPTIONS]` +*qm unlink* ` --idlist ` `[OPTIONS]` Unlink/delete disk images. -`` `integer (1 - N)` :: +``: ` (1 - N)` :: The (unique) ID of the VM. -`-force` `boolean` :: +`--force` `` :: -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` :: +`--idlist` `` :: A list of disk IDs you want to delete. @@ -1251,7 +1142,7 @@ A list of disk IDs you want to delete. Unlock the VM. -`` `integer (1 - N)` :: +``: ` (1 - N)` :: The (unique) ID of the VM. @@ -1261,7 +1152,7 @@ The (unique) ID of the VM. Proxy VM VNC traffic to stdin/stdout -`` `integer (1 - N)` :: +``: ` (1 - N)` :: The (unique) ID of the VM. @@ -1271,11 +1162,11 @@ The (unique) ID of the VM. Wait until the VM is stopped. -`` `integer (1 - N)` :: +``: ` (1 - N)` :: The (unique) ID of the VM. -`-timeout` `integer (1 - N)` :: +`--timeout` ` (1 - N)` :: Timeout in seconds. Default is to wait forever.