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 `cpulimit`: `number (0 - 128)` (default=`0`)::
  14
  15 Limit of CPU usage.
  16 +
  17 NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.
  18
  19 `cpuunits`: `integer (0 - 500000)` (default=`1024`)::
  20
  21 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.
  22 +
  23 NOTE: You can disable fair-scheduler configuration by setting this to 0.
  24
  25 `description`: `string` ::
  26
  27 Container description. Only used on the configuration web interface.
  28
  29 `hostname`: `string` ::
  30
  31 Set a host name for the container.
  32
  33 `lock`: `(backup | migrate | rollback | snapshot)` ::
  34
  35 Lock/unlock the VM.
  36
  37 `memory`: `integer (16 - N)` (default=`512`)::
  38
  39 Amount of RAM for the VM in MB.
  40
  41 `mp[n]`: `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=<DiskSize>]` ::
  42
  43 Use volume as container mount point.
  44
  45 `acl`=`boolean` ;;
  46
  47 Explicitly enable or disable ACL support.
  48
  49 `backup`=`boolean` ;;
  50
  51 Whether to include the mountpoint in backups (only used for volume mountpoints).
  52
  53 `mp`=`<Path>` ;;
  54
  55 Path to the mountpoint as seen from inside the container.
  56 +
  57 NOTE: Must not contain any symlinks for security reasons.
  58
  59 `quota`=`boolean` ;;
  60
  61 Enable user quotas inside the container (not supported with zfs subvolumes)
  62
  63 `ro`=`boolean` ;;
  64
  65 Read-only mountpoint
  66
  67 `size`=`<DiskSize>` ;;
  68
  69 Volume size (read only value).
  70
  71 `volume`=`<volume>` ;;
  72
  73 Volume, device or directory to mount into the container.
  74
  75 `nameserver`: `string` ::
  76
  77 Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
  78
  79 `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>]` ::
  80
  81 Specifies network interfaces for the container.
  82
  83 `bridge`=`<bridge>` ;;
  84
  85 Bridge to attach the network device to.
  86
  87 `firewall`=`boolean` ;;
  88
  89 Controls whether this interface's firewall rules should be used.
  90
  91 `gw`=`<GatewayIPv4>` ;;
  92
  93 Default gateway for IPv4 traffic.
  94
  95 `gw6`=`<GatewayIPv6>` ;;
  96
  97 Default gateway for IPv6 traffic.
  98
  99 `hwaddr`=`<XX:XX:XX:XX:XX:XX>` ;;
 100
 101 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)
 102
 103 `ip`=`<IPv4Format/CIDR>` ;;
 104
 105 IPv4 address in CIDR format.
 106
 107 `ip6`=`<IPv6Format/CIDR>` ;;
 108
 109 IPv6 address in CIDR format.
 110
 111 `mtu`=`integer (64 - N)` ;;
 112
 113 Maximum transfer unit of the interface. (lxc.network.mtu)
 114
 115 `name`=`<string>` ;;
 116
 117 Name of the network device as seen from inside the container. (lxc.network.name)
 118
 119 `rate`=`<mbps>` ;;
 120
 121 Apply rate limiting to the interface
 122
 123 `tag`=`integer (1 - 4094)` ;;
 124
 125 VLAN tag for this interface.
 126
 127 `trunks`=`<vlanid[;vlanid...]>` ;;
 128
 129 VLAN ids to pass through the interface
 130
 131 `type`=`(veth)` ;;
 132
 133 Network interface type.
 134
 135 `onboot`: `boolean` (default=`0`)::
 136
 137 Specifies whether a VM will be started during system bootup.
 138
 139 `ostype`: `(alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged)` ::
 140
 141 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.
 142
 143 `protection`: `boolean` (default=`0`)::
 144
 145 Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
 146
 147 `rootfs`: `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=<DiskSize>]` ::
 148
 149 Use volume as container root.
 150
 151 `acl`=`boolean` ;;
 152
 153 Explicitly enable or disable ACL support.
 154
 155 `quota`=`boolean` ;;
 156
 157 Enable user quotas inside the container (not supported with zfs subvolumes)
 158
 159 `ro`=`boolean` ;;
 160
 161 Read-only mountpoint
 162
 163 `size`=`<DiskSize>` ;;
 164
 165 Volume size (read only value).
 166
 167 `volume`=`<volume>` ;;
 168
 169 Volume, device or directory to mount into the container.
 170
 171 `searchdomain`: `string` ::
 172
 173 Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
 174
 175 `startup`: `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
 176
 177 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.
 178
 179 `swap`: `integer (0 - N)` (default=`512`)::
 180
 181 Amount of SWAP for the VM in MB.
 182
 183 `template`: `boolean` (default=`0`)::
 184
 185 Enable/disable Template.
 186
 187 `tty`: `integer (0 - 6)` (default=`2`)::
 188
 189 Specify the number of tty available to the container
 190
 191 `unprivileged`: `boolean` (default=`0`)::
 192
 193 Makes the container run as unprivileged user. (Should not be modified manually.)
 194
 195 `unused[n]`: `string` ::
 196
 197 Reference to unused volumes. This is used internally, and should not be modified manually.
 198