]>
Commit | Line | Data |
---|---|---|
71e16346 DM |
1 | `arch`: `(amd64 | i386)` (default=`amd64`):: |
2 | ||
3 | OS architecture type. | |
4 | ||
5 | `cmode`: `(console | shell | tty)` (default=`tty`):: | |
6 | ||
7 | Console mode. By default, the console command tries to open a connection to | |
8 | one of the available tty devices. By setting cmode to 'console' it tries to | |
9 | attach to /dev/console instead. If you set cmode to 'shell', it simply | |
10 | invokes a shell inside the container (no login). | |
11 | ||
12 | `console`: `boolean` (default=`1`):: | |
13 | ||
14 | Attach a console device (/dev/console) to the container. | |
15 | ||
16 | `cpulimit`: `number (0 - 128)` (default=`0`):: | |
17 | ||
18 | Limit of CPU usage. | |
19 | + | |
20 | NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' | |
21 | indicates no CPU limit. | |
22 | ||
23 | `cpuunits`: `integer (0 - 500000)` (default=`1024`):: | |
24 | ||
25 | CPU weight for a VM. Argument is used in the kernel fair scheduler. The | |
26 | larger the number is, the more CPU time this VM gets. Number is relative to | |
27 | the weights of all the other running VMs. | |
28 | + | |
29 | NOTE: You can disable fair-scheduler configuration by setting this to 0. | |
30 | ||
31 | `description`: `string` :: | |
32 | ||
33 | Container description. Only used on the configuration web interface. | |
34 | ||
35 | `hostname`: `string` :: | |
36 | ||
37 | Set a host name for the container. | |
38 | ||
39 | `lock`: `(backup | migrate | rollback | snapshot)` :: | |
40 | ||
41 | Lock/unlock the VM. | |
42 | ||
43 | `memory`: `integer (16 - N)` (default=`512`):: | |
44 | ||
45 | Amount of RAM for the VM in MB. | |
46 | ||
47 | `mp[n]`: `mp=<Path>, [volume=]<volume> [,acl=<acl>] [,backup=<[1|0]>] [,quota=<[0|1]>] [,ro=<ro>] [,size=<DiskSize>]` :: | |
48 | ||
49 | Use volume as container mount point (experimental feature). | |
50 | ||
51 | `nameserver`: `string` :: | |
52 | ||
53 | Sets DNS server IP address for a container. Create will automatically use | |
54 | the setting from the host if you neither set searchdomain nor nameserver. | |
55 | ||
ca65cd3a | 56 | `net[n]`: `name=<String> [,bridge=<vmbr<Number>>] [,firewall=<[1|0]>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<MAC>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>] [,mtu=<Number>] [,rate=<mbps>] [,tag=<VlanNo>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` :: |
71e16346 DM |
57 | |
58 | Specifies network interfaces for the container. | |
59 | ||
60 | `onboot`: `boolean` (default=`0`):: | |
61 | ||
62 | Specifies whether a VM will be started during system bootup. | |
63 | ||
64 | `ostype`: `(alpine | archlinux | centos | debian | fedora | opensuse | ubuntu | unmanaged)` :: | |
65 | ||
66 | OS type. This is used to setup configuration inside the container, and | |
67 | corresponds to lxc setup scripts in | |
68 | /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used | |
69 | to skip and OS specific setup. | |
70 | ||
71 | `protection`: `boolean` (default=`0`):: | |
72 | ||
73 | Sets the protection flag of the container. This will prevent the CT or CT's | |
74 | disk remove/update operation. | |
75 | ||
76 | `rootfs`: `[volume=]<volume> [,acl=<acl>] [,backup=<[1|0]>] [,quota=<[0|1]>] [,ro=<ro>] [,size=<DiskSize>]` :: | |
77 | ||
78 | Use volume as container root. | |
79 | ||
80 | `searchdomain`: `string` :: | |
81 | ||
82 | Sets DNS search domains for a container. Create will automatically use the | |
83 | setting from the host if you neither set searchdomain nor nameserver. | |
84 | ||
85 | `startup`: `[[order=]\d+] [,up=\d+] [,down=\d+] ` :: | |
86 | ||
87 | Startup and shutdown behavior. Order is a non-negative number defining the | |
88 | general startup order. Shutdown in done with reverse ordering. Additionally | |
89 | you can set the 'up' or 'down' delay in seconds, which specifies a delay to | |
90 | wait before the next VM is started or stopped. | |
91 | ||
92 | `swap`: `integer (0 - N)` (default=`512`):: | |
93 | ||
94 | Amount of SWAP for the VM in MB. | |
95 | ||
96 | `template`: `boolean` (default=`0`):: | |
97 | ||
98 | Enable/disable Template. | |
99 | ||
100 | `tty`: `integer (0 - 6)` (default=`2`):: | |
101 | ||
102 | Specify the number of tty available to the container | |
103 | ||
104 | `unprivileged`: `boolean` (default=`0`):: | |
105 | ||
106 | Makes the container run as unprivileged user. (Should not be modified | |
107 | manually.) | |
108 | ||
109 | `unused[n]`: `string` :: | |
110 | ||
111 | Reference to unused volumes. | |
112 |