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 - 128)` ::
15 The number of cores assigned to the container. A container can use all available cores by default.
17 `cpulimit`: `<number> (0 - 128)` ('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 =' `1024`)::
25 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 the weights of all the other running VMs.
27 NOTE: You can disable fair-scheduler configuration by setting this to 0.
29 `description`: `<string>` ::
31 Container description. Only used on the configuration web interface.
33 `features`: `[fuse=<1|0>] [,keyctl=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
35 Allow containers access to advanced features.
37 `fuse`=`<boolean>` ('default =' `0`);;
39 Allow using 'fuse' file systems in a container. Note that interactions between fuse and the freezer cgroup can potentially cause I/O deadlocks.
41 `keyctl`=`<boolean>` ('default =' `0`);;
43 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.
45 `mount`=`<fstype;fstype;...>` ;;
47 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.
49 `nesting`=`<boolean>` ('default =' `0`);;
51 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.
53 `hookscript`: `<string>` ::
55 Script that will be exectued during various steps in the containers lifetime.
57 `hostname`: `<string>` ::
59 Set a host name for the container.
61 `lock`: `<backup | create | destroyed | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
65 `memory`: `<integer> (16 - N)` ('default =' `512`)::
67 Amount of RAM for the VM in MB.
69 `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>]` ::
71 Use volume as container mount point.
75 Explicitly enable or disable ACL support.
77 `backup`=`<boolean>` ;;
79 Whether to include the mount point in backups (only used for volume mount points).
81 `mountoptions`=`<opt[;opt...]>` ;;
83 Extra mount options for rootfs/mps.
87 Path to the mount point as seen from inside the container.
89 NOTE: Must not contain any symlinks for security reasons.
91 `quota`=`<boolean>` ;;
93 Enable user quotas inside the container (not supported with zfs subvolumes)
95 `replicate`=`<boolean>` ('default =' `1`);;
97 Will include this volume to a storage replica job.
101 Read-only mount point
103 `shared`=`<boolean>` ('default =' `0`);;
105 Mark this non-volume mount point as available on all nodes.
107 WARNING: This option does not share the mount point automatically, it assumes it is shared already!
109 `size`=`<DiskSize>` ;;
111 Volume size (read only value).
113 `volume`=`<volume>` ;;
115 Volume, device or directory to mount into the container.
117 `nameserver`: `<string>` ::
119 Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
121 `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>]` ::
123 Specifies network interfaces for the container.
125 `bridge`=`<bridge>` ;;
127 Bridge to attach the network device to.
129 `firewall`=`<boolean>` ;;
131 Controls whether this interface's firewall rules should be used.
133 `gw`=`<GatewayIPv4>` ;;
135 Default gateway for IPv4 traffic.
137 `gw6`=`<GatewayIPv6>` ;;
139 Default gateway for IPv6 traffic.
141 `hwaddr`=`<XX:XX:XX:XX:XX:XX>` ;;
143 A common MAC address with the I/G (Individual/Group) bit not set.
145 `ip`=`<(IPv4/CIDR|dhcp|manual)>` ;;
147 IPv4 address in CIDR format.
149 `ip6`=`<(IPv6/CIDR|auto|dhcp|manual)>` ;;
151 IPv6 address in CIDR format.
153 `mtu`=`<integer> (64 - N)` ;;
155 Maximum transfer unit of the interface. (lxc.network.mtu)
159 Name of the network device as seen from inside the container. (lxc.network.name)
163 Apply rate limiting to the interface
165 `tag`=`<integer> (1 - 4094)` ;;
167 VLAN tag for this interface.
169 `trunks`=`<vlanid[;vlanid...]>` ;;
171 VLAN ids to pass through the interface
175 Network interface type.
177 `onboot`: `<boolean>` ('default =' `0`)::
179 Specifies whether a VM will be started during system bootup.
181 `ostype`: `<alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
183 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.
185 `protection`: `<boolean>` ('default =' `0`)::
187 Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
189 `rootfs`: `[volume=]<volume> [,acl=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
191 Use volume as container root.
195 Explicitly enable or disable ACL support.
197 `mountoptions`=`<opt[;opt...]>` ;;
199 Extra mount options for rootfs/mps.
201 `quota`=`<boolean>` ;;
203 Enable user quotas inside the container (not supported with zfs subvolumes)
205 `replicate`=`<boolean>` ('default =' `1`);;
207 Will include this volume to a storage replica job.
211 Read-only mount point
213 `shared`=`<boolean>` ('default =' `0`);;
215 Mark this non-volume mount point as available on all nodes.
217 WARNING: This option does not share the mount point automatically, it assumes it is shared already!
219 `size`=`<DiskSize>` ;;
221 Volume size (read only value).
223 `volume`=`<volume>` ;;
225 Volume, device or directory to mount into the container.
227 `searchdomain`: `<string>` ::
229 Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
231 `startup`: `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
233 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.
235 `swap`: `<integer> (0 - N)` ('default =' `512`)::
237 Amount of SWAP for the VM in MB.
239 `tags`: `<string>` ::
241 Tags of the Container. This is only meta information.
243 `template`: `<boolean>` ('default =' `0`)::
245 Enable/disable Template.
247 `tty`: `<integer> (0 - 6)` ('default =' `2`)::
249 Specify the number of tty available to the container
251 `unprivileged`: `<boolean>` ('default =' `0`)::
253 Makes the container run as unprivileged user. (Should not be modified manually.)
255 `unused[n]`: `<string>` ::
257 Reference to unused volumes. This is used internally, and should not be modified manually.