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