]>
Commit | Line | Data |
---|---|---|
013dc89f | 1 | `arch`: `<amd64 | i386>` ('default =' `amd64`):: |
71e16346 DM |
2 | |
3 | OS architecture type. | |
4 | ||
013dc89f | 5 | `cmode`: `<console | shell | tty>` ('default =' `tty`):: |
71e16346 | 6 | |
c2993fe5 | 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). |
71e16346 | 8 | |
013dc89f | 9 | `console`: `<boolean>` ('default =' `1`):: |
71e16346 DM |
10 | |
11 | Attach a console device (/dev/console) to the container. | |
12 | ||
013dc89f | 13 | `cores`: `<integer> (1 - 128)` :: |
de0983cb DM |
14 | |
15 | The number of cores assigned to the container. A container can use all available cores by default. | |
16 | ||
013dc89f | 17 | `cpulimit`: `<number> (0 - 128)` ('default =' `0`):: |
71e16346 DM |
18 | |
19 | Limit of CPU usage. | |
20 | + | |
c2993fe5 | 21 | NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit. |
71e16346 | 22 | |
013dc89f | 23 | `cpuunits`: `<integer> (0 - 500000)` ('default =' `1024`):: |
71e16346 | 24 | |
c2993fe5 | 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. |
71e16346 DM |
26 | + |
27 | NOTE: You can disable fair-scheduler configuration by setting this to 0. | |
28 | ||
013dc89f | 29 | `description`: `<string>` :: |
71e16346 DM |
30 | |
31 | Container description. Only used on the configuration web interface. | |
32 | ||
013dc89f | 33 | `hostname`: `<string>` :: |
71e16346 DM |
34 | |
35 | Set a host name for the container. | |
36 | ||
013dc89f | 37 | `lock`: `<backup | migrate | rollback | snapshot>` :: |
71e16346 DM |
38 | |
39 | Lock/unlock the VM. | |
40 | ||
013dc89f | 41 | `memory`: `<integer> (16 - N)` ('default =' `512`):: |
71e16346 DM |
42 | |
43 | Amount of RAM for the VM in MB. | |
44 | ||
de0983cb | 45 | `mp[n]`: `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` :: |
71e16346 | 46 | |
c2993fe5 DM |
47 | Use volume as container mount point. |
48 | ||
013dc89f | 49 | `acl`=`<boolean>` ;; |
c2993fe5 DM |
50 | |
51 | Explicitly enable or disable ACL support. | |
52 | ||
013dc89f | 53 | `backup`=`<boolean>` ;; |
c2993fe5 | 54 | |
de0983cb | 55 | Whether to include the mount point in backups (only used for volume mount points). |
c2993fe5 DM |
56 | |
57 | `mp`=`<Path>` ;; | |
58 | ||
de0983cb | 59 | Path to the mount point as seen from inside the container. |
2c0dde61 DM |
60 | + |
61 | NOTE: Must not contain any symlinks for security reasons. | |
c2993fe5 | 62 | |
013dc89f | 63 | `quota`=`<boolean>` ;; |
c2993fe5 DM |
64 | |
65 | Enable user quotas inside the container (not supported with zfs subvolumes) | |
66 | ||
013dc89f | 67 | `ro`=`<boolean>` ;; |
c2993fe5 | 68 | |
de0983cb DM |
69 | Read-only mount point |
70 | ||
013dc89f | 71 | `shared`=`<boolean>` ('default =' `0`);; |
de0983cb DM |
72 | |
73 | Mark this non-volume mount point as available on all nodes. | |
74 | + | |
75 | WARNING: This option does not share the mount point automatically, it assumes it is shared already! | |
c2993fe5 DM |
76 | |
77 | `size`=`<DiskSize>` ;; | |
78 | ||
79 | Volume size (read only value). | |
80 | ||
81 | `volume`=`<volume>` ;; | |
82 | ||
83 | Volume, device or directory to mount into the container. | |
71e16346 | 84 | |
013dc89f | 85 | `nameserver`: `<string>` :: |
71e16346 | 86 | |
c2993fe5 | 87 | Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver. |
71e16346 | 88 | |
f004f5b9 | 89 | `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>]` :: |
71e16346 DM |
90 | |
91 | Specifies network interfaces for the container. | |
92 | ||
c2993fe5 DM |
93 | `bridge`=`<bridge>` ;; |
94 | ||
95 | Bridge to attach the network device to. | |
96 | ||
013dc89f | 97 | `firewall`=`<boolean>` ;; |
c2993fe5 DM |
98 | |
99 | Controls whether this interface's firewall rules should be used. | |
100 | ||
101 | `gw`=`<GatewayIPv4>` ;; | |
102 | ||
103 | Default gateway for IPv4 traffic. | |
104 | ||
105 | `gw6`=`<GatewayIPv6>` ;; | |
106 | ||
107 | Default gateway for IPv6 traffic. | |
108 | ||
109 | `hwaddr`=`<XX:XX:XX:XX:XX:XX>` ;; | |
110 | ||
111 | 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) | |
112 | ||
113 | `ip`=`<IPv4Format/CIDR>` ;; | |
114 | ||
115 | IPv4 address in CIDR format. | |
116 | ||
117 | `ip6`=`<IPv6Format/CIDR>` ;; | |
118 | ||
119 | IPv6 address in CIDR format. | |
120 | ||
013dc89f | 121 | `mtu`=`<integer> (64 - N)` ;; |
c2993fe5 DM |
122 | |
123 | Maximum transfer unit of the interface. (lxc.network.mtu) | |
124 | ||
125 | `name`=`<string>` ;; | |
126 | ||
127 | Name of the network device as seen from inside the container. (lxc.network.name) | |
128 | ||
129 | `rate`=`<mbps>` ;; | |
130 | ||
131 | Apply rate limiting to the interface | |
132 | ||
013dc89f | 133 | `tag`=`<integer> (1 - 4094)` ;; |
c2993fe5 DM |
134 | |
135 | VLAN tag for this interface. | |
136 | ||
137 | `trunks`=`<vlanid[;vlanid...]>` ;; | |
138 | ||
139 | VLAN ids to pass through the interface | |
140 | ||
013dc89f | 141 | `type`=`<veth>` ;; |
c2993fe5 DM |
142 | |
143 | Network interface type. | |
144 | ||
013dc89f | 145 | `onboot`: `<boolean>` ('default =' `0`):: |
71e16346 DM |
146 | |
147 | Specifies whether a VM will be started during system bootup. | |
148 | ||
013dc89f | 149 | `ostype`: `<alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged>` :: |
71e16346 | 150 | |
c2993fe5 | 151 | 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. |
71e16346 | 152 | |
013dc89f | 153 | `protection`: `<boolean>` ('default =' `0`):: |
71e16346 | 154 | |
c2993fe5 | 155 | Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation. |
71e16346 | 156 | |
de0983cb | 157 | `rootfs`: `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` :: |
71e16346 DM |
158 | |
159 | Use volume as container root. | |
160 | ||
013dc89f | 161 | `acl`=`<boolean>` ;; |
c2993fe5 DM |
162 | |
163 | Explicitly enable or disable ACL support. | |
164 | ||
013dc89f | 165 | `quota`=`<boolean>` ;; |
c2993fe5 DM |
166 | |
167 | Enable user quotas inside the container (not supported with zfs subvolumes) | |
168 | ||
013dc89f | 169 | `ro`=`<boolean>` ;; |
c2993fe5 | 170 | |
de0983cb DM |
171 | Read-only mount point |
172 | ||
013dc89f | 173 | `shared`=`<boolean>` ('default =' `0`);; |
de0983cb DM |
174 | |
175 | Mark this non-volume mount point as available on all nodes. | |
176 | + | |
177 | WARNING: This option does not share the mount point automatically, it assumes it is shared already! | |
c2993fe5 DM |
178 | |
179 | `size`=`<DiskSize>` ;; | |
180 | ||
181 | Volume size (read only value). | |
182 | ||
183 | `volume`=`<volume>` ;; | |
184 | ||
185 | Volume, device or directory to mount into the container. | |
186 | ||
013dc89f | 187 | `searchdomain`: `<string>` :: |
71e16346 | 188 | |
c2993fe5 | 189 | Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver. |
71e16346 DM |
190 | |
191 | `startup`: `[[order=]\d+] [,up=\d+] [,down=\d+] ` :: | |
192 | ||
c2993fe5 | 193 | 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. |
71e16346 | 194 | |
013dc89f | 195 | `swap`: `<integer> (0 - N)` ('default =' `512`):: |
71e16346 DM |
196 | |
197 | Amount of SWAP for the VM in MB. | |
198 | ||
013dc89f | 199 | `template`: `<boolean>` ('default =' `0`):: |
71e16346 DM |
200 | |
201 | Enable/disable Template. | |
202 | ||
013dc89f | 203 | `tty`: `<integer> (0 - 6)` ('default =' `2`):: |
71e16346 DM |
204 | |
205 | Specify the number of tty available to the container | |
206 | ||
013dc89f | 207 | `unprivileged`: `<boolean>` ('default =' `0`):: |
71e16346 | 208 | |
c2993fe5 | 209 | Makes the container run as unprivileged user. (Should not be modified manually.) |
71e16346 | 210 | |
013dc89f | 211 | `unused[n]`: `<string>` :: |
71e16346 | 212 | |
c2993fe5 | 213 | Reference to unused volumes. This is used internally, and should not be modified manually. |
71e16346 | 214 |