pct.conf.5-opts.adoc

   1 `arch`: `<amd64 | arm64 | armhf | 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 - 8192)` ::
  14
  15 The number of cores assigned to the container. A container can use all available cores by default.
  16
  17 `cpulimit`: `<number> (0 - 8192)` ('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 =' `cgroup v1: 1024, cgroup v2: 100`)::
  24
  25 CPU weight for a container. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this container gets. Number is relative to the weights of all the other running guests.
  26
  27 `debug`: `<boolean>` ('default =' `0`)::
  28
  29 Try to be more verbose. For now this only enables debug log-level on start.
  30
  31 `description`: `<string>` ::
  32
  33 Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file.
  34
  35 `features`: `[force_rw_sys=<1|0>] [,fuse=<1|0>] [,keyctl=<1|0>] [,mknod=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
  36
  37 Allow containers access to advanced features.
  38
  39 `force_rw_sys`=`<boolean>` ('default =' `0`);;
  40
  41 Mount /sys in unprivileged containers as `rw` instead of `mixed`. This can break networking under newer (>= v245) systemd-network use.
  42
  43 `fuse`=`<boolean>` ('default =' `0`);;
  44
  45 Allow using 'fuse' file systems in a container. Note that interactions between fuse and the freezer cgroup can potentially cause I/O deadlocks.
  46
  47 `keyctl`=`<boolean>` ('default =' `0`);;
  48
  49 For unprivileged containers only: Allow the use of the keyctl() system call. This is required to use docker inside a container. By default unprivileged containers will see this system call as non-existent. This is mostly a workaround for systemd-networkd, as it will treat it as a fatal error when some keyctl() operations are denied by the kernel due to lacking permissions. Essentially, you can choose between running systemd-networkd or docker.
  50
  51 `mknod`=`<boolean>` ('default =' `0`);;
  52
  53 Allow unprivileged containers to use mknod() to add certain device nodes. This requires a kernel with seccomp trap to user space support (5.3 or newer). This is experimental.
  54
  55 `mount`=`<fstype;fstype;...>` ;;
  56
  57 Allow mounting file systems of specific types. This should be a list of file system types as used with the mount command. Note that this can have negative effects on the container's security. With access to a loop device, mounting a file can circumvent the mknod permission of the devices cgroup, mounting an NFS file system can block the host's I/O completely and prevent it from rebooting, etc.
  58
  59 `nesting`=`<boolean>` ('default =' `0`);;
  60
  61 Allow nesting. Best used with unprivileged containers with additional id mapping. Note that this will expose procfs and sysfs contents of the host to the guest.
  62
  63 `hookscript`: `<string>` ::
  64
  65 Script that will be exectued during various steps in the containers lifetime.
  66
  67 `hostname`: `<string>` ::
  68
  69 Set a host name for the container.
  70
  71 `lock`: `<backup | create | destroyed | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
  72
  73 Lock/unlock the container.
  74
  75 `memory`: `<integer> (16 - N)` ('default =' `512`)::
  76
  77 Amount of RAM for the container in MB.
  78
  79 `mp[n]`: `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
  80
  81 Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
  82
  83 `acl`=`<boolean>` ;;
  84
  85 Explicitly enable or disable ACL support.
  86
  87 `backup`=`<boolean>` ;;
  88
  89 Whether to include the mount point in backups (only used for volume mount points).
  90
  91 `mountoptions`=`<opt[;opt...]>` ;;
  92
  93 Extra mount options for rootfs/mps.
  94
  95 `mp`=`<Path>` ;;
  96
  97 Path to the mount point as seen from inside the container.
  98 +
  99 NOTE: Must not contain any symlinks for security reasons.
 100
 101 `quota`=`<boolean>` ;;
 102
 103 Enable user quotas inside the container (not supported with zfs subvolumes)
 104
 105 `replicate`=`<boolean>` ('default =' `1`);;
 106
 107 Will include this volume to a storage replica job.
 108
 109 `ro`=`<boolean>` ;;
 110
 111 Read-only mount point
 112
 113 `shared`=`<boolean>` ('default =' `0`);;
 114
 115 Mark this non-volume mount point as available on all nodes.
 116 +
 117 WARNING: This option does not share the mount point automatically, it assumes it is shared already!
 118
 119 `size`=`<DiskSize>` ;;
 120
 121 Volume size (read only value).
 122
 123 `volume`=`<volume>` ;;
 124
 125 Volume, device or directory to mount into the container.
 126
 127 `nameserver`: `<string>` ::
 128
 129 Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
 130
 131 `net[n]`: `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
 132
 133 Specifies network interfaces for the container.
 134
 135 `bridge`=`<bridge>` ;;
 136
 137 Bridge to attach the network device to.
 138
 139 `firewall`=`<boolean>` ;;
 140
 141 Controls whether this interface's firewall rules should be used.
 142
 143 `gw`=`<GatewayIPv4>` ;;
 144
 145 Default gateway for IPv4 traffic.
 146
 147 `gw6`=`<GatewayIPv6>` ;;
 148
 149 Default gateway for IPv6 traffic.
 150
 151 `hwaddr`=`<XX:XX:XX:XX:XX:XX>` ;;
 152
 153 A common MAC address with the I/G (Individual/Group) bit not set.
 154
 155 `ip`=`<(IPv4/CIDR|dhcp|manual)>` ;;
 156
 157 IPv4 address in CIDR format.
 158
 159 `ip6`=`<(IPv6/CIDR|auto|dhcp|manual)>` ;;
 160
 161 IPv6 address in CIDR format.
 162
 163 `mtu`=`<integer> (64 - 65535)` ;;
 164
 165 Maximum transfer unit of the interface. (lxc.network.mtu)
 166
 167 `name`=`<string>` ;;
 168
 169 Name of the network device as seen from inside the container. (lxc.network.name)
 170
 171 `rate`=`<mbps>` ;;
 172
 173 Apply rate limiting to the interface
 174
 175 `tag`=`<integer> (1 - 4094)` ;;
 176
 177 VLAN tag for this interface.
 178
 179 `trunks`=`<vlanid[;vlanid...]>` ;;
 180
 181 VLAN ids to pass through the interface
 182
 183 `type`=`<veth>` ;;
 184
 185 Network interface type.
 186
 187 `onboot`: `<boolean>` ('default =' `0`)::
 188
 189 Specifies whether a container will be started during system bootup.
 190
 191 `ostype`: `<alpine | archlinux | centos | debian | devuan | fedora | gentoo | nixos | opensuse | ubuntu | unmanaged>` ::
 192
 193 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.
 194
 195 `protection`: `<boolean>` ('default =' `0`)::
 196
 197 Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
 198
 199 `rootfs`: `[volume=]<volume> [,acl=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
 200
 201 Use volume as container root.
 202
 203 `acl`=`<boolean>` ;;
 204
 205 Explicitly enable or disable ACL support.
 206
 207 `mountoptions`=`<opt[;opt...]>` ;;
 208
 209 Extra mount options for rootfs/mps.
 210
 211 `quota`=`<boolean>` ;;
 212
 213 Enable user quotas inside the container (not supported with zfs subvolumes)
 214
 215 `replicate`=`<boolean>` ('default =' `1`);;
 216
 217 Will include this volume to a storage replica job.
 218
 219 `ro`=`<boolean>` ;;
 220
 221 Read-only mount point
 222
 223 `shared`=`<boolean>` ('default =' `0`);;
 224
 225 Mark this non-volume mount point as available on all nodes.
 226 +
 227 WARNING: This option does not share the mount point automatically, it assumes it is shared already!
 228
 229 `size`=`<DiskSize>` ;;
 230
 231 Volume size (read only value).
 232
 233 `volume`=`<volume>` ;;
 234
 235 Volume, device or directory to mount into the container.
 236
 237 `searchdomain`: `<string>` ::
 238
 239 Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
 240
 241 `startup`: `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
 242
 243 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.
 244
 245 `swap`: `<integer> (0 - N)` ('default =' `512`)::
 246
 247 Amount of SWAP for the container in MB.
 248
 249 `tags`: `<string>` ::
 250
 251 Tags of the Container. This is only meta information.
 252
 253 `template`: `<boolean>` ('default =' `0`)::
 254
 255 Enable/disable Template.
 256
 257 `timezone`: `<string>` ::
 258
 259 Time zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tab
 260
 261 `tty`: `<integer> (0 - 6)` ('default =' `2`)::
 262
 263 Specify the number of tty available to the container
 264
 265 `unprivileged`: `<boolean>` ('default =' `0`)::
 266
 267 Makes the container run as unprivileged user. (Should not be modified manually.)
 268
 269 `unused[n]`: `[volume=]<volume>` ::
 270
 271 Reference to unused volumes. This is used internally, and should not be modified manually.
 272
 273 `volume`=`<volume>` ;;
 274
 275 The volume that is not used currently.
 276