X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=qm.1-synopsis.adoc;h=301655494a143bb3f9031c32859c87b8d74138c7;hp=d8914dd23009cf85f5c59ae7891d21e4d872211c;hb=b84c51fae3c3dab3fd5ab91198cdea22f688c648;hpb=35a75dd36c05f79e9dda81147867878a55d839c1 diff --git a/qm.1-synopsis.adoc b/qm.1-synopsis.adoc index d8914dd..3016554 100644 --- a/qm.1-synopsis.adoc +++ b/qm.1-synopsis.adoc @@ -1,16 +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]` @@ -24,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` `` :: @@ -53,17 +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)` :: @@ -73,6 +95,10 @@ The (unique) ID of the VM. Get current values (instead of pending values). +`--snapshot` `` :: + +Fetch config values from given snapshot. + *qm create* `` `[OPTIONS]` Create or restore a virtual machine. @@ -85,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). @@ -117,15 +151,35 @@ Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n). Enable booting from specified disk. +`--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=] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>]` :: +`--cpu` `` :: Emulated CPU type. @@ -155,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. @@ -167,13 +225,28 @@ 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). +`--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. + +`--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.conf' configuration file.It should not be necessary to set it. +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`):: @@ -183,13 +256,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`):: @@ -207,7 +280,11 @@ 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. @@ -243,27 +320,35 @@ 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). -`--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). `--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. @@ -275,6 +360,18 @@ 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'. @@ -291,6 +388,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. @@ -305,7 +406,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. @@ -317,14 +418,18 @@ 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). +`--vmgenid` `` ('default =' `1 (autogenerated)`):: + +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. @@ -357,10 +462,78 @@ Destroy the vm (also delete all used/owned volumes). The (unique) ID of the VM. +`--purge` `` :: + +Remove vmid from backup cron jobs. + `--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 + +`--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. @@ -446,6 +619,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. @@ -460,11 +637,11 @@ 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` `` :: @@ -486,7 +663,7 @@ Move volume to different storage. The (unique) ID of the VM. -``: `` :: +``: `` :: The disk you want to move. @@ -494,6 +671,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. @@ -520,16 +701,33 @@ The (unique) ID of the VM. *qm pending* `` -Get virtual machine configuration, including pending changes. +Get the virtual machine configuration with both current and pending values. ``: ` (1 - N)` :: The (unique) ID of the VM. +*qm reboot* `` `[OPTIONS]` + +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. +`--dryrun` `` ('default =' `0`):: + +Do not actually write changes out to VM config(s). + `--vmid` ` (1 - N)` :: The (unique) ID of the VM. @@ -554,7 +752,7 @@ Extend volume size. The (unique) ID of the VM. -``: `` :: +``: `` :: The disk you want to resize. @@ -628,14 +826,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 and its properties. -Enable/disable Qemu GuestAgent. +`--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). @@ -660,11 +866,27 @@ Enable booting from specified disk. 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=] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>]` :: +`--cpu` `` :: Emulated CPU type. @@ -702,7 +924,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. @@ -714,13 +940,28 @@ 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). +`--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. + +`--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.conf' configuration file.It should not be necessary to set it. +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`):: @@ -730,13 +971,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`):: @@ -754,7 +995,11 @@ 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. @@ -790,31 +1035,39 @@ 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=]` :: + +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). -`--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). `--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. @@ -826,6 +1079,14 @@ 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'. @@ -838,6 +1099,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. @@ -846,7 +1111,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. @@ -858,14 +1123,18 @@ 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). +`--vmgenid` `` ('default =' `1 (autogenerated)`):: + +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. @@ -886,6 +1155,10 @@ The (unique) ID of the VM. Puts each option on a new line to enhance human readability +`--snapshot` `` :: + +Fetch config values from given snapshot. + *qm shutdown* `` `[OPTIONS]` Shutdown virtual machine. This is similar to pressing the power button on a @@ -940,9 +1213,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` `` :: -Specific the Qemu machine type. +Override QEMU's -cpu argument with the given string. + +`--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` `` :: @@ -966,7 +1243,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]` @@ -1017,6 +1298,16 @@ 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]` Create a Template. @@ -1025,7 +1316,7 @@ Create a Template. The (unique) ID of the VM. -`--disk` `` :: +`--disk` `` :: If you want to convert only 1 disk to base image.