← Older revision
Revision as of 15:26, 8 November 2016
Line 26:
Line 26:
Those settings are directly passed to the LXC low-level tools.
Those settings are directly passed to the LXC low-level tools.
Options
Options
−
arch:
(
amd64 | i386
)
(default=amd64)
+
arch:
<
amd64 | i386
>
(default = amd64)
OS architecture type.
OS architecture type.
−
cmode:
(
console | shell | tty
)
(default=tty)
+
cmode:
<
console | shell | tty
>
(default = tty)
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).
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).
−
console: boolean (default=1)
+
console:
<
boolean
>
(default = 1)
Attach a console device (/dev/console) to the container.
Attach a console device (/dev/console) to the container.
−
cpulimit: number (0 - 128) (default=0)
+
cores: <integer> (1 - 128)
+
The number of cores assigned to the container. A container can use all available cores by default.
+
cpulimit:
<
number
>
(0 - 128) (default = 0)
Limit of CPU usage.
Limit of CPU usage.
If the computer has 2 CPUs, it has a total of 2 CPU time. Value 0 indicates no CPU limit.
If the computer has 2 CPUs, it has a total of 2 CPU time. Value 0 indicates no CPU limit.
−
cpuunits: integer (0 - 500000) (default=1024)
+
cpuunits:
<
integer
>
(0 - 500000) (default = 1024)
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.
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.
You can disable fair-scheduler configuration by setting this to 0.
You can disable fair-scheduler configuration by setting this to 0.
−
description: string
+
description:
<
string
>
Container description. Only used on the configuration web interface.
Container description. Only used on the configuration web interface.
−
hostname: string
+
hostname:
<
string
>
Set a host name for the container.
Set a host name for the container.
−
lock:
(
backup | migrate | rollback | snapshot
)
+
lock:
<
backup | migrate | rollback | snapshot
>
Lock/unlock the VM.
Lock/unlock the VM.
−
memory: integer (16 - N) (default=512)
+
memory:
<
integer
>
(16 - N) (default = 512)
Amount of RAM for the VM in MB.
Amount of RAM for the VM in MB.
−
mp[n]: [volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=<DiskSize>]
+
mp[n]: [volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro
=<1|0>] [,shared
=<1|0>] [,size=<DiskSize>]
Use volume as container mount point.
Use volume as container mount point.
−
acl=boolean
+
acl=
<
boolean
>
Explicitly enable or disable ACL support.
Explicitly enable or disable ACL support.
−
backup=boolean
+
backup=
<
boolean
>
−
Whether to include the
mountpoint
in backups (only used for volume
mountpoints
).
+
Whether to include the
mount point
in backups (only used for volume
mount points
).
mp=<Path>
mp=<Path>
−
Path to the
mountpoint
as seen from inside the container.
+
Path to the
mount point
as seen from inside the container.
Must not contain any symlinks for security reasons.
Must not contain any symlinks for security reasons.
−
quota=boolean
+
quota=
<
boolean
>
Enable user quotas inside the container (not supported with zfs subvolumes)
Enable user quotas inside the container (not supported with zfs subvolumes)
−
ro=boolean
+
ro=
<
boolean
>
−
Read-only
mountpoint
+
Read-only
mount point
+
shared=<boolean> (default = 0)
+
Mark this non-volume mount point as available on all nodes.
+
This option does not share the mount point automatically, it assumes it is shared already!
size=<DiskSize>
size=<DiskSize>
Volume size (read only value).
Volume size (read only value).
volume=<volume>
volume=<volume>
Volume, device or directory to mount into the container.
Volume, device or directory to mount into the container.
−
nameserver: string
+
nameserver:
<
string
>
Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
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>]
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>]
Line 69:
Line 74:
bridge=<bridge>
bridge=<bridge>
Bridge to attach the network device to.
Bridge to attach the network device to.
−
firewall=boolean
+
firewall=
<
boolean
>
Controls whether this interface’s firewall rules should be used.
Controls whether this interface’s firewall rules should be used.
gw=<GatewayIPv4>
gw=<GatewayIPv4>
Line 81:
Line 86:
ip6=<IPv6Format/CIDR>
ip6=<IPv6Format/CIDR>
IPv6 address in CIDR format.
IPv6 address in CIDR format.
−
mtu=integer (64 - N)
+
mtu=
<
integer
>
(64 - N)
Maximum transfer unit of the interface. (lxc.network.mtu)
Maximum transfer unit of the interface. (lxc.network.mtu)
name=<string>
name=<string>
Line 87:
Line 92:
rate=<mbps>
rate=<mbps>
Apply rate limiting to the interface
Apply rate limiting to the interface
−
tag=integer (1 - 4094)
+
tag=
<
integer
>
(1 - 4094)
VLAN tag for this interface.
VLAN tag for this interface.
trunks=<vlanid[;vlanid...]>
trunks=<vlanid[;vlanid...]>
VLAN ids to pass through the interface
VLAN ids to pass through the interface
−
type=
(
veth
)
+
type=
<
veth
>
Network interface type.
Network interface type.
−
onboot: boolean (default=0)
+
onboot:
<
boolean
>
(default = 0)
Specifies whether a VM will be started during system bootup.
Specifies whether a VM will be started during system bootup.
−
ostype:
(
alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged
)
+
ostype:
<
alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged
>
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.
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.
−
protection: boolean (default=0)
+
protection:
<
boolean
>
(default = 0)
Sets the protection flag of the container. This will prevent the CT or CT’s disk remove/update operation.
Sets the protection flag of the container. This will prevent the CT or CT’s disk remove/update operation.
−
rootfs: [volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=<DiskSize>]
+
rootfs: [volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,ro
=<1|0>] [,shared
=<1|0>] [,size=<DiskSize>]
Use volume as container root.
Use volume as container root.
−
acl=boolean
+
acl=
<
boolean
>
Explicitly enable or disable ACL support.
Explicitly enable or disable ACL support.
−
quota=boolean
+
quota=
<
boolean
>
Enable user quotas inside the container (not supported with zfs subvolumes)
Enable user quotas inside the container (not supported with zfs subvolumes)
−
ro=boolean
+
ro=
<
boolean
>
−
Read-only
mountpoint
+
Read-only
mount point
+
shared=<boolean> (default = 0)
+
Mark this non-volume mount point as available on all nodes.
+
This option does not share the mount point automatically, it assumes it is shared already!
size=<DiskSize>
size=<DiskSize>
Volume size (read only value).
Volume size (read only value).
volume=<volume>
volume=<volume>
Volume, device or directory to mount into the container.
Volume, device or directory to mount into the container.
−
searchdomain: string
+
searchdomain:
<
string
>
Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
startup: `[[order=]\d+] [,up=\d+] [,down=\d+] `
startup: `[[order=]\d+] [,up=\d+] [,down=\d+] `
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.
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.
−
swap: integer (0 - N) (default=512)
+
swap:
<
integer
>
(0 - N) (default = 512)
Amount of SWAP for the VM in MB.
Amount of SWAP for the VM in MB.
−
template: boolean (default=0)
+
template:
<
boolean
>
(default = 0)
Enable/disable Template.
Enable/disable Template.
−
tty: integer (0 - 6) (default=2)
+
tty:
<
integer
>
(0 - 6) (default = 2)
Specify the number of tty available to the container
Specify the number of tty available to the container
−
unprivileged: boolean (default=0)
+
unprivileged:
<
boolean
>
(default = 0)
Makes the container run as unprivileged user. (Should not be modified manually.)
Makes the container run as unprivileged user. (Should not be modified manually.)
−
unused[n]: string
+
unused[n]:
<
string
>
Reference to unused volumes. This is used internally, and should not be modified manually.
Reference to unused volumes. This is used internally, and should not be modified manually.
Copyright and Disclaimer
Copyright and Disclaimer