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