X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=qm.1-synopsis.adoc;h=4f3138d1011834d4ce317a0ce1d12fd60f630aa7;hb=00271f41dbff6bfcce1389bd904337c823dc2d64;hp=054436e45dbb91ac3a33162240954d25d20f5433;hpb=2489d6df4ac5e916ae18401310bfd1e69c993e55;p=pve-docs.git diff --git a/qm.1-synopsis.adoc b/qm.1-synopsis.adoc index 054436e..4f3138d 100644 --- a/qm.1-synopsis.adoc +++ b/qm.1-synopsis.adoc @@ -1,18 +1,25 @@ *qm* ` [ARGS] [OPTIONS]` -*qm agent* ` ` +*qm agent* -Execute Qemu Guest Agent commands. +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. -``: `` :: +``: `` :: -The QGA command. +Indicates if qemu shutdown cleanly. +``: `` :: +Indicates if the shutdown was requested by the guest or via qmp. *qm clone* ` ` `[OPTIONS]` @@ -26,19 +33,21 @@ The (unique) ID of the VM. VMID for the clone. +`--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` `` :: -Target format for file storage. -+ -NOTE: Requires option(s): `full` +Target format for file storage. Only valid for full clone. -`--full` `` ('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` `` :: @@ -55,19 +64,28 @@ The name of the snapshot. `--storage` `` :: Target storage for full clone. -+ -NOTE: Requires option(s): `full` `--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). +Get the virtual machine configuration with pending configuration changes +applied. Set the 'current' parameter to get the current configuration +instead. ``: ` (1 - N)` :: @@ -77,7 +95,9 @@ The (unique) ID of the VM. Get current values (instead of pending values). +`--snapshot` `` :: +Fetch config values from given snapshot. *qm create* `` `[OPTIONS]` @@ -91,18 +111,26 @@ The (unique) ID of the VM. Enable/disable ACPI. -`--agent` `` ('default =' `0`):: +`--agent` `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>] [,type=]` :: -Enable/disable Qemu GuestAgent. +Enable/disable Qemu GuestAgent and its properties. + +`--arch` `` :: + +Virtual processor architecture. Defaults to the host. `--archive` `` :: -The backup file. +The backup archive. Either the file system path to a .tar or .vma file (use '-' to pipe data from stdin) or a proxmox storage backup volume identifier. `--args` `` :: Arbitrary arguments passed to kvm. +`--audio0` `device= [,driver=]` :: + +Configure a audio device, useful in combination with QXL/Spice. + `--autostart` `` ('default =' `0`):: Automatic restart after crash (currently ignored). @@ -115,23 +143,43 @@ Amount of target RAM for the VM in MB. Using zero disables the ballon driver. Select BIOS implementation. -`--boot` `[acdn]{1,4}` ('default =' `cdn`):: +`--boot` `[[legacy=]<[acdn]{1,4}>] [,order=]` :: -Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n). +Specify guest boot order. Use with 'order=', usage with no key or 'legacy=' is deprecated. `--bootdisk` `(ide|sata|scsi|virtio)\d+` :: -Enable booting from specified disk. +Enable booting from specified disk. Deprecated: Use 'boot: order=foo;bar' instead. + +`--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 +`--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=] [,phys-bits=<8-64|host>] [,reported-model=]` :: Emulated CPU type. @@ -145,11 +193,11 @@ CPU weight for a VM. `--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. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file. `--efidisk0` `[file=] [,format=] [,size=]` :: -Configure a Disk for storing EFI vars +Configure a Disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. `--force` `` :: @@ -161,7 +209,11 @@ NOTE: Requires option(s): `archive` Freeze CPU at startup (use 'c' monitor command to start execution). -`--hostpci[n]` `[host=] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=] [,x-vga=<1|0>]` :: +`--hookscript` `` :: + +Script that will be executed during various steps in the vms lifetime. + +`--hostpci[n]` `[host=] [,legacy-igd=<1|0>] [,mdev=] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=] [,x-vga=<1|0>]` :: Map host PCI devices into guest. @@ -173,29 +225,57 @@ Selectively enable hotplug features. This is a comma separated list of hotplug f 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=]` :: +`--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). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. + +`--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. This requires +cloud-init 19.4 or newer. ++ +If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using +dhcp on IPv4. -Use volume as IDE hard disk or CD-ROM (n is 0 to 3). +`--ivshmem` `size= [,name=]` :: -`--keyboard` `` ('default =' `en-us`):: +Inter-VM shared memory. Useful for direct communication between VMs, or to the host. -Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file. +`--keephugepages` `` ('default =' `0`):: + +Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts. + +`--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. +`--live-restore` `` :: + +Start the VM immediately from the backup and restore in background. PBS only. ++ +NOTE: Requires option(s): `archive` + `--localtime` `` :: Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS. -`--lock` `` :: +`--lock` `` :: Lock/unlock the VM. -`--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` :: +`--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` :: -Specific the Qemu machine type. +Specifies the Qemu machine type. `--memory` ` (16 - N)` ('default =' `512`):: @@ -213,7 +293,13 @@ Set maximum speed (in MB/s) for migrations. Value 0 is no limit. 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=] [,mtu=] [,queues=] [,rate=] [,tag=] [,trunks=] [,=]` :: Specify network devices. @@ -249,27 +335,37 @@ Sets the protection flag of the VM. This will disable the remove VM and remove d 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_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=]` :: +`--rng0` `[source=] [,max_bytes=] [,period=]` :: + +Configure a VirtIO-based Random Number Generator. + +`--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). +Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. -`--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=]` :: +`--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). +Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. `--scsihw` `` ('default =' `lsi`):: SCSI controller model +`--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` ` (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. @@ -281,9 +377,21 @@ The number of CPUs. Please use option -sockets instead. The number of CPU sockets. +`--spice_enhancements` `[foldersharing=<1|0>] [,videostreaming=]` :: + +Configure additional enhancements for SPICE. + +`--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'. +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+] ` :: @@ -297,6 +405,10 @@ Default storage. Enable/disable the USB tablet device. +`--tags` `` :: + +Tags of the VM. This is only meta information. + `--tdf` `` ('default =' `0`):: Enable/disable time drift fix. @@ -311,7 +423,7 @@ Assign a unique random ethernet address. + NOTE: Requires option(s): `archive` -`--unused[n]` `` :: +`--unused[n]` `[file=]` :: Reference to unused volumes. This is used internally, and should not be modified manually. @@ -323,13 +435,17 @@ Configure an USB device (n is 0 to 4). Number of hotplugged vcpus. -`--vga` `` :: +`--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_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=]` :: +`--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). +Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. + +`--vmgenid` `` ('default =' `1 (autogenerated)`):: + +Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly. `--vmstatestorage` `` :: @@ -339,8 +455,6 @@ Default storage for VM state volumes/files. Create a virtual hardware watchdog device. - - *qm delsnapshot* ` ` `[OPTIONS]` Delete a VM snapshot. @@ -357,37 +471,102 @@ The name of the snapshot. For removal from config file, even if removing disk snapshots fails. - - *qm destroy* `` `[OPTIONS]` -Destroy the vm (also delete all used/owned volumes). +Destroy the VM and all used/owned volumes. Removes any VM specific +permissions and firewall rules ``: ` (1 - N)` :: The (unique) ID of the VM. +`--destroy-unreferenced-disks` `` ('default =' `0`):: + +If set, destroy additionally all disks not referenced in the config but with a matching VMID from all enabled storages. + +`--purge` `` :: + +Remove VMID from configurations, like backup & replication jobs and HA. + `--skiplock` `` :: Ignore locks - only root is allowed to use this option. +*qm guest cmd* ` ` +Execute Qemu Guest Agent commands. +``: ` (1 - N)` :: -*qm help* `[]` `[OPTIONS]` +The (unique) ID of the VM. -Get help about specified command. +``: `` :: -``: `` :: +The QGA command. -Command name +*qm guest exec* ` []` `[OPTIONS]` -`--verbose` `` :: +Executes the given command via the guest agent -Verbose output format. +``: ` (1 - N)` :: + +The (unique) ID of the VM. + +``: `` :: + +Extra arguments as array +`--pass-stdin` `` ('default =' `0`):: +When set, read STDIN until EOF and forward to guest agent via 'input-data' (usually treated as STDIN to process launched by guest agent). Allows maximal 1 MiB. +`--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. + +``: `` :: + +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. + +`--extra-args` `` :: + +Shows help for a specific command + +`--verbose` `` :: + +Verbose output format. *qm importdisk* ` ` `[OPTIONS]` @@ -410,8 +589,6 @@ Target storage ID Target format - - *qm importovf* ` ` `[OPTIONS]` Create a new VM using parameters read from an OVF manifest @@ -436,9 +613,6 @@ Print a parsed representation of the extracted OVF parameters, but do not create Target format - - - *qm list* `[OPTIONS]` Virtual machine index (per node). @@ -447,8 +621,6 @@ Virtual machine index (per node). Determine the full status of active VMs. - - *qm listsnapshot* `` List all snapshots. @@ -457,8 +629,6 @@ List all snapshots. The (unique) ID of the VM. - - *qm migrate* ` ` `[OPTIONS]` Migrate virtual machine. Creates a new migration task. @@ -471,6 +641,10 @@ The (unique) ID of the VM. Target node. +`--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. @@ -485,19 +659,16 @@ Migration traffic is encrypted using an SSH tunnel by default. On secure, comple `--online` `` :: -Use online/live migration. +Use online/live migration if VM is running. Ignored if VM is stopped. `--targetstorage` `` :: -Default target storage. +Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. `--with-local-disks` `` :: Enable live storage migration for local disk - - - *qm monitor* `` Enter Qemu Monitor interface. @@ -506,9 +677,6 @@ Enter Qemu Monitor interface. The (unique) ID of the VM. - - - *qm move_disk* ` ` `[OPTIONS]` Move volume to different storage. @@ -517,7 +685,7 @@ Move volume to different storage. The (unique) ID of the VM. -``: `` :: +``: `` :: The disk you want to move. @@ -525,6 +693,10 @@ The disk you want to move. Target storage. +`--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. @@ -537,15 +709,10 @@ Prevent changes if current configuration file has different SHA1 digest. This ca Target Format. - - - *qm mtunnel* Used by qmigrate - do not use manually. - - *qm nbdstop* `` Stop embedded nbd server. @@ -554,30 +721,38 @@ Stop embedded nbd server. The (unique) ID of the VM. +*qm pending* `` +Get the virtual machine configuration with both current and pending values. +``: ` (1 - N)` :: -*qm pending* `` +The (unique) ID of the VM. + +*qm reboot* `` `[OPTIONS]` -Get virtual machine configuration, including pending changes. +Reboot the VM by shutting it down, and starting it again. Applies pending +changes. ``: ` (1 - N)` :: The (unique) ID of the VM. +`--timeout` ` (0 - N)` :: - +Wait maximal timeout seconds for the shutdown. *qm rescan* `[OPTIONS]` Rescan all storages and update disk sizes and unused disk images. -`--vmid` ` (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]` @@ -591,8 +766,6 @@ The (unique) ID of the VM. Ignore locks - only root is allowed to use this option. - - *qm resize* ` ` `[OPTIONS]` Extend volume size. @@ -601,7 +774,7 @@ Extend volume size. The (unique) ID of the VM. -``: `` :: +``: `` :: The disk you want to resize. @@ -617,8 +790,6 @@ Prevent changes if current configuration file has different SHA1 digest. This ca Ignore locks - only root is allowed to use this option. - - *qm resume* `` `[OPTIONS]` Resume virtual machine. @@ -635,8 +806,6 @@ no description available Ignore locks - only root is allowed to use this option. - - *qm rollback* ` ` Rollback VM state to specified snapshot. @@ -649,8 +818,6 @@ The (unique) ID of the VM. The name of the snapshot. - - *qm sendkey* ` ` `[OPTIONS]` Send key event to virtual machine. @@ -667,8 +834,6 @@ The key (qemu monitor encoding). Ignore locks - only root is allowed to use this option. - - *qm set* `` `[OPTIONS]` Set virtual machine options (synchrounous API) - You should consider using @@ -683,14 +848,22 @@ The (unique) ID of the VM. Enable/disable ACPI. -`--agent` `` ('default =' `0`):: +`--agent` `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>] [,type=]` :: -Enable/disable Qemu GuestAgent. +Enable/disable Qemu GuestAgent and its properties. + +`--arch` `` :: + +Virtual processor architecture. Defaults to the host. `--args` `` :: Arbitrary arguments passed to kvm. +`--audio0` `device= [,driver=]` :: + +Configure a audio device, useful in combination with QXL/Spice. + `--autostart` `` ('default =' `0`):: Automatic restart after crash (currently ignored). @@ -703,23 +876,39 @@ Amount of target RAM for the VM in MB. Using zero disables the ballon driver. Select BIOS implementation. -`--boot` `[acdn]{1,4}` ('default =' `cdn`):: +`--boot` `[[legacy=]<[acdn]{1,4}>] [,order=]` :: -Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n). +Specify guest boot order. Use with 'order=', usage with no key or 'legacy=' is deprecated. `--bootdisk` `(ide|sata|scsi|virtio)\d+` :: -Enable booting from specified disk. +Enable booting from specified disk. Deprecated: Use 'boot: order=foo;bar' instead. `--cdrom` `` :: This is an alias for option -ide2 +`--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=] [,phys-bits=<8-64|host>] [,reported-model=]` :: Emulated CPU type. @@ -737,7 +926,7 @@ A list of settings you want to delete. `--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. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file. `--digest` `` :: @@ -745,7 +934,7 @@ Prevent changes if current configuration file has different SHA1 digest. This ca `--efidisk0` `[file=] [,format=] [,size=]` :: -Configure a Disk for storing EFI vars +Configure a Disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. `--force` `` :: @@ -757,7 +946,11 @@ NOTE: Requires option(s): `delete` Freeze CPU at startup (use 'c' monitor command to start execution). -`--hostpci[n]` `[host=] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=] [,x-vga=<1|0>]` :: +`--hookscript` `` :: + +Script that will be executed during various steps in the vms lifetime. + +`--hostpci[n]` `[host=] [,legacy-igd=<1|0>] [,mdev=] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=] [,x-vga=<1|0>]` :: Map host PCI devices into guest. @@ -769,13 +962,35 @@ Selectively enable hotplug features. This is a comma separated list of hotplug f 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=]` :: +`--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). +Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. -`--keyboard` `` ('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. This requires +cloud-init 19.4 or newer. ++ +If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using +dhcp on IPv4. + +`--ivshmem` `size= [,name=]` :: + +Inter-VM shared memory. Useful for direct communication between VMs, or to the host. + +`--keephugepages` `` ('default =' `0`):: + +Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts. + +`--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`):: @@ -785,13 +1000,13 @@ Enable/disable KVM hardware virtualization. Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS. -`--lock` `` :: +`--lock` `` :: Lock/unlock the VM. -`--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` :: +`--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` :: -Specific the Qemu machine type. +Specifies the Qemu machine type. `--memory` ` (16 - N)` ('default =' `512`):: @@ -809,7 +1024,13 @@ Set maximum speed (in MB/s) for migrations. Value 0 is no limit. 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=] [,mtu=] [,queues=] [,rate=] [,tag=] [,trunks=] [,=]` :: Specify network devices. @@ -845,31 +1066,41 @@ Allow reboot. If set to '0' the VM exit on reboot. Revert a pending change. -`--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=]` :: +`--rng0` `[source=] [,max_bytes=] [,period=]` :: -Use volume as SATA hard disk or CD-ROM (n is 0 to 5). +Configure a VirtIO-based Random Number Generator. -`--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=]` :: +`--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 SCSI hard disk or CD-ROM (n is 0 to 13). +Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. + +`--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 30). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. `--scsihw` `` ('default =' `lsi`):: SCSI controller model +`--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` ` (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` `` :: 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. @@ -881,9 +1112,17 @@ The number of CPUs. Please use option -sockets instead. The number of CPU sockets. +`--spice_enhancements` `[foldersharing=<1|0>] [,videostreaming=]` :: + +Configure additional enhancements for SPICE. + +`--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'. +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+] ` :: @@ -893,6 +1132,10 @@ Startup and shutdown behavior. Order is a non-negative number defining the gener Enable/disable the USB tablet device. +`--tags` `` :: + +Tags of the VM. This is only meta information. + `--tdf` `` ('default =' `0`):: Enable/disable time drift fix. @@ -901,7 +1144,7 @@ Enable/disable time drift fix. Enable/disable Template. -`--unused[n]` `` :: +`--unused[n]` `[file=]` :: Reference to unused volumes. This is used internally, and should not be modified manually. @@ -913,13 +1156,17 @@ Configure an USB device (n is 0 to 4). Number of hotplugged vcpus. -`--vga` `` :: +`--vga` `[[type=]] [,memory=]` :: + +Configure the VGA hardware. -Select the VGA type. +`--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=]` :: -`--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). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. -Use volume as VIRTIO hard disk (n is 0 to 15). +`--vmgenid` `` ('default =' `1 (autogenerated)`):: + +Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly. `--vmstatestorage` `` :: @@ -929,10 +1176,7 @@ Default storage for VM state volumes/files. Create a virtual hardware watchdog device. - - - -*qm showcmd* `` +*qm showcmd* `` `[OPTIONS]` Show command line which is used to start the VM (debug info). @@ -940,8 +1184,13 @@ Show command line which is used to start the VM (debug info). 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]` @@ -969,8 +1218,6 @@ Ignore locks - only root is allowed to use this option. Wait maximal timeout seconds. - - *qm snapshot* ` ` `[OPTIONS]` Snapshot a VM. @@ -991,8 +1238,6 @@ A textual description or comment. Save the vmstate - - *qm start* `` `[OPTIONS]` Start virtual machine. @@ -1001,9 +1246,13 @@ Start virtual machine. The (unique) ID of the VM. -`--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` :: +`--force-cpu` `` :: + +Override QEMU's -cpu argument with the given string. -Specific the Qemu machine type. +`--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` :: + +Specifies the Qemu machine type. `--migratedfrom` `` :: @@ -1027,10 +1276,11 @@ 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.) - +Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. +`--timeout` ` (0 - N)` ('default =' `max(30, vm memory in GiB)`):: +Wait maximal timeout seconds. *qm status* `` `[OPTIONS]` @@ -1044,9 +1294,6 @@ The (unique) ID of the VM. Verbose output format - - - *qm stop* `` `[OPTIONS]` Stop virtual machine. The qemu process will exit immediately. Thisis akin @@ -1072,8 +1319,6 @@ Ignore locks - only root is allowed to use this option. Wait maximal timeout seconds. - - *qm suspend* `` `[OPTIONS]` Suspend virtual machine. @@ -1086,7 +1331,15 @@ The (unique) ID of the VM. 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]` @@ -1096,13 +1349,10 @@ Create a Template. The (unique) ID of the VM. -`--disk` `` :: +`--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 @@ -1112,12 +1362,13 @@ configured, for example 'serial0: socket') The (unique) ID of the VM. -`--iface` `` :: - -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]` @@ -1135,9 +1386,6 @@ Force physical removal. Without this, we simple remove the disk from the config A list of disk IDs you want to delete. - - - *qm unlock* `` Unlock the VM. @@ -1146,8 +1394,6 @@ Unlock the VM. The (unique) ID of the VM. - - *qm vncproxy* `` Proxy VM VNC traffic to stdin/stdout @@ -1156,8 +1402,6 @@ Proxy VM VNC traffic to stdin/stdout The (unique) ID of the VM. - - *qm wait* `` `[OPTIONS]` Wait until the VM is stopped. @@ -1171,5 +1415,3 @@ The (unique) ID of the VM. Timeout in seconds. Default is to wait forever. - -