[pve-docs.git] / qm.adoc

ifdef::manvolnum[]
PVE({manvolnum})
================
include::attributes.txt[]

NAME
----

qm - Qemu/KVM Virtual Machine Manager


SYNOPSYS
--------

include::qm.1-synopsis.adoc[]

DESCRIPTION
-----------
endif::manvolnum[]

ifndef::manvolnum[]
Qemu/KVM Virtual Machines
=========================
include::attributes.txt[]
endif::manvolnum[]


qm is a script to manage virtual machines with Qemu/Kvm. You can
create and destroy virtual machines, and control execution
(start/stop/suspend/resume). Besides that, you can use qm to set
parameters in the associated config file. It is also possible to
create and delete virtual disks.

Configuration
-------------

All configuration files consists of lines in the form

 PARAMETER: value

See 'man vm.conf' for a complete list of options.

Configuration files are stored inside the Proxmox cluster file
system, and can be access at '/etc/pve/qemu-server/<VMID>.conf'.

The default for the `keyboard` option is read from
'/etc/pve/datacenter.conf'.

Locks
-----

Online migrations and backups ('vzdump') set a lock to prevent incompatible
concurrent actions on the affected VMs. Sometimes you need to remove such a
lock manually (e.g., after a power failure).

 qm unlock <vmid>

Examples
--------

Create a new VM with 4 GB IDE disk.

 qm create 300 -ide0 4 -net0 e1000 -cdrom proxmox-mailgateway_2.1.iso

Start the new VM

 qm start 300

Send a shutdown request, then wait until the VM is stopped.

 qm shutdown 300 && qm wait 300

Same as above, but only wait for 40 seconds.

 qm shutdown 300 && qm wait 300 -timeout 40


ifdef::manvolnum[]
include::pve-copyright.adoc[]
endif::manvolnum[]
Commit	Line	Data
f69cfd23 DM	1	ifdef::manvolnum[]
	2	PVE({manvolnum})
	3	================
38fd0958	4	include::attributes.txt[]
f69cfd23 DM	5
	6	NAME
	7	----
	8
	9	qm - Qemu/KVM Virtual Machine Manager
	10
	11
	12	SYNOPSYS
	13	--------
	14
	15	include::qm.1-synopsis.adoc[]
	16
	17	DESCRIPTION
	18	-----------
	19	endif::manvolnum[]
	20
	21	ifndef::manvolnum[]
	22	Qemu/KVM Virtual Machines
	23	=========================
38fd0958	24	include::attributes.txt[]
f69cfd23 DM	25	endif::manvolnum[]
	26
	27
	28	qm is a script to manage virtual machines with Qemu/Kvm. You can
	29	create and destroy virtual machines, and control execution
	30	(start/stop/suspend/resume). Besides that, you can use qm to set
	31	parameters in the associated config file. It is also possible to
	32	create and delete virtual disks.
	33
	34	Configuration
	35	-------------
	36
	37	All configuration files consists of lines in the form
	38
	39	PARAMETER: value
	40
	41	See 'man vm.conf' for a complete list of options.
	42
871e1fd6	43	Configuration files are stored inside the Proxmox cluster file
f69cfd23 DM	44	system, and can be access at '/etc/pve/qemu-server/<VMID>.conf'.
f69cfd23 DM	45
871e1fd6	46	The default for the `keyboard` option is read from
f69cfd23 DM	47	'/etc/pve/datacenter.conf'.
	48
	49	Locks
	50	-----
	51
871e1fd6 FG	52	Online migrations and backups ('vzdump') set a lock to prevent incompatible
	53	concurrent actions on the affected VMs. Sometimes you need to remove such a
	54	lock manually (e.g., after a power failure).
f69cfd23 DM	55
	56	qm unlock <vmid>
	57
	58	Examples
	59	--------
	60
	61	Create a new VM with 4 GB IDE disk.
	62
	63	qm create 300 -ide0 4 -net0 e1000 -cdrom proxmox-mailgateway_2.1.iso
	64
	65	Start the new VM
	66
	67	qm start 300
	68
	69	Send a shutdown request, then wait until the VM is stopped.
	70
	71	qm shutdown 300 && qm wait 300
	72
	73	Same as above, but only wait for 40 seconds.
	74
	75	qm shutdown 300 && qm wait 300 -timeout 40
	76
	77
	78	ifdef::manvolnum[]
	79	include::pve-copyright.adoc[]
	80	endif::manvolnum[]