buildsys: don't use rm -r on so many globs
[pve-docs.git] / pct.conf.5-opts.adoc
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 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).
8
9 `console`: `<boolean>` ('default =' `1`)::
10
11 Attach a console device (/dev/console) to the container.
12
13 `cores`: `<integer> (1 - 128)` ::
14
15 The number of cores assigned to the container. A container can use all available cores by default.
16
17 `cpulimit`: `<number> (0 - 128)` ('default =' `0`)::
18
19 Limit of CPU usage.
20 +
21 NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' 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 larger the number is, the more CPU time this VM gets. Number is relative to the weights of all the other running VMs.
26 +
27 NOTE: You can disable fair-scheduler configuration by setting this to 0.
28
29 `description`: `<string>` ::
30
31 Container description. Only used on the configuration web interface.
32
33 `hostname`: `<string>` ::
34
35 Set a host name for the container.
36
37 `lock`: `<backup | migrate | rollback | snapshot>` ::
38
39 Lock/unlock the VM.
40
41 `memory`: `<integer> (16 - N)` ('default =' `512`)::
42
43 Amount of RAM for the VM in MB.
44
45 `mp[n]`: `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
46
47 Use volume as container mount point.
48
49 `acl`=`<boolean>` ;;
50
51 Explicitly enable or disable ACL support.
52
53 `backup`=`<boolean>` ;;
54
55 Whether to include the mount point in backups (only used for volume mount points).
56
57 `mp`=`<Path>` ;;
58
59 Path to the mount point as seen from inside the container.
60 +
61 NOTE: Must not contain any symlinks for security reasons.
62
63 `quota`=`<boolean>` ;;
64
65 Enable user quotas inside the container (not supported with zfs subvolumes)
66
67 `ro`=`<boolean>` ;;
68
69 Read-only mount point
70
71 `shared`=`<boolean>` ('default =' `0`);;
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!
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.
84
85 `nameserver`: `<string>` ::
86
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.
88
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>]` ::
90
91 Specifies network interfaces for the container.
92
93 `bridge`=`<bridge>` ;;
94
95 Bridge to attach the network device to.
96
97 `firewall`=`<boolean>` ;;
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
121 `mtu`=`<integer> (64 - N)` ;;
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
133 `tag`=`<integer> (1 - 4094)` ;;
134
135 VLAN tag for this interface.
136
137 `trunks`=`<vlanid[;vlanid...]>` ;;
138
139 VLAN ids to pass through the interface
140
141 `type`=`<veth>` ;;
142
143 Network interface type.
144
145 `onboot`: `<boolean>` ('default =' `0`)::
146
147 Specifies whether a VM will be started during system bootup.
148
149 `ostype`: `<alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
150
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.
152
153 `protection`: `<boolean>` ('default =' `0`)::
154
155 Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
156
157 `rootfs`: `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
158
159 Use volume as container root.
160
161 `acl`=`<boolean>` ;;
162
163 Explicitly enable or disable ACL support.
164
165 `quota`=`<boolean>` ;;
166
167 Enable user quotas inside the container (not supported with zfs subvolumes)
168
169 `ro`=`<boolean>` ;;
170
171 Read-only mount point
172
173 `shared`=`<boolean>` ('default =' `0`);;
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!
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
187 `searchdomain`: `<string>` ::
188
189 Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
190
191 `startup`: `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
192
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.
194
195 `swap`: `<integer> (0 - N)` ('default =' `512`)::
196
197 Amount of SWAP for the VM in MB.
198
199 `template`: `<boolean>` ('default =' `0`)::
200
201 Enable/disable Template.
202
203 `tty`: `<integer> (0 - 6)` ('default =' `2`)::
204
205 Specify the number of tty available to the container
206
207 `unprivileged`: `<boolean>` ('default =' `0`)::
208
209 Makes the container run as unprivileged user. (Should not be modified manually.)
210
211 `unused[n]`: `<string>` ::
212
213 Reference to unused volumes. This is used internally, and should not be modified manually.
214