1 `arch`: `<amd64 | 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 `hostname`: `<string>` ::
35 Set a host name for the container.
37 `lock`: `<backup | migrate | rollback | snapshot>` ::
41 `memory`: `<integer> (16 - N)` ('default =' `512`)::
43 Amount of RAM for the VM in MB.
45 `mp[n]`: `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
47 Use volume as container mount point.
51 Explicitly enable or disable ACL support.
53 `backup`=`<boolean>` ;;
55 Whether to include the mount point in backups (only used for volume mount points).
59 Path to the mount point as seen from inside the container.
61 NOTE: Must not contain any symlinks for security reasons.
63 `quota`=`<boolean>` ;;
65 Enable user quotas inside the container (not supported with zfs subvolumes)
67 `replicate`=`<boolean>` ('default =' `1`);;
69 Will include this volume to a storage replica job.
75 `shared`=`<boolean>` ('default =' `0`);;
77 Mark this non-volume mount point as available on all nodes.
79 WARNING: This option does not share the mount point automatically, it assumes it is shared already!
81 `size`=`<DiskSize>` ;;
83 Volume size (read only value).
85 `volume`=`<volume>` ;;
87 Volume, device or directory to mount into the container.
89 `nameserver`: `<string>` ::
91 Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
93 `net[n]`: `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
95 Specifies network interfaces for the container.
97 `bridge`=`<bridge>` ;;
99 Bridge to attach the network device to.
101 `firewall`=`<boolean>` ;;
103 Controls whether this interface's firewall rules should be used.
105 `gw`=`<GatewayIPv4>` ;;
107 Default gateway for IPv4 traffic.
109 `gw6`=`<GatewayIPv6>` ;;
111 Default gateway for IPv6 traffic.
113 `hwaddr`=`<XX:XX:XX:XX:XX:XX>` ;;
115 The interface MAC address. This is dynamically allocated by default, but you can set that statically if needed, for example to always have the same link-local IPv6 address. (lxc.network.hwaddr)
117 `ip`=`<IPv4Format/CIDR>` ;;
119 IPv4 address in CIDR format.
121 `ip6`=`<IPv6Format/CIDR>` ;;
123 IPv6 address in CIDR format.
125 `mtu`=`<integer> (64 - N)` ;;
127 Maximum transfer unit of the interface. (lxc.network.mtu)
131 Name of the network device as seen from inside the container. (lxc.network.name)
135 Apply rate limiting to the interface
137 `tag`=`<integer> (1 - 4094)` ;;
139 VLAN tag for this interface.
141 `trunks`=`<vlanid[;vlanid...]>` ;;
143 VLAN ids to pass through the interface
147 Network interface type.
149 `onboot`: `<boolean>` ('default =' `0`)::
151 Specifies whether a VM will be started during system bootup.
153 `ostype`: `<alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
155 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.
157 `protection`: `<boolean>` ('default =' `0`)::
159 Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
161 `rootfs`: `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
163 Use volume as container root.
167 Explicitly enable or disable ACL support.
169 `quota`=`<boolean>` ;;
171 Enable user quotas inside the container (not supported with zfs subvolumes)
173 `replicate`=`<boolean>` ('default =' `1`);;
175 Will include this volume to a storage replica job.
179 Read-only mount point
181 `shared`=`<boolean>` ('default =' `0`);;
183 Mark this non-volume mount point as available on all nodes.
185 WARNING: This option does not share the mount point automatically, it assumes it is shared already!
187 `size`=`<DiskSize>` ;;
189 Volume size (read only value).
191 `volume`=`<volume>` ;;
193 Volume, device or directory to mount into the container.
195 `searchdomain`: `<string>` ::
197 Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
199 `startup`: `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
201 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.
203 `swap`: `<integer> (0 - N)` ('default =' `512`)::
205 Amount of SWAP for the VM in MB.
207 `template`: `<boolean>` ('default =' `0`)::
209 Enable/disable Template.
211 `tty`: `<integer> (0 - 6)` ('default =' `2`)::
213 Specify the number of tty available to the container
215 `unprivileged`: `<boolean>` ('default =' `0`)::
217 Makes the container run as unprivileged user. (Should not be modified manually.)
219 `unused[n]`: `<string>` ::
221 Reference to unused volumes. This is used internally, and should not be modified manually.