X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=qm.1-synopsis.adoc;h=43c3022163a7460c60afcd1173161b629dadb61e;hp=fec08cf659b9f153afa66a1be14036d0c470ebdb;hb=dd1aa0e01624f5927fb65143c9a070672ccbeb92;hpb=de0983cb5feb38143ada8d2f9fa99d4f7102d497 diff --git a/qm.1-synopsis.adoc b/qm.1-synopsis.adoc index fec08cf..43c3022 100644 --- a/qm.1-synopsis.adoc +++ b/qm.1-synopsis.adoc @@ -1,857 +1,1109 @@ *qm* ` [ARGS] [OPTIONS]` +*qm agent* + +An alias for 'qm guest cmd'. + +*qm cleanup* ` ` + +Cleans up resources like tap devices, vgpus, etc. Called after a vm shuts +down, crashes, etc. + +``: ` (1 - N)` :: + +The (unique) ID of the VM. + +``: `` :: + +Indicates if qemu shutdown cleanly. + +``: `` :: + +Indicates if the shutdown was requested by the guest or via qmp. + *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` :: +`--bwlimit` ` (0 - N)` ('default =' `clone limit from datacenter or storage config`):: + +Override I/O bandwidth limit (in KiB/s). + +`--description` `` :: Description for the new VM. -`-format` `(qcow2 | raw | vmdk)` :: +`--format` `` :: -Target format for file storage. -+ -NOTE: Requires option(s): `full` +Target format for file storage. Only valid for full clone. -`-full` `boolean` (default=`0`):: +`--full` `` :: -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 disks. 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. +*qm cloudinit dump* ` ` + +Get automatically generated cloudinit config. + +``: ` (1 - N)` :: + +The (unique) ID of the VM. + +``: `` :: +Config type. *qm config* `` `[OPTIONS]` 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). +`--snapshot` `` :: +Fetch config values from given snapshot. *qm create* `` `[OPTIONS]` 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` `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>]` :: + +Enable/disable Qemu GuestAgent and its properties. + +`--arch` `` :: -Enable/disable Qemu GuestAgent. +Virtual processor architecture. Defaults to the host. -`-archive` `string` :: +`--archive` `` :: The backup file. -`-args` `string` :: +`--args` `` :: 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. -`-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` :: +`--bwlimit` ` (0 - N)` ('default =' `restore limit from datacenter or storage config`):: + +Override I/O bandwidth limit (in KiB/s). + +`--cdrom` `` :: This is an alias for option -ide2 -`-cores` `integer (1 - N)` (default=`1`):: +`--cicustom` `[meta=] [,network=] [,user=]` :: + +cloud-init: Specify custom files to replace the automatically generated ones at start. + +`--cipassword` `` :: + +cloud-init: Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords. + +`--citype` `` :: + +Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows. + +`--ciuser` `` :: + +cloud-init: User name to change ssh keys and password for instead of the image's configured default user. + +`--cores` ` (1 - N)` ('default =' `1`):: The number of cores per socket. -`-cpu` `[cputype=] [,hidden=<1|0>]` :: +`--cpu` `[cputype=] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=]` :: Emulated CPU type. -`-cpulimit` `number (0 - 128)` (default=`0`):: +`--cpulimit` ` (0 - 128)` ('default =' `0`):: Limit of CPU usage. -`-cpuunits` `integer (0 - 500000)` (default=`1024`):: +`--cpuunits` ` (2 - 262144)` ('default =' `1024`):: 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. -`-efidisk0` `[file=] [,format=] [,size=]` :: +`--efidisk0` `[file=] [,format=] [,size=]` :: Configure a Disk for storing EFI vars -`-force` `boolean` :: +`--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>]` :: +`--hookscript` `` :: + +Script that will be executed during various steps in the vms lifetime. + +`--hostpci[n]` `[host=] [,mdev=] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=] [,x-vga=<1|0>]` :: 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'. -`-hugepages` `(1024 | 2 | any)` :: +`--hugepages` `<1024 | 2 | any>` :: Enable/disable hugepages memory. -`-ide[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: +`--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=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: 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`):: +`--ipconfig[n]` `[gw=] [,gw6=] [,ip=] [,ip6=]` :: + +cloud-init: Specify IP addresses and gateways for the corresponding interface. ++ +IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. ++ +The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. +For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. ++ +If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. -Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file. +`--ivshmem` `size= [,name=]` :: -`-kvm` `boolean` (default=`1`):: +Inter-VM shared memory. Useful for direct communication between VMs, or to the host. + +`--keyboard` `` :: + +Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it. + +`--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. -`-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)?|virt(?:-\d+\.\d+)?)` :: -Specific the Qemu machine type. +Specifies 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. -`-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]` `[model=] [,bridge=] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=] [,queues=] [,rate=] [,tag=] [,trunks=] [,=]` :: +`--nameserver` `` :: + +cloud-init: Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set. + +`--net[n]` `[model=] [,bridge=] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=] [,queues=] [,rate=] [,tag=] [,trunks=] [,=]` :: Specify network devices. -`-numa` `boolean` (default=`0`):: +`--numa` `` ('default =' `0`):: Enable/disable NUMA. -`-numa[n]` `cpus= [,hostnodes=] [,memory=] [,policy=]` :: +`--numa[n]` `cpus= [,hostnodes=] [,memory=] [,policy=]` :: 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` `` :: 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). -`-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 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=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,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=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). -`-scsi[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,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=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: 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 -`-serial[n]` `(/dev/.+|socket)` :: +`--searchdomain` `` :: + +cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set. + +`--serial[n]` `(/dev/.+|socket)` :: 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. Auto-ballooning is done by pvestatd. -`-smbios1` `[family=] [,manufacturer=] [,product=] [,serial=] [,sku=] [,uuid=] [,version=]` :: +`--smbios1` `[base64=<1|0>] [,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`):: +`--sshkeys` `` :: + +cloud-init: Setup public SSH keys (one key per line, OpenSSH format). + +`--start` `` ('default =' `0`):: + +Start VM after it was created successfully. + +`--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'. -`-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. -`-storage` `string` :: +`--storage` `` :: Default storage. -`-tablet` `boolean` (default=`1`):: +`--tablet` `` ('default =' `1`):: 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. This is used internally, and should not be modified manually. -`-usb[n]` `[host=] [,usb3=<1|0>]` :: +`--usb[n]` `[host=] [,usb3=<1|0>]` :: 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` `[[type=]] [,memory=]` :: -Select the VGA type. +Configure the VGA hardware. -`-virtio[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,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=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: Use volume as VIRTIO hard disk (n is 0 to 15). -`-watchdog` `[[model=]] [,action=]` :: +`--vmgenid` `` ('default =' `1 (autogenerated)`):: -Create a virtual hardware watchdog device. +Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly. +`--vmstatestorage` `` :: +Default storage for VM state volumes/files. + +`--watchdog` `[[model=]] [,action=]` :: + +Create a virtual hardware watchdog device. *qm delsnapshot* ` ` `[OPTIONS]` 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. - - *qm destroy* `` `[OPTIONS]` 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. +*qm guest cmd* ` ` + +Execute Qemu Guest Agent commands. + +``: ` (1 - N)` :: + +The (unique) ID of the VM. + +``: `` :: + +The QGA command. + +*qm guest exec* ` []` `[OPTIONS]` + +Executes the given command via the guest agent +``: ` (1 - N)` :: +The (unique) ID of the VM. + +``: `` :: + +Extra arguments as array + +`--synchronous` `` ('default =' `1`):: + +If set to off, returns the pid immediately instead of waiting for the commmand to finish or the timeout. + +`--timeout` ` (0 - N)` ('default =' `30`):: + +The maximum time to wait synchronously for the command to finish. If reached, the pid gets returned. Set to 0 to deactivate + +*qm guest exec-status* ` ` + +Gets the status of the given pid started by the guest-agent + +``: ` (1 - N)` :: + +The (unique) ID of the VM. -*qm help* `[]` `[OPTIONS]` +``: `` :: + +The PID to query + +*qm guest passwd* ` ` `[OPTIONS]` + +Sets the password for the given user to the given password + +``: ` (1 - N)` :: + +The (unique) ID of the VM. + +``: `` :: + +The user to set the password for. + +`--crypted` `` ('default =' `0`):: + +set to 1 if the password has already been passed through crypt() + +*qm help* `[OPTIONS]` Get help about specified command. -`` `string` :: +`--extra-args` `` :: -Command name +Shows help for a specific command -`-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. -`` `integer (1 - N)` :: +``: ` (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` :: +`--bwlimit` ` (0 - N)` ('default =' `migrate limit from datacenter or storage config`):: + +Override I/O bandwidth limit (in KiB/s). + +`--force` `` :: Allow to migrate VMs which use local devices. Only root may use this option. -`-migration_network` `string` :: +`--migration_network` `` :: CIDR of the (sub) network that is used for migration. -`-migration_type` `(insecure | secure)` :: +`--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` `boolean` :: +`--online` `` :: Use online/live migration. +`--targetstorage` `` :: + +Default target storage. +`--with-local-disks` `` :: +Enable live storage migration for local disk *qm monitor* `` Enter Qemu Monitor interface. -`` `integer (1 - N)` :: +``: ` (1 - N)` :: The (unique) ID of the VM. - - - *qm move_disk* ` ` `[OPTIONS]` Move volume to different storage. -`` `integer (1 - N)` :: +``: ` (1 - N)` :: The (unique) ID of the VM. -`` `(efidisk0 | 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`):: +`--bwlimit` ` (0 - N)` ('default =' `move limit from datacenter or storage config`):: + +Override I/O bandwidth limit (in KiB/s). + +`--delete` `` ('default =' `0`):: 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. -`-format` `(qcow2 | raw | vmdk)` :: +`--format` `` :: Target Format. - - - *qm mtunnel* 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. - - - *qm rescan* `[OPTIONS]` Rescan all storages and update disk sizes and unused disk images. -`-vmid` `integer (1 - N)` :: - -The (unique) ID of the VM. +`--dryrun` `` ('default =' `0`):: +Do not actually write changes out to VM config(s). +`--vmid` ` (1 - N)` :: +The (unique) ID of the VM. *qm reset* `` `[OPTIONS]` 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. - - *qm resize* ` ` `[OPTIONS]` Extend volume size. -`` `integer (1 - N)` :: +``: ` (1 - N)` :: The (unique) ID of the VM. -`` `(efidisk0 | 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. -`-skiplock` `boolean` :: +`--skiplock` `` :: Ignore locks - only root is allowed to use this option. - - *qm resume* `` `[OPTIONS]` 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. - - *qm rollback* ` ` Rollback VM state to specified snapshot. -`` `integer (1 - N)` :: +``: ` (1 - N)` :: The (unique) ID of the VM. -`` `string` :: +``: `` :: The name of the snapshot. - - *qm sendkey* ` ` `[OPTIONS]` 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. - - *qm set* `` `[OPTIONS]` 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` `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>]` :: + +Enable/disable Qemu GuestAgent and its properties. + +`--arch` `` :: -Enable/disable Qemu GuestAgent. +Virtual processor architecture. Defaults to the host. -`-args` `string` :: +`--args` `` :: 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. -`-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`):: +`--cicustom` `[meta=] [,network=] [,user=]` :: + +cloud-init: Specify custom files to replace the automatically generated ones at start. + +`--cipassword` `` :: + +cloud-init: Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords. + +`--citype` `` :: + +Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows. + +`--ciuser` `` :: + +cloud-init: User name to change ssh keys and password for instead of the image's configured default user. + +`--cores` ` (1 - N)` ('default =' `1`):: The number of cores per socket. -`-cpu` `[cputype=] [,hidden=<1|0>]` :: +`--cpu` `[cputype=] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=]` :: Emulated CPU type. -`-cpulimit` `number (0 - 128)` (default=`0`):: +`--cpulimit` ` (0 - 128)` ('default =' `0`):: Limit of CPU usage. -`-cpuunits` `integer (0 - 500000)` (default=`1024`):: +`--cpuunits` ` (2 - 262144)` ('default =' `1024`):: 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` `string` :: +`--digest` `` :: Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. -`-efidisk0` `[file=] [,format=] [,size=]` :: +`--efidisk0` `[file=] [,format=] [,size=]` :: 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. + 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>]` :: +`--hookscript` `` :: + +Script that will be executed during various steps in the vms lifetime. + +`--hostpci[n]` `[host=] [,mdev=] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=] [,x-vga=<1|0>]` :: 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'. -`-hugepages` `(1024 | 2 | any)` :: +`--hugepages` `<1024 | 2 | any>` :: Enable/disable hugepages memory. -`-ide[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: +`--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=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: 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`):: +`--ipconfig[n]` `[gw=] [,gw6=] [,ip=] [,ip6=]` :: -Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file. +cloud-init: Specify IP addresses and gateways for the corresponding interface. ++ +IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. ++ +The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. +For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. ++ +If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. -`-kvm` `boolean` (default=`1`):: +`--ivshmem` `size= [,name=]` :: + +Inter-VM shared memory. Useful for direct communication between VMs, or to the host. + +`--keyboard` `` :: + +Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it. + +`--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. -`-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)?|virt(?:-\d+\.\d+)?)` :: -Specific the Qemu machine type. +Specifies 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. -`-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]` `[model=] [,bridge=] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=] [,queues=] [,rate=] [,tag=] [,trunks=] [,=]` :: +`--nameserver` `` :: + +cloud-init: Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set. + +`--net[n]` `[model=] [,bridge=] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=] [,queues=] [,rate=] [,tag=] [,trunks=] [,=]` :: Specify network devices. -`-numa` `boolean` (default=`0`):: +`--numa` `` ('default =' `0`):: Enable/disable NUMA. -`-numa[n]` `cpus= [,hostnodes=] [,memory=] [,policy=]` :: +`--numa[n]` `cpus= [,hostnodes=] [,memory=] [,policy=]` :: 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` `` :: 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). -`-protection` `boolean` (default=`0`):: +`--protection` `` ('default =' `0`):: 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=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,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=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: Use volume as SATA hard disk or CD-ROM (n is 0 to 5). -`-scsi[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,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=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: 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 -`-serial[n]` `(/dev/.+|socket)` :: +`--searchdomain` `` :: + +cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set. + +`--serial[n]` `(/dev/.+|socket)` :: 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. Auto-ballooning is done by pvestatd. -`-skiplock` `boolean` :: +`--skiplock` `` :: Ignore locks - only root is allowed to use this option. -`-smbios1` `[family=] [,manufacturer=] [,product=] [,serial=] [,sku=] [,uuid=] [,version=]` :: +`--smbios1` `[base64=<1|0>] [,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`):: +`--sshkeys` `` :: + +cloud-init: Setup public SSH keys (one key per line, OpenSSH format). + +`--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'. -`-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. -`-tablet` `boolean` (default=`1`):: +`--tablet` `` ('default =' `1`):: 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. This is used internally, and should not be modified manually. -`-usb[n]` `[host=] [,usb3=<1|0>]` :: +`--usb[n]` `[host=] [,usb3=<1|0>]` :: 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` `[[type=]] [,memory=]` :: -Select the VGA type. +Configure the VGA hardware. -`-virtio[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,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=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: Use volume as VIRTIO hard disk (n is 0 to 15). -`-watchdog` `[[model=]] [,action=]` :: +`--vmgenid` `` ('default =' `1 (autogenerated)`):: -Create a virtual hardware watchdog device. +Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly. + +`--vmstatestorage` `` :: +Default storage for VM state volumes/files. +`--watchdog` `[[model=]] [,action=]` :: +Create a virtual hardware watchdog device. -*qm showcmd* `` +*qm showcmd* `` `[OPTIONS]` Show command line which is used to start the VM (debug info). -`` `integer (1 - N)` :: +``: ` (1 - N)` :: The (unique) ID of the VM. +`--pretty` `` ('default =' `0`):: + +Puts each option on a new line to enhance human readability +`--snapshot` `` :: +Fetch config values from given snapshot. *qm shutdown* `` `[OPTIONS]` @@ -859,223 +1111,212 @@ 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 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. - - *qm snapshot* ` ` `[OPTIONS]` 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 - - *qm start* `` `[OPTIONS]` 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)?|virt(?:-\d+\.\d+)?)` :: -Specific the Qemu machine type. +Specifies the Qemu machine type. -`-migratedfrom` `string` :: +`--migratedfrom` `` :: The cluster node name. -`-migration_network` `string` :: +`--migration_network` `` :: CIDR of the (sub) network that is used for migration. -`-migration_type` `(insecure | secure)` :: +`--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` `boolean` :: +`--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.) *qm status* `` `[OPTIONS]` Show VM status. -`` `integer (1 - N)` :: +``: ` (1 - N)` :: The (unique) ID of the VM. -`-verbose` `boolean` :: +`--verbose` `` :: Verbose output format - - - *qm stop* `` `[OPTIONS]` 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 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. - - *qm suspend* `` `[OPTIONS]` 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. +`--statestorage` `` :: +The storage for the VM state ++ +NOTE: Requires option(s): `todisk` + +`--todisk` `` ('default =' `0`):: + +If set, suspends the VM to disk. Will be resumed on next VM start. *qm template* `` `[OPTIONS]` Create a Template. -`` `integer (1 - N)` :: +``: ` (1 - N)` :: The (unique) ID of the VM. -`-disk` `(efidisk0 | 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. - - - *qm terminal* `` `[OPTIONS]` 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)` :: - -Select the serial device. By default we simply use the first suitable device. +`--escape` `` ('default =' `^O`):: +Escape character. +`--iface` `` :: +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. -`-idlist` `string` :: +`--idlist` `` :: A list of disk IDs you want to delete. - - - *qm unlock* `` Unlock the VM. -`` `integer (1 - N)` :: +``: ` (1 - N)` :: The (unique) ID of the VM. - - *qm vncproxy* `` Proxy VM VNC traffic to stdin/stdout -`` `integer (1 - N)` :: +``: ` (1 - N)` :: The (unique) ID of the VM. - - *qm wait* `` `[OPTIONS]` 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. - -