Interface nodesLxcConfigVmConfig

Returned by GET /nodes/{node}/lxc/{vmid}/config

Hierarchy

  • nodesLxcConfigVmConfig

Indexable

[additionalProperties: string]: any

Properties

arch?: string

OS architecture type.

cmode?: string

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

Attach a console device (/dev/console) to the container.

cores?: number

The number of cores assigned to the container. A container can use all available cores by default.

cpulimit?: number

Limit of CPU usage. NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.

cpuunits?: number

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. NOTE: You can disable fair-scheduler configuration by setting this to 0.

debug?: boolean

Try to be more verbose. For now this only enables debug log-level on start.

description?: string

Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file.

digest: string

SHA1 digest of configuration file. This can be used to prevent concurrent modifications.

features?: string

Allow containers access to advanced features.

hookscript?: string

Script that will be exectued during various steps in the containers lifetime.

hostname?: string

Set a host name for the container.

lock?: string

Lock/unlock the VM.

lxc?: string[][]

Array of lxc low-level configurations ([[key1, value1], [key2, value2] ...]).

memory?: number

Amount of RAM for the VM in MB.

mp0?: string

Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.

mp1?: string

Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.

mp2?: string

Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.

mp3?: string

Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.

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.

net0?: string

Specifies network interfaces for the container.

net1?: string

Specifies network interfaces for the container.

net2?: string

Specifies network interfaces for the container.

net3?: string

Specifies network interfaces for the container.

onboot?: boolean

Specifies whether a VM will be started during system bootup.

ostype?: string

OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/.common.conf. Value 'unmanaged' can be used to skip and OS specific setup.

protection?: boolean

Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.

rootfs?: string

Use volume as container root.

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.

startup?: string

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?: number

Amount of SWAP for the VM in MB.

tags?: string

Tags of the Container. This is only meta information.

template?: boolean

Enable/disable Template.

timezone?: string

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

tty?: number

Specify the number of tty available to the container

unprivileged?: boolean

Makes the container run as unprivileged user. (Should not be modified manually.)

unused0?: string

Reference to unused volumes. This is used internally, and should not be modified manually.

unused1?: string

Reference to unused volumes. This is used internally, and should not be modified manually.

unused2?: string

Reference to unused volumes. This is used internally, and should not be modified manually.

unused3?: string

Reference to unused volumes. This is used internally, and should not be modified manually.

Generated using TypeDoc