X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=qm.1-synopsis.adoc;h=ff13c76bd05cacd7899a2fd52a43bfad7c738150;hp=fec08cf659b9f153afa66a1be14036d0c470ebdb;hb=5d9c884c7b3f4980abbd4cbe91ea588a03266485;hpb=de0983cb5feb38143ada8d2f9fa99d4f7102d497 diff --git a/qm.1-synopsis.adoc b/qm.1-synopsis.adoc index fec08cf..ff13c76 100644 --- a/qm.1-synopsis.adoc +++ b/qm.1-synopsis.adoc @@ -1,50 +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. -`-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. @@ -55,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). @@ -69,39 +83,39 @@ 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. -`-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). @@ -109,73 +123,73 @@ Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n). 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. -`-cpuunits` `integer (0 - 500000)` (default=`1024`):: +`-cpuunits` ` (0 - 500000)` ('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>]` :: +`-hostpci[n]` `[host=] [,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=] [,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 '/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. -`-lock` `(backup | migrate | rollback | snapshot)` :: +`-lock` `` :: Lock/unlock the VM. @@ -183,27 +197,27 @@ Lock/unlock the VM. 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. -`-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=] [,=]` :: +`-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. @@ -211,11 +225,11 @@ Enable/disable NUMA. 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. @@ -223,27 +237,27 @@ Specify guest operating system. 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=] [,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=<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=] [,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 @@ -251,7 +265,7 @@ SCSI controller model 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 @@ -259,15 +273,15 @@ Amount of memory shares for auto-ballooning. The larger the number is, the more 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'. @@ -275,29 +289,29 @@ Set the initial date of the real time clock. Valid format for date are: 'now' or 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. @@ -305,19 +319,19 @@ Reference to unused volumes. This is used internally, and should not be modified 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. -`-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=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: Use volume as VIRTIO hard disk (n is 0 to 15). -`-watchdog` `[[model=]] [,action=]` :: +`-watchdog` `[[model=]] [,action=]` :: Create a virtual hardware watchdog device. @@ -327,15 +341,15 @@ Create a virtual hardware watchdog device. 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. @@ -345,11 +359,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. @@ -360,22 +374,46 @@ 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 list* `[OPTIONS]` Virtual machine index (per node). -`-full` `boolean` :: +`-full` `` :: Determine the full status of active VMs. @@ -385,7 +423,7 @@ Determine the full status of active VMs. List all snapshots. -`` `integer (1 - N)` :: +``: ` (1 - N)` :: The (unique) ID of the VM. @@ -395,30 +433,38 @@ The (unique) ID of the VM. 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. -`-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 + @@ -426,7 +472,7 @@ Use online/live migration. Enter Qemu Monitor interface. -`` `integer (1 - N)` :: +``: ` (1 - N)` :: The (unique) ID of the VM. @@ -437,27 +483,27 @@ The (unique) ID of the VM. 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`):: +`-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. @@ -470,12 +516,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. @@ -486,7 +542,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. @@ -497,11 +553,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. @@ -511,23 +567,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. -`` `(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. @@ -537,15 +593,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. @@ -555,11 +611,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. @@ -569,15 +625,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. @@ -589,35 +645,35 @@ 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. -`-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). @@ -625,81 +681,81 @@ Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n). 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. -`-cpuunits` `integer (0 - 500000)` (default=`1024`):: +`-cpuunits` ` (0 - 500000)` ('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>]` :: +`-hostpci[n]` `[host=] [,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=] [,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 '/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. -`-lock` `(backup | migrate | rollback | snapshot)` :: +`-lock` `` :: Lock/unlock the VM. @@ -707,27 +763,27 @@ Lock/unlock the VM. 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. -`-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=] [,=]` :: +`-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. @@ -735,11 +791,11 @@ Enable/disable NUMA. 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. @@ -747,27 +803,27 @@ Specify guest operating system. 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=] [,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=<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=] [,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 @@ -775,11 +831,11 @@ SCSI controller model 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 -`-skiplock` `boolean` :: +`-skiplock` `` :: Ignore locks - only root is allowed to use this option. @@ -787,15 +843,15 @@ Ignore locks - only root is allowed to use this option. 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'. @@ -803,19 +859,19 @@ Set the initial date of the real time clock. Valid format for date are: 'now' or 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. @@ -823,19 +879,19 @@ Reference to unused volumes. This is used internally, and should not be modified 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. -`-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=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: Use volume as VIRTIO hard disk (n is 0 to 15). -`-watchdog` `[[model=]] [,action=]` :: +`-watchdog` `[[model=]] [,action=]` :: Create a virtual hardware watchdog device. @@ -846,7 +902,7 @@ Create a virtual hardware watchdog device. Show command line which is used to start the VM (debug info). -`` `integer (1 - N)` :: +``: ` (1 - N)` :: The (unique) ID of the VM. @@ -859,23 +915,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 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. @@ -885,19 +941,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 @@ -907,7 +963,7 @@ Save the vmstate Start virtual machine. -`` `integer (1 - N)` :: +``: ` (1 - N)` :: The (unique) ID of the VM. @@ -915,26 +971,30 @@ The (unique) ID of the VM. Specific 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.) + @@ -942,11 +1002,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 @@ -958,23 +1018,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 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. @@ -984,11 +1044,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. @@ -998,11 +1058,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` `(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. @@ -1014,11 +1074,11 @@ 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. @@ -1029,15 +1089,15 @@ Select the serial device. By default we simply use the first suitable device. 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. @@ -1048,7 +1108,7 @@ A list of disk IDs you want to delete. Unlock the VM. -`` `integer (1 - N)` :: +``: ` (1 - N)` :: The (unique) ID of the VM. @@ -1058,7 +1118,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. @@ -1068,11 +1128,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.