1 `arch`: `<amd64 | arm64 | armhf | i386>` ('default =' `amd64`)::
5 `cmode`: `<console | shell | tty>` ('default =' `tty`)::
7 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).
9 `console`: `<boolean>` ('default =' `1`)::
11 Attach a console device (/dev/console) to the container.
13 `cores`: `<integer> (1 - 8192)` ::
15 The number of cores assigned to the container. A container can use all available cores by default.
17 `cpulimit`: `<number> (0 - 8192)` ('default =' `0`)::
21 NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.
23 `cpuunits`: `<integer> (0 - 500000)` ('default =' `cgroup v1: 1024, cgroup v2: 100`)::
25 CPU weight for a container. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this container gets. Number is relative to the weights of all the other running guests.
27 `debug`: `<boolean>` ('default =' `0`)::
29 Try to be more verbose. For now this only enables debug log-level on start.
31 `description`: `<string>` ::
33 Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file.
35 `features`: `[force_rw_sys=<1|0>] [,fuse=<1|0>] [,keyctl=<1|0>] [,mknod=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
37 Allow containers access to advanced features.
39 `force_rw_sys`=`<boolean>` ('default =' `0`);;
41 Mount /sys in unprivileged containers as `rw` instead of `mixed`. This can break networking under newer (>= v245) systemd-network use.
43 `fuse`=`<boolean>` ('default =' `0`);;
45 Allow using 'fuse' file systems in a container. Note that interactions between fuse and the freezer cgroup can potentially cause I/O deadlocks.
47 `keyctl`=`<boolean>` ('default =' `0`);;
49 For unprivileged containers only: Allow the use of the keyctl() system call. This is required to use docker inside a container. By default unprivileged containers will see this system call as non-existent. This is mostly a workaround for systemd-networkd, as it will treat it as a fatal error when some keyctl() operations are denied by the kernel due to lacking permissions. Essentially, you can choose between running systemd-networkd or docker.
51 `mknod`=`<boolean>` ('default =' `0`);;
53 Allow unprivileged containers to use mknod() to add certain device nodes. This requires a kernel with seccomp trap to user space support (5.3 or newer). This is experimental.
55 `mount`=`<fstype;fstype;...>` ;;
57 Allow mounting file systems of specific types. This should be a list of file system types as used with the mount command. Note that this can have negative effects on the container's security. With access to a loop device, mounting a file can circumvent the mknod permission of the devices cgroup, mounting an NFS file system can block the host's I/O completely and prevent it from rebooting, etc.
59 `nesting`=`<boolean>` ('default =' `0`);;
61 Allow nesting. Best used with unprivileged containers with additional id mapping. Note that this will expose procfs and sysfs contents of the host to the guest.
63 `hookscript`: `<string>` ::
65 Script that will be exectued during various steps in the containers lifetime.
67 `hostname`: `<string>` ::
69 Set a host name for the container.
71 `lock`: `<backup | create | destroyed | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
73 Lock/unlock the container.
75 `memory`: `<integer> (16 - N)` ('default =' `512`)::
77 Amount of RAM for the container in MB.
79 `mp[n]`: `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
81 Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
85 Explicitly enable or disable ACL support.
87 `backup`=`<boolean>` ;;
89 Whether to include the mount point in backups (only used for volume mount points).
91 `mountoptions`=`<opt[;opt...]>` ;;
93 Extra mount options for rootfs/mps.
97 Path to the mount point as seen from inside the container.
99 NOTE: Must not contain any symlinks for security reasons.
101 `quota`=`<boolean>` ;;
103 Enable user quotas inside the container (not supported with zfs subvolumes)
105 `replicate`=`<boolean>` ('default =' `1`);;
107 Will include this volume to a storage replica job.
111 Read-only mount point
113 `shared`=`<boolean>` ('default =' `0`);;
115 Mark this non-volume mount point as available on all nodes.
117 WARNING: This option does not share the mount point automatically, it assumes it is shared already!
119 `size`=`<DiskSize>` ;;
121 Volume size (read only value).
123 `volume`=`<volume>` ;;
125 Volume, device or directory to mount into the container.
127 `nameserver`: `<string>` ::
129 Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
131 `net[n]`: `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
133 Specifies network interfaces for the container.
135 `bridge`=`<bridge>` ;;
137 Bridge to attach the network device to.
139 `firewall`=`<boolean>` ;;
141 Controls whether this interface's firewall rules should be used.
143 `gw`=`<GatewayIPv4>` ;;
145 Default gateway for IPv4 traffic.
147 `gw6`=`<GatewayIPv6>` ;;
149 Default gateway for IPv6 traffic.
151 `hwaddr`=`<XX:XX:XX:XX:XX:XX>` ;;
153 A common MAC address with the I/G (Individual/Group) bit not set.
155 `ip`=`<(IPv4/CIDR|dhcp|manual)>` ;;
157 IPv4 address in CIDR format.
159 `ip6`=`<(IPv6/CIDR|auto|dhcp|manual)>` ;;
161 IPv6 address in CIDR format.
163 `mtu`=`<integer> (64 - 65535)` ;;
165 Maximum transfer unit of the interface. (lxc.network.mtu)
169 Name of the network device as seen from inside the container. (lxc.network.name)
173 Apply rate limiting to the interface
175 `tag`=`<integer> (1 - 4094)` ;;
177 VLAN tag for this interface.
179 `trunks`=`<vlanid[;vlanid...]>` ;;
181 VLAN ids to pass through the interface
185 Network interface type.
187 `onboot`: `<boolean>` ('default =' `0`)::
189 Specifies whether a container will be started during system bootup.
191 `ostype`: `<alpine | archlinux | centos | debian | devuan | fedora | gentoo | nixos | opensuse | ubuntu | unmanaged>` ::
193 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.
195 `protection`: `<boolean>` ('default =' `0`)::
197 Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
199 `rootfs`: `[volume=]<volume> [,acl=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
201 Use volume as container root.
205 Explicitly enable or disable ACL support.
207 `mountoptions`=`<opt[;opt...]>` ;;
209 Extra mount options for rootfs/mps.
211 `quota`=`<boolean>` ;;
213 Enable user quotas inside the container (not supported with zfs subvolumes)
215 `replicate`=`<boolean>` ('default =' `1`);;
217 Will include this volume to a storage replica job.
221 Read-only mount point
223 `shared`=`<boolean>` ('default =' `0`);;
225 Mark this non-volume mount point as available on all nodes.
227 WARNING: This option does not share the mount point automatically, it assumes it is shared already!
229 `size`=`<DiskSize>` ;;
231 Volume size (read only value).
233 `volume`=`<volume>` ;;
235 Volume, device or directory to mount into the container.
237 `searchdomain`: `<string>` ::
239 Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
241 `startup`: `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
243 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.
245 `swap`: `<integer> (0 - N)` ('default =' `512`)::
247 Amount of SWAP for the container in MB.
249 `tags`: `<string>` ::
251 Tags of the Container. This is only meta information.
253 `template`: `<boolean>` ('default =' `0`)::
255 Enable/disable Template.
257 `timezone`: `<string>` ::
259 Time zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tab
261 `tty`: `<integer> (0 - 6)` ('default =' `2`)::
263 Specify the number of tty available to the container
265 `unprivileged`: `<boolean>` ('default =' `0`)::
267 Makes the container run as unprivileged user. (Should not be modified manually.)
269 `unused[n]`: `[volume=]<volume>` ::
271 Reference to unused volumes. This is used internally, and should not be modified manually.
273 `volume`=`<volume>` ;;
275 The volume that is not used currently.