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 `cpulimit`: `number (0 - 128)` (default=`0`)::
17 NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.
19 `cpuunits`: `integer (0 - 500000)` (default=`1024`)::
21 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.
23 NOTE: You can disable fair-scheduler configuration by setting this to 0.
25 `description`: `string` ::
27 Container description. Only used on the configuration web interface.
29 `hostname`: `string` ::
31 Set a host name for the container.
33 `lock`: `(backup | migrate | rollback | snapshot)` ::
37 `memory`: `integer (16 - N)` (default=`512`)::
39 Amount of RAM for the VM in MB.
41 `mp[n]`: `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=<DiskSize>]` ::
43 Use volume as container mount point.
47 Explicitly enable or disable ACL support.
51 Whether to include the mountpoint in backups.
55 Path to the mountpoint as seen from inside the container.
59 Enable user quotas inside the container (not supported with zfs subvolumes)
63 Read-only mountpoint (not supported with bind mounts)
65 `size`=`<DiskSize>` ;;
67 Volume size (read only value).
69 `volume`=`<volume>` ;;
71 Volume, device or directory to mount into the container.
73 `nameserver`: `string` ::
75 Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
77 `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>]` ::
79 Specifies network interfaces for the container.
81 `bridge`=`<bridge>` ;;
83 Bridge to attach the network device to.
85 `firewall`=`boolean` ;;
87 Controls whether this interface's firewall rules should be used.
89 `gw`=`<GatewayIPv4>` ;;
91 Default gateway for IPv4 traffic.
93 `gw6`=`<GatewayIPv6>` ;;
95 Default gateway for IPv6 traffic.
97 `hwaddr`=`<XX:XX:XX:XX:XX:XX>` ;;
99 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)
101 `ip`=`<IPv4Format/CIDR>` ;;
103 IPv4 address in CIDR format.
105 `ip6`=`<IPv6Format/CIDR>` ;;
107 IPv6 address in CIDR format.
109 `mtu`=`integer (64 - N)` ;;
111 Maximum transfer unit of the interface. (lxc.network.mtu)
115 Name of the network device as seen from inside the container. (lxc.network.name)
119 Apply rate limiting to the interface
121 `tag`=`integer (1 - 4094)` ;;
123 VLAN tag for this interface.
125 `trunks`=`<vlanid[;vlanid...]>` ;;
127 VLAN ids to pass through the interface
131 Network interface type.
133 `onboot`: `boolean` (default=`0`)::
135 Specifies whether a VM will be started during system bootup.
137 `ostype`: `(alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged)` ::
139 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.
141 `protection`: `boolean` (default=`0`)::
143 Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
145 `rootfs`: `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=<DiskSize>]` ::
147 Use volume as container root.
151 Explicitly enable or disable ACL support.
155 Enable user quotas inside the container (not supported with zfs subvolumes)
159 Read-only mountpoint (not supported with bind mounts)
161 `size`=`<DiskSize>` ;;
163 Volume size (read only value).
165 `volume`=`<volume>` ;;
167 Volume, device or directory to mount into the container.
169 `searchdomain`: `string` ::
171 Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
173 `startup`: `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
175 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.
177 `swap`: `integer (0 - N)` (default=`512`)::
179 Amount of SWAP for the VM in MB.
181 `template`: `boolean` (default=`0`)::
183 Enable/disable Template.
185 `tty`: `integer (0 - 6)` (default=`2`)::
187 Specify the number of tty available to the container
189 `unprivileged`: `boolean` (default=`0`)::
191 Makes the container run as unprivileged user. (Should not be modified manually.)
193 `unused[n]`: `string` ::
195 Reference to unused volumes. This is used internally, and should not be modified manually.