NAME

pct.conf - Proxmox VE Container (LXC) configuration files.

SYNOPSYS

The /etc/pve/lxc/VMID.conf files stores container configuration, where VMID is the numeric ID of the given VM. Note that VMID <= 100 are reserved for internal purposes.

FILE FORMAT

Configuration files use a simple colon separated key/value format. Each line has the following format:

 OPTION: value

Blank lines in the file are ignored, and lines starting with a # character are treated as comments and are also ignored.

One can use the pct command to generate and modify those files.

It is also possible to add low-level lxc style configuration directly, for example:

 lxc.init_cmd: /sbin/my_own_init

or

 lxc.init_cmd = /sbin/my_own_init

Those settings are directly passed to the lxc low-level tools.

OPTIONS

arch: (amd64 | i386)

OS architecture type. Default value is 'amd64'.

cmode: (console | shell | tty)

Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login). Default value is 'tty'.

console: boolean

Attach a console device (/dev/console) to the container. Default value is '1'.

cpulimit: number (0 - 128)

Limit of CPU usage. Note if the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit. Default value is '0'.

cpuunits: integer (0 - 500000)

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.

Default value is '1024'.

description: string

Container description. Only used on the configuration web interface.

hostname: string

Set a host name for the container.

lock: (backup | migrate | rollback | snapshot)

Lock/unlock the VM.

memory: integer (16 - N)

Amount of RAM for the VM in MB. Default value is '512'.

mp[n]: [volume=]<volume> [,backup=<[1|0]>] [,mp=<Path>] [,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.

net[n]: bridge=<vmbr<Number>>, name=<String> [,firewall=<[1|0]>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<MAC>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>] [,mtu=<Number>] [,tag=<VlanNo>]

Specifies network interfaces for the container.

onboot: boolean

Specifies whether a VM will be started during system bootup. Default value is '0'.

ostype: (archlinux | centos | debian | ubuntu)

OS type. Corresponds to lxc setup scripts in /usr/share/lxc/config/<ostype>.common.conf.

protection: boolean

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. Default value is '0'.

rootfs: [volume=]<volume> [,backup=<[1|0]>] [,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.

startup: [[order=]\d+] [,up=\d+] [,down=\d+]

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.

swap: integer (0 - N)

Amount of SWAP for the VM in MB. Default value is '512'.

template: boolean

Enable/disable Template. Default value is '0'.

tty: integer (0 - 6)

Specify the number of tty available to the container Default value is '2'.

unused[n]: string

Reference to unused volumes.

COPYRIGHT AND DISCLAIMER

Copyright (C) 2007-2015 Proxmox Server Solutions GmbH

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/.