*pct* `<COMMAND> [ARGS] [OPTIONS]`
+*pct clone* `<vmid> <newid> -experimental <boolean>` `[OPTIONS]`
+
+Create a container clone/copy
+
+`<vmid>` `integer (1 - N)` ::
+
+The (unique) ID of the VM.
+
+`<newid>` `integer (1 - N)` ::
+
+VMID for the clone.
+
+`-description` `string` ::
+
+Description for the new CT.
+
+`-experimental` `boolean` (default=`0`)::
+
+The clone feature is experimental, set this flag if you know what you are
+doing.
+
+`-full` `boolean` (default=`0`)::
+
+Create a full copy of all disk. This is always done when you clone a normal
+CT. For CT templates, we try to create a linked clone by default.
+
+`-hostname` `string` ::
+
+Set a hostname for the new CT.
+
+`-pool` `string` ::
+
+Add the new CT to the specified pool.
+
+`-snapname` `string` ::
+
+The name of the snapshot.
+
+`-storage` `string` ::
+
+Target storage for full clone.
++
+NOTE: Requires option(s): `full`
+
+
+
+
*pct config* `<vmid>`
Get container configuration.
`-cpulimit` `number (0 - 128)` (default=`0`)::
-Limit of CPU usage. Note if the computer has 2 CPUs, it has total of '2'
-CPU time. Value '0' indicates no CPU limit.
+Limit of CPU usage.
++
+NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0'
+indicates no CPU limit.
`-cpuunits` `integer (0 - 500000)` (default=`1024`)::
CPU weight for a VM. Argument is used in the kernel fair scheduler. The
larger the number is, the more CPU time this VM gets. Number is relative to
-weights of all the other running VMs.
-
+the weights of all the other running VMs.
++
NOTE: You can disable fair-scheduler configuration by setting this to 0.
`-description` `string` ::
Amount of RAM for the VM in MB.
-`-mp[n]` `[volume=]<volume> [,backup=<[1|0]>] [,mp=<Path>] [,size=<DiskSize>]` ::
+`-mp[n]` `mp=<Path>, [volume=]<volume> [,acl=<acl>] [,backup=<[1|0]>] [,quota=<[0|1]>] [,ro=<ro>] [,size=<DiskSize>]` ::
Use volume as container mount point (experimental feature).
`-nameserver` `string` ::
Sets DNS server IP address for a container. Create will automatically use
-the setting from the host if you neither set searchdomain or nameserver.
+the setting from the host if you neither set searchdomain nor nameserver.
-`-net[n]` `name=<String> [,bridge=<vmbr<Number>>] [,firewall=<[1|0]>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<MAC>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>] [,mtu=<Number>] [,tag=<VlanNo>]` ::
+`-net[n]` `name=<String> [,bridge=<vmbr<Number>>] [,firewall=<[1|0]>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<MAC>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>] [,mtu=<Number>] [,rate=<mbps>] [,tag=<VlanNo>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
Specifies network interfaces for the container.
Specifies whether a VM will be started during system bootup.
-`-ostype` `(archlinux | centos | debian | fedora | opensuse | ubuntu)` ::
+`-ostype` `(alpine | archlinux | centos | debian | fedora | opensuse | ubuntu | unmanaged)` ::
-OS type. Corresponds to lxc setup scripts in
-/usr/share/lxc/config/<ostype>.common.conf.
+OS type. This is used to setup configuration inside the container, and
+corresponds to lxc setup scripts in
+/usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used
+to skip and OS specific setup.
-`-password` `string` ::
+`-password` ::
Sets root password inside container.
`-protection` `boolean` (default=`0`)::
-Sets the protection flag of the container. This will prevent the remove
-operation. This will prevent the CT or CT's disk remove/update operation.
+Sets the protection flag of the container. This will prevent the CT or CT's
+disk remove/update operation.
`-restore` `boolean` ::
Mark this as restore task.
-`-rootfs` `[volume=]<volume> [,backup=<[1|0]>] [,size=<DiskSize>]` ::
+`-rootfs` `[volume=]<volume> [,acl=<acl>] [,backup=<[1|0]>] [,quota=<[0|1]>] [,ro=<ro>] [,size=<DiskSize>]` ::
Use volume as container root.
`-searchdomain` `string` ::
Sets DNS search domains for a container. Create will automatically use the
-setting from the host if you neither set searchdomain or nameserver.
+setting from the host if you neither set searchdomain nor nameserver.
+
+`-ssh-public-keys` `filepath` ::
+
+Setup public SSH keys (one key per line, OpenSSH format).
`-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
Target node.
+`-force` `boolean` ::
+
+Force migration despite local bind / device mounts. WARNING: identical bind
+/ device mounts need to be available on the target node.
+
`-online` `boolean` ::
Use online/live migration.
+
+*pct mount* `<vmid>`
+
+Mount the container's filesystem on the host. This will hold a lock on the
+container and is meant for emergency maintenance only as it will prevent
+further operations on the container other than start and stop.
+
+`<vmid>` `integer (1 - N)` ::
+
+The (unique) ID of the VM.
+
+
+
+*pct pull* `<vmid> <path> <destination>` `[OPTIONS]`
+
+Copy a file from the container to the local system.
+
+`<vmid>` `integer (1 - N)` ::
+
+The (unique) ID of the VM.
+
+`<path>` `string` ::
+
+Path to a file inside the container to pull.
+
+`<destination>` `string` ::
+
+Destination
+
+`-group` `string` ::
+
+Owner group name or id.
+
+`-perms` `string` ::
+
+File permissions to use.
+
+`-user` `string` ::
+
+Owner user name or id.
+
+
+
+*pct push* `<vmid> <file> <destination>` `[OPTIONS]`
+
+Copy a local file to the container.
+
+`<vmid>` `integer (1 - N)` ::
+
+The (unique) ID of the VM.
+
+`<file>` `string` ::
+
+Path to a local file.
+
+`<destination>` `string` ::
+
+Destination inside the container to write to.
+
+`-group` `string` ::
+
+Owner group name or id. When using a name it must exist inside the
+container.
+
+`-perms` `string` ::
+
+File permissions to use.
+
+`-user` `string` ::
+
+Owner user name or id. When using a name it must exist inside the
+container.
+
+
+
+
*pct resize* `<vmid> <disk> <size>` `[OPTIONS]`
Resize a container mountpoint.
`-cpulimit` `number (0 - 128)` (default=`0`)::
-Limit of CPU usage. Note if the computer has 2 CPUs, it has total of '2'
-CPU time. Value '0' indicates no CPU limit.
+Limit of CPU usage.
++
+NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0'
+indicates no CPU limit.
`-cpuunits` `integer (0 - 500000)` (default=`1024`)::
CPU weight for a VM. Argument is used in the kernel fair scheduler. The
larger the number is, the more CPU time this VM gets. Number is relative to
-weights of all the other running VMs.
-
+the weights of all the other running VMs.
++
NOTE: You can disable fair-scheduler configuration by setting this to 0.
`-description` `string` ::
Amount of RAM for the VM in MB.
-`-mp[n]` `[volume=]<volume> [,backup=<[1|0]>] [,mp=<Path>] [,size=<DiskSize>]` ::
+`-mp[n]` `mp=<Path>, [volume=]<volume> [,acl=<acl>] [,backup=<[1|0]>] [,quota=<[0|1]>] [,ro=<ro>] [,size=<DiskSize>]` ::
Use volume as container mount point (experimental feature).
`-nameserver` `string` ::
Sets DNS server IP address for a container. Create will automatically use
-the setting from the host if you neither set searchdomain or nameserver.
+the setting from the host if you neither set searchdomain nor nameserver.
-`-net[n]` `name=<String> [,bridge=<vmbr<Number>>] [,firewall=<[1|0]>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<MAC>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>] [,mtu=<Number>] [,tag=<VlanNo>]` ::
+`-net[n]` `name=<String> [,bridge=<vmbr<Number>>] [,firewall=<[1|0]>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<MAC>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>] [,mtu=<Number>] [,rate=<mbps>] [,tag=<VlanNo>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
Specifies network interfaces for the container.
Specifies whether a VM will be started during system bootup.
-`-ostype` `(archlinux | centos | debian | fedora | opensuse | ubuntu)` ::
+`-ostype` `(alpine | archlinux | centos | debian | fedora | opensuse | ubuntu | unmanaged)` ::
-OS type. Corresponds to lxc setup scripts in
-/usr/share/lxc/config/<ostype>.common.conf.
+OS type. This is used to setup configuration inside the container, and
+corresponds to lxc setup scripts in
+/usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used
+to skip and OS specific setup.
-`-password` `string` ::
+`-password` ::
Sets root password inside container.
`-protection` `boolean` (default=`0`)::
-Sets the protection flag of the container. This will prevent the remove
-operation. This will prevent the CT or CT's disk remove/update operation.
+Sets the protection flag of the container. This will prevent the CT or CT's
+disk remove/update operation.
-`-rootfs` `[volume=]<volume> [,backup=<[1|0]>] [,size=<DiskSize>]` ::
+`-rootfs` `[volume=]<volume> [,acl=<acl>] [,backup=<[1|0]>] [,quota=<[0|1]>] [,ro=<ro>] [,size=<DiskSize>]` ::
Use volume as container root.
`-searchdomain` `string` ::
Sets DNS search domains for a container. Create will automatically use the
-setting from the host if you neither set searchdomain or nameserver.
+setting from the host if you neither set searchdomain nor nameserver.
+
+`-ssh-public-keys` `filepath` ::
+
+Setup public SSH keys (one key per line, OpenSSH format).
`-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
`-cpulimit` `number (0 - 128)` (default=`0`)::
-Limit of CPU usage. Note if the computer has 2 CPUs, it has total of '2'
-CPU time. Value '0' indicates no CPU limit.
+Limit of CPU usage.
++
+NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0'
+indicates no CPU limit.
`-cpuunits` `integer (0 - 500000)` (default=`1024`)::
CPU weight for a VM. Argument is used in the kernel fair scheduler. The
larger the number is, the more CPU time this VM gets. Number is relative to
-weights of all the other running VMs.
-
+the weights of all the other running VMs.
++
NOTE: You can disable fair-scheduler configuration by setting this to 0.
`-delete` `string` ::
Amount of RAM for the VM in MB.
-`-mp[n]` `[volume=]<volume> [,backup=<[1|0]>] [,mp=<Path>] [,size=<DiskSize>]` ::
+`-mp[n]` `mp=<Path>, [volume=]<volume> [,acl=<acl>] [,backup=<[1|0]>] [,quota=<[0|1]>] [,ro=<ro>] [,size=<DiskSize>]` ::
Use volume as container mount point (experimental feature).
`-nameserver` `string` ::
Sets DNS server IP address for a container. Create will automatically use
-the setting from the host if you neither set searchdomain or nameserver.
+the setting from the host if you neither set searchdomain nor nameserver.
-`-net[n]` `name=<String> [,bridge=<vmbr<Number>>] [,firewall=<[1|0]>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<MAC>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>] [,mtu=<Number>] [,tag=<VlanNo>]` ::
+`-net[n]` `name=<String> [,bridge=<vmbr<Number>>] [,firewall=<[1|0]>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<MAC>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>] [,mtu=<Number>] [,rate=<mbps>] [,tag=<VlanNo>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
Specifies network interfaces for the container.
Specifies whether a VM will be started during system bootup.
-`-ostype` `(archlinux | centos | debian | fedora | opensuse | ubuntu)` ::
+`-ostype` `(alpine | archlinux | centos | debian | fedora | opensuse | ubuntu | unmanaged)` ::
-OS type. Corresponds to lxc setup scripts in
-/usr/share/lxc/config/<ostype>.common.conf.
+OS type. This is used to setup configuration inside the container, and
+corresponds to lxc setup scripts in
+/usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used
+to skip and OS specific setup.
`-protection` `boolean` (default=`0`)::
-Sets the protection flag of the container. This will prevent the remove
-operation. This will prevent the CT or CT's disk remove/update operation.
+Sets the protection flag of the container. This will prevent the CT or CT's
+disk remove/update operation.
-`-rootfs` `[volume=]<volume> [,backup=<[1|0]>] [,size=<DiskSize>]` ::
+`-rootfs` `[volume=]<volume> [,acl=<acl>] [,backup=<[1|0]>] [,quota=<[0|1]>] [,ro=<ro>] [,size=<DiskSize>]` ::
Use volume as container root.
`-searchdomain` `string` ::
Sets DNS search domains for a container. Create will automatically use the
-setting from the host if you neither set searchdomain or nameserver.
+setting from the host if you neither set searchdomain nor nameserver.
`-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
*pct shutdown* `<vmid>` `[OPTIONS]`
-Shutdown the container.
+Shutdown the container. This will trigger a clean shutdown of the
+container, see lxc-stop(1) for details.
`<vmid>` `integer (1 - N)` ::
-*pct start* `<vmid>`
+*pct start* `<vmid>` `[OPTIONS]`
Start the container.
The (unique) ID of the VM.
+`-skiplock` `boolean` ::
+
+Ignore locks - only root is allowed to use this option.
+
-*pct stop* `<vmid>`
+*pct stop* `<vmid>` `[OPTIONS]`
-Stop the container.
+Stop the container. This will abruptly stop all processes running in the
+container.
`<vmid>` `integer (1 - N)` ::
The (unique) ID of the VM.
+`-skiplock` `boolean` ::
+
+Ignore locks - only root is allowed to use this option.
+
*pct suspend* `<vmid>`
-*pct template* `<vmid>`
+*pct template* `<vmid> -experimental <boolean>` `[OPTIONS]`
Create a Template.
The (unique) ID of the VM.
+`-experimental` `boolean` (default=`0`)::
+
+The template feature is experimental, set this flag if you know what you
+are doing.
+
+*pct unmount* `<vmid>`
+
+Unmount the container's filesystem.
+
+`<vmid>` `integer (1 - N)` ::
+
+The (unique) ID of the VM.
+
+
+
`-args` `string` ::
-Note: this option is for experts only. It allows you to pass arbitrary
+NOTE: this option is for experts only. It allows you to pass arbitrary
arguments to kvm, for example:
-
++
args: -no-reboot -no-hpet
`-autostart` `boolean` (default=`0`)::
The number of cores per socket.
-`-cpu` `(486 | Broadwell | Conroe | Haswell | IvyBridge | Nehalem | Opteron_G1 | Opteron_G2 | Opteron_G3 | Opteron_G4 | Opteron_G5 | Penryn | SandyBridge | Westmere | athlon | core2duo | coreduo | host | kvm32 | kvm64 | pentium | pentium2 | pentium3 | phenom | qemu32 | qemu64)` (default=`kvm64`)::
+`-cpu` `[cputype=]<cputype> [,hidden=<1|0>]` ::
Emulated CPU type.
`-cpulimit` `number (0 - 128)` (default=`0`)::
-Limit of CPU usage. Note if the computer has 2 CPUs, it has total of '2'
-CPU time. Value '0' indicates no CPU limit.
+Limit of CPU usage.
++
+NOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0'
+indicates no CPU limit.
`-cpuunits` `integer (0 - 500000)` (default=`1000`)::
CPU weight for a VM. Argument is used in the kernel fair scheduler. The
larger the number is, the more CPU time this VM gets. Number is relative to
weights of all the other running VMs.
-
++
NOTE: You can disable fair-scheduler configuration by setting this to 0.
`-description` `string` ::
Freeze CPU at startup (use 'c' monitor command to start execution).
-`-hostpci[n]` `[host=]HOSTPCIDEVICE [,rombar=on|off] [,pcie=0|1] [,x-vga=on|off]` ::
+`-hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]` ::
Map host pci devices. HOSTPCIDEVICE syntax is:
-
++
'bus:dev.func' (hexadecimal numbers)
-
++
You can us the 'lspci' command to list existing pci devices.
-
++
The 'rombar' option determines whether or not the device's ROM will be
visible in the guest's memory map (default is 'on').
-
-Note: This option allows direct access to host hardware. So it is no longer
++
+NOTE: This option allows direct access to host hardware. So it is no longer
possible to migrate such machines - use with special care.
-
++
Experimental: user reported problems with this option.
`-hotplug` `string` (default=`network,disk,usb`)::
disable hotplug completely. Value '1' is an alias for the default
'network,disk,usb'.
-`-ide[n]` `[volume=]volume,] [,media=cdrom|disk] [,cyls=c,heads=h,secs=s[,trans=t]] [,snapshot=on|off] [,cache=none|writethrough|writeback|unsafe|directsync] [,format=f] [,backup=yes|no] [,rerror=ignore|report|stop] [,werror=enospc|ignore|report|stop] [,aio=native|threads] [,discard=ignore|on] [,detect_zeroes=on|off] [,serial=serial][,model=model]` ::
+`-ide[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<on|off>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<count>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<drive format>] [,heads=<count>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,rerror=<ignore|report|stop>] [,secs=<count>] [,serial=<serial>] [,snapshot=<on|off>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
Set a name for the VM. Only used on the configuration web interface.
-`-net[n]` `MODEL=XX:XX:XX:XX:XX:XX [,bridge=<dev>][,queues=<nbqueues>][,rate=<mbps>] [,tag=<vlanid>][,firewall=0|1],link_down=0|1]` ::
+`-net[n]` `string` ::
Specify network devices.
-
++
MODEL is one of: e1000 e1000-82540em e1000-82544gc e1000-82545em i82551
i82557b i82559er ne2k_isa ne2k_pci pcnet rtl8139 virtio vmxnet3
-
++
XX:XX:XX:XX:XX:XX should be an unique MAC address. This is
automatically generated if not specified.
-
++
The bridge parameter can be used to automatically add the interface to a
bridge device. The Proxmox VE standard bridge is called 'vmbr0'.
-
++
Option 'rate' is used to limit traffic bandwidth from and to this
interface. It is specified as floating point number, unit is 'Megabytes per
second'.
-
++
If you specify no bridge, we create a kvm 'user' (NATed) network device,
which provides DHCP and DNS services. The following addresses are used:
-
++
10.0.2.2 Gateway
10.0.2.3 DNS Server
10.0.2.4 SMB Server
-
++
The DHCP server assign addresses to the guest starting from 10.0.2.15.
-
`-numa` `boolean` (default=`0`)::
-Enable/disable Numa.
+Enable/disable NUMA.
-`-numa[n]` `cpus=<id[-id],memory=<mb>[[,hostnodes=<id[-id]>] [,policy=<preferred|bind|interleave>]]` ::
+`-numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<mb>] [,policy=<preferred|bind|interleave>]` ::
numa topology
Used to enable special optimization/features for specific
operating systems:
-
++
other => unspecified OS
wxp => Microsoft Windows XP
w2k => Microsoft Windows 2000
l24 => Linux 2.4 Kernel
l26 => Linux 2.6/3.X Kernel
solaris => solaris/opensolaris/openindiania kernel
-
++
other|l24|l26|solaris ... no special behaviour
wxp|w2k|w2k3|w2k8|wvista|win7|win8 ... use --localtime switch
`-parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
Map host parallel devices (n is 0 to 2).
-
-Note: This option allows direct access to host hardware. So it is no longer
++
+NOTE: This option allows direct access to host hardware. So it is no longer
possible to migrate such machines - use with special care.
-
++
Experimental: user reported problems with this option.
`-pool` `string` ::
Allow reboot. If set to '0' the VM exit on reboot.
-`-sata[n]` `[volume=]volume,] [,media=cdrom|disk] [,cyls=c,heads=h,secs=s[,trans=t]] [,snapshot=on|off] [,cache=none|writethrough|writeback|unsafe|directsync] [,format=f] [,backup=yes|no] [,rerror=ignore|report|stop] [,werror=enospc|ignore|report|stop] [,aio=native|threads] [,discard=ignore|on] [,detect_zeroes=on|off] [,serial=serial]` ::
+`-sata[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<on|off>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<count>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<drive format>] [,heads=<count>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<count>] [,serial=<serial>] [,snapshot=<on|off>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
-`-scsi[n]` `[volume=]volume,] [,media=cdrom|disk] [,cyls=c,heads=h,secs=s[,trans=t]] [,snapshot=on|off] [,cache=none|writethrough|writeback|unsafe|directsync] [,format=f] [,backup=yes|no] [,rerror=ignore|report|stop] [,werror=enospc|ignore|report|stop] [,aio=native|threads] [,discard=ignore|on] [,detect_zeroes=on|off] [,iothread=on] [,queues=<nbqueues>] [,serial=serial]` ::
+`-scsi[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<on|off>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<count>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<drive format>] [,heads=<count>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iothread=<off|on>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<nbqueues>] [,secs=<count>] [,serial=<serial>] [,snapshot=<on|off>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
Create a serial device inside the VM (n is 0 to 3), and pass through a host
serial device (i.e. /dev/ttyS0), or create a unix socket on the host side
(use 'qm terminal' to open a terminal connection).
-
-Note: If you pass through a host serial device, it is no longer possible to
++
+NOTE: If you pass through a host serial device, it is no longer possible to
migrate such machines - use with special care.
-
++
Experimental: user reported problems with this option.
`-shares` `integer (0 - 50000)` (default=`1000`)::
more memory this VM gets. Number is relative to weights of all other
running VMs. Using zero disables auto-ballooning
-`-smbios[n]` `[manufacturer=str][,product=str][,version=str][,serial=str] [,uuid=uuid][,sku=str][,family=str]` ::
+`-smbios[n]` `[family=<str>] [,manufacturer=<name>] [,product=<name>] [,serial=<str>] [,sku=<str>] [,uuid=<UUID>] [,version=<str>]` ::
Specify SMBIOS type 1 fields.
`-tablet` `boolean` (default=`1`)::
-Enable/disable the usb tablet device. This device is usually needed to
+Enable/disable the USB tablet device. This device is usually needed to
allow absolute mouse positioning with VNC. Else the mouse runs out of sync
with normal VNC clients. If you're running lots of console-only guests on
one host, you may consider disabling this to save some context switches.
-This is turned of by default if you use spice (vga=qxl).
+This is turned off by default if you use spice (-vga=qxl).
`-tdf` `boolean` (default=`0`)::
Reference to unused volumes.
-`-usb[n]` `host=HOSTUSBDEVICE|spice` ::
+`-usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<yes|no>]` ::
Configure an USB device (n is 0 to 4). This can be used to
pass-through usb devices to the guest. HOSTUSBDEVICE syntax is:
-
++
'bus-port(.port)*' (decimal numbers) or
-'vendor_id:product_id' (hexadeciaml numbers)
-
+'vendor_id:product_id' (hexadeciaml numbers) or
+'spice'
++
You can use the 'lsusb -t' command to list existing usb devices.
-
-Note: This option allows direct access to host hardware. So it is no longer
++
+NOTE: This option allows direct access to host hardware. So it is no longer
possible to migrate such machines - use with special care.
-
++
The value 'spice' can be used to add a usb redirection devices for spice.
-
++
+The 'usb3' option determines whether the device is a USB3 device or not
+(this does currently not work reliably with spice redirection and is then
+ignored).
`-vcpus` `integer (1 - N)` (default=`0`)::
`-vga` `(cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware)` ::
-Select VGA type. If you want to use high resolution modes (>= 1280x1024x16)
-then you should use option 'std' or 'vmware'. Default is 'std' for
-win8/win7/w2k8, and 'cirrur' for other OS types. Option 'qxl' enables the
-SPICE display sever. You can also run without any graphic card using a
-serial devive as terminal.
+Select the VGA type. If you want to use high resolution modes (>=
+1280x1024x16) then you should use the options 'std' or 'vmware'. Default is
+'std' for win8/win7/w2k8, and 'cirrus' for other OS types. The 'qxl' option
+enables the SPICE display sever. For win* OS you can select how many
+independent displays you want, Linux guests can add displays them self. You
+can also run without any graphic card, using a serial device as terminal.
-`-virtio[n]` `[volume=]volume,] [,media=cdrom|disk] [,cyls=c,heads=h,secs=s[,trans=t]] [,snapshot=on|off] [,cache=none|writethrough|writeback|unsafe|directsync] [,format=f] [,backup=yes|no] [,rerror=ignore|report|stop] [,werror=enospc|ignore|report|stop] [,aio=native|threads] [,discard=ignore|on] [,detect_zeroes=on|off] [,iothread=on] [,serial=serial]` ::
+`-virtio[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<on|off>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<count>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<drive format>] [,heads=<count>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iothread=<off|on>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<count>] [,serial=<serial>] [,snapshot=<on|off>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
Use volume as VIRTIO hard disk (n is 0 to 15).
-`-watchdog` `[[model=]i6300esb|ib700] [,[action=]reset|shutdown|poweroff|pause|debug|none]` ::
+`-watchdog` `[action=<reset|shutdown|poweroff|pause|debug|none>] [,[model=]<i6300esb|ib700>]` ::
-Create a virtual hardware watchdog device. Once enabled (by a guest
+Create a virtual hardware watchdog device. Once enabled (by a guest
action), the watchdog must be periodically polled by an agent inside the
-guest or else the guest will be restarted (or execute the action specified)
+guest or else the watchdog will reset the guest (or execute the respective
+action specified)
-*qm list*
+*qm list* `[OPTIONS]`
Virtual machine index (per node).
+`-full` `boolean` ::
+
+Determine the full status of active VMs.
+
*qm migrate* `<vmid> <target>` `[OPTIONS]`
`-args` `string` ::
-Note: this option is for experts only. It allows you to pass arbitrary
+NOTE: this option is for experts only. It allows you to pass arbitrary
arguments to kvm, for example:
-
++
args: -no-reboot -no-hpet
`-autostart` `boolean` (default=`0`)::
The number of cores per socket.
-`-cpu` `(486 | Broadwell | Conroe | Haswell | IvyBridge | Nehalem | Opteron_G1 | Opteron_G2 | Opteron_G3 | Opteron_G4 | Opteron_G5 | Penryn | SandyBridge | Westmere | athlon | core2duo | coreduo | host | kvm32 | kvm64 | pentium | pentium2 | pentium3 | phenom | qemu32 | qemu64)` (default=`kvm64`)::
+`-cpu` `[cputype=]<cputype> [,hidden=<1|0>]` ::
Emulated CPU type.
`-cpulimit` `number (0 - 128)` (default=`0`)::
-Limit of CPU usage. Note if the computer has 2 CPUs, it has total of '2'
-CPU time. Value '0' indicates no CPU limit.
+Limit of CPU usage.
++
+NOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0'
+indicates no CPU limit.
`-cpuunits` `integer (0 - 500000)` (default=`1000`)::
CPU weight for a VM. Argument is used in the kernel fair scheduler. The
larger the number is, the more CPU time this VM gets. Number is relative to
weights of all the other running VMs.
-
++
NOTE: You can disable fair-scheduler configuration by setting this to 0.
`-delete` `string` ::
Freeze CPU at startup (use 'c' monitor command to start execution).
-`-hostpci[n]` `[host=]HOSTPCIDEVICE [,rombar=on|off] [,pcie=0|1] [,x-vga=on|off]` ::
+`-hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]` ::
Map host pci devices. HOSTPCIDEVICE syntax is:
-
++
'bus:dev.func' (hexadecimal numbers)
-
++
You can us the 'lspci' command to list existing pci devices.
-
++
The 'rombar' option determines whether or not the device's ROM will be
visible in the guest's memory map (default is 'on').
-
-Note: This option allows direct access to host hardware. So it is no longer
++
+NOTE: This option allows direct access to host hardware. So it is no longer
possible to migrate such machines - use with special care.
-
++
Experimental: user reported problems with this option.
`-hotplug` `string` (default=`network,disk,usb`)::
disable hotplug completely. Value '1' is an alias for the default
'network,disk,usb'.
-`-ide[n]` `[volume=]volume,] [,media=cdrom|disk] [,cyls=c,heads=h,secs=s[,trans=t]] [,snapshot=on|off] [,cache=none|writethrough|writeback|unsafe|directsync] [,format=f] [,backup=yes|no] [,rerror=ignore|report|stop] [,werror=enospc|ignore|report|stop] [,aio=native|threads] [,discard=ignore|on] [,detect_zeroes=on|off] [,serial=serial][,model=model]` ::
+`-ide[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<on|off>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<count>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<drive format>] [,heads=<count>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,rerror=<ignore|report|stop>] [,secs=<count>] [,serial=<serial>] [,snapshot=<on|off>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
Set a name for the VM. Only used on the configuration web interface.
-`-net[n]` `MODEL=XX:XX:XX:XX:XX:XX [,bridge=<dev>][,queues=<nbqueues>][,rate=<mbps>] [,tag=<vlanid>][,firewall=0|1],link_down=0|1]` ::
+`-net[n]` `string` ::
Specify network devices.
-
++
MODEL is one of: e1000 e1000-82540em e1000-82544gc e1000-82545em i82551
i82557b i82559er ne2k_isa ne2k_pci pcnet rtl8139 virtio vmxnet3
-
++
XX:XX:XX:XX:XX:XX should be an unique MAC address. This is
automatically generated if not specified.
-
++
The bridge parameter can be used to automatically add the interface to a
bridge device. The Proxmox VE standard bridge is called 'vmbr0'.
-
++
Option 'rate' is used to limit traffic bandwidth from and to this
interface. It is specified as floating point number, unit is 'Megabytes per
second'.
-
++
If you specify no bridge, we create a kvm 'user' (NATed) network device,
which provides DHCP and DNS services. The following addresses are used:
-
++
10.0.2.2 Gateway
10.0.2.3 DNS Server
10.0.2.4 SMB Server
-
++
The DHCP server assign addresses to the guest starting from 10.0.2.15.
-
`-numa` `boolean` (default=`0`)::
-Enable/disable Numa.
+Enable/disable NUMA.
-`-numa[n]` `cpus=<id[-id],memory=<mb>[[,hostnodes=<id[-id]>] [,policy=<preferred|bind|interleave>]]` ::
+`-numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<mb>] [,policy=<preferred|bind|interleave>]` ::
numa topology
Used to enable special optimization/features for specific
operating systems:
-
++
other => unspecified OS
wxp => Microsoft Windows XP
w2k => Microsoft Windows 2000
l24 => Linux 2.4 Kernel
l26 => Linux 2.6/3.X Kernel
solaris => solaris/opensolaris/openindiania kernel
-
++
other|l24|l26|solaris ... no special behaviour
wxp|w2k|w2k3|w2k8|wvista|win7|win8 ... use --localtime switch
`-parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
Map host parallel devices (n is 0 to 2).
-
-Note: This option allows direct access to host hardware. So it is no longer
++
+NOTE: This option allows direct access to host hardware. So it is no longer
possible to migrate such machines - use with special care.
-
++
Experimental: user reported problems with this option.
`-protection` `boolean` (default=`0`)::
Revert a pending change.
-`-sata[n]` `[volume=]volume,] [,media=cdrom|disk] [,cyls=c,heads=h,secs=s[,trans=t]] [,snapshot=on|off] [,cache=none|writethrough|writeback|unsafe|directsync] [,format=f] [,backup=yes|no] [,rerror=ignore|report|stop] [,werror=enospc|ignore|report|stop] [,aio=native|threads] [,discard=ignore|on] [,detect_zeroes=on|off] [,serial=serial]` ::
+`-sata[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<on|off>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<count>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<drive format>] [,heads=<count>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<count>] [,serial=<serial>] [,snapshot=<on|off>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
-`-scsi[n]` `[volume=]volume,] [,media=cdrom|disk] [,cyls=c,heads=h,secs=s[,trans=t]] [,snapshot=on|off] [,cache=none|writethrough|writeback|unsafe|directsync] [,format=f] [,backup=yes|no] [,rerror=ignore|report|stop] [,werror=enospc|ignore|report|stop] [,aio=native|threads] [,discard=ignore|on] [,detect_zeroes=on|off] [,iothread=on] [,queues=<nbqueues>] [,serial=serial]` ::
+`-scsi[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<on|off>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<count>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<drive format>] [,heads=<count>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iothread=<off|on>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<nbqueues>] [,secs=<count>] [,serial=<serial>] [,snapshot=<on|off>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
Create a serial device inside the VM (n is 0 to 3), and pass through a host
serial device (i.e. /dev/ttyS0), or create a unix socket on the host side
(use 'qm terminal' to open a terminal connection).
-
-Note: If you pass through a host serial device, it is no longer possible to
++
+NOTE: If you pass through a host serial device, it is no longer possible to
migrate such machines - use with special care.
-
++
Experimental: user reported problems with this option.
`-shares` `integer (0 - 50000)` (default=`1000`)::
Ignore locks - only root is allowed to use this option.
-`-smbios[n]` `[manufacturer=str][,product=str][,version=str][,serial=str] [,uuid=uuid][,sku=str][,family=str]` ::
+`-smbios[n]` `[family=<str>] [,manufacturer=<name>] [,product=<name>] [,serial=<str>] [,sku=<str>] [,uuid=<UUID>] [,version=<str>]` ::
Specify SMBIOS type 1 fields.
`-tablet` `boolean` (default=`1`)::
-Enable/disable the usb tablet device. This device is usually needed to
+Enable/disable the USB tablet device. This device is usually needed to
allow absolute mouse positioning with VNC. Else the mouse runs out of sync
with normal VNC clients. If you're running lots of console-only guests on
one host, you may consider disabling this to save some context switches.
-This is turned of by default if you use spice (vga=qxl).
+This is turned off by default if you use spice (-vga=qxl).
`-tdf` `boolean` (default=`0`)::
Reference to unused volumes.
-`-usb[n]` `host=HOSTUSBDEVICE|spice` ::
+`-usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<yes|no>]` ::
Configure an USB device (n is 0 to 4). This can be used to
pass-through usb devices to the guest. HOSTUSBDEVICE syntax is:
-
++
'bus-port(.port)*' (decimal numbers) or
-'vendor_id:product_id' (hexadeciaml numbers)
-
+'vendor_id:product_id' (hexadeciaml numbers) or
+'spice'
++
You can use the 'lsusb -t' command to list existing usb devices.
-
-Note: This option allows direct access to host hardware. So it is no longer
++
+NOTE: This option allows direct access to host hardware. So it is no longer
possible to migrate such machines - use with special care.
-
++
The value 'spice' can be used to add a usb redirection devices for spice.
-
++
+The 'usb3' option determines whether the device is a USB3 device or not
+(this does currently not work reliably with spice redirection and is then
+ignored).
`-vcpus` `integer (1 - N)` (default=`0`)::
`-vga` `(cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware)` ::
-Select VGA type. If you want to use high resolution modes (>= 1280x1024x16)
-then you should use option 'std' or 'vmware'. Default is 'std' for
-win8/win7/w2k8, and 'cirrur' for other OS types. Option 'qxl' enables the
-SPICE display sever. You can also run without any graphic card using a
-serial devive as terminal.
+Select the VGA type. If you want to use high resolution modes (>=
+1280x1024x16) then you should use the options 'std' or 'vmware'. Default is
+'std' for win8/win7/w2k8, and 'cirrus' for other OS types. The 'qxl' option
+enables the SPICE display sever. For win* OS you can select how many
+independent displays you want, Linux guests can add displays them self. You
+can also run without any graphic card, using a serial device as terminal.
-`-virtio[n]` `[volume=]volume,] [,media=cdrom|disk] [,cyls=c,heads=h,secs=s[,trans=t]] [,snapshot=on|off] [,cache=none|writethrough|writeback|unsafe|directsync] [,format=f] [,backup=yes|no] [,rerror=ignore|report|stop] [,werror=enospc|ignore|report|stop] [,aio=native|threads] [,discard=ignore|on] [,detect_zeroes=on|off] [,iothread=on] [,serial=serial]` ::
+`-virtio[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<on|off>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<count>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<drive format>] [,heads=<count>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iothread=<off|on>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<count>] [,serial=<serial>] [,snapshot=<on|off>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
Use volume as VIRTIO hard disk (n is 0 to 15).
-`-watchdog` `[[model=]i6300esb|ib700] [,[action=]reset|shutdown|poweroff|pause|debug|none]` ::
+`-watchdog` `[action=<reset|shutdown|poweroff|pause|debug|none>] [,[model=]<i6300esb|ib700>]` ::
-Create a virtual hardware watchdog device. Once enabled (by a guest
+Create a virtual hardware watchdog device. Once enabled (by a guest
action), the watchdog must be periodically polled by an agent inside the
-guest or else the guest will be restarted (or execute the action specified)
+guest or else the watchdog will reset the guest (or execute the respective
+action specified)
*qm shutdown* `<vmid>` `[OPTIONS]`
-Shutdown virtual machine.
+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.
`<vmid>` `integer (1 - N)` ::
*qm stop* `<vmid>` `[OPTIONS]`
-Stop virtual machine.
+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
`<vmid>` `integer (1 - N)` ::
projects / pve-docs.git / commitdiff