vz(5)
| vz(5) | File Formats Manual | vz(5) |
NAME
vz - global OpenVZ configuration file
SYNOPSIS
/etc/vz/vz.conf
DESCRIPTION
This is the global configuration file for OpenVZ. It consists of lines in the form
PARAMETER="value"
All parameter names and values are case-sensitive. Quotes surrounding value are required if value contains spaces, and are optional otherwise. Extra spaces are not allowed. All unrecognized lines will be ignored.
Global parameters
- ACTIONLOGDIR=directory
- Set the directory to write action log files to. Action log files are needed for vzctl/vzcoll interaction, so vzcoll will know what actions are done on CTs.
- LOCKDIR=directory
- Set the directory to put lock files to. This parameter is used by both vzctl(8) and hwcoll(8).
- REMOVEMIGRATED=yes|no
- Remove private area on migrating yes|no This option is not supported for ploop-based CT.
- VE_ENVIRONMENT="NAME=VALUE [NAME=VALUE ...]"
- Environment variables to be set for CT init.
- HTTP_PROXY=[protocol://]host[:port]
- Proxy server configuration.
- USE_NET_HWCSUM=yes|no
- Enable use of hardware checksumming on venet interfaces. In case all the hardware network interfaces in the system support scatter-gather and hw checksumming features it is recommended to set USE_NET_HWCSUM to yes. If USE_NET_HWCSUM is absent or has a value different from yes|no then it is autoconfigured (minimal common subset of capabilities among physical adapters on node).
- USE_NET_TSO=yes|no
- Enable use of hardware tcp segmentation offload on venet interfaces. If USE_NET_TSO is absent or has a value different from yes|no then it is autoconfigured (minimal common subset of capabilities among physical adapters on node).
- USE_NET_RPS=yes|no
- Enables or disables use of Receive packet steering on venet and veth interfaces. RPS is enabled by default.
- USE_VENET_MASK=yes|no
- Enable the assignment of network masks to Containers operating in the venet0 mode (no by default).
- GOLDEN_IMAGE=yes|no
- Enable the use of Golden Images for creating Containers (yes by default). A Golden Image is an extended template cache that includes an OS template and one or more application templates.
- VE_PARALLEL=number
- Sets a number of Containers to start simultaneously on node boot. If not specified, the number is calculated based on node's CPU power. This parameter is used by the /etc/init.d/vz script.
- VE_STOP_MODE=suspend|stop
- Specifies an action to be performed on Containers on node shutdown or
reboot. This parameter is used by the
/etc/init.d/vz script.
• suspend - Suspend Containers on shutdown (default),
• stop - Stop Containers. - REPAIR_MODE=force|auto
- Specifies the mode for the fsck file system checking utility.
• auto - fsck will automatically fix any file system issues that can be safely fixed without human intervention (default).
• force - fsck will always attempt to fix all file system corruption issues automatically (not recommended).
Logging parameters
- LOGGING=yes|no
- Enables or disables logging. This parameter can be set to yes or no, default is yes.
- LOGFILE=file
- Sets location of log file, default is /var/log/vzctl.log.
- LOG_LEVEL=number
- Set the logging level. The more the number is, the more information
will be written to a log file. Default value is 0. Some useful
values are:
• 0 - actions/errors of vzctl on start, stop, mount, umount, create, destroy,
• 1 - logging helper comands vzctl running in /usr/share/libvzctl/scripts,
• 2 - logging create action events, pool, version used on create action,
• 3 - logging vzctl command line.
Disk quota parameters
- DISK_QUOTA=yes|no
- In case the value of this parameter is set to no, all disk quota operations are disabled.
Network interface parameters
- VE_ROUTE_SRC_DEV="device"
- This parameter specifies the network device name which IP address will be used as the source IP. This is helpful in case more than one network interface is configured on HN and there is a need to specify the source IP address. Default is the first device in the network device list.
Network traffic parameters
- TRAFFIC_SHAPING="yes|no"
- Traffic shaping allows limiting bandwidth consumed by Containers. If it is set to yes then limitations will be turned on. Default is no.
- BANDWIDTH="dev [dev ...]"
- List of network devices for traffic shaping. If no value is given, the device will be automatically determined by the default route.
- TOTALRATE="dev:class:Kbits"
- Specifies bound rate for network devices.
- RATE="dev:class:Kbits"
- Specifies guaranteed rate for network devices.
- RATEMPU="dev:class[:bytes]"
- Specifies Minimum Packet Unit for traffic shaping. If packet size is lower then MPU bytes, it will consume MPU HTB tokens. This is to limit packet rate (packet rate = TOTALRATE / RATEMPU). If MPU value (bytes) is omitted then VZ_TC_DEFAULT_MPU (1000) is used. If dev:class is not in RATEMPU then packet rate is not limited for them.
Disk IO limit parameters
- VZ_TOOLS_BCID="ID"
- Enables disk IO limits for backup, restore, and migration operations. Make sure that no Container with the specified ID exists on the Node.
- VZ_TOOLS_IOLIMIT="limit"
- Sets the disk IO limit for backup, restore, and migration operations, in bytes per second.
- VZ_TOOLS_MEMLIMIT="limit"
- Sets the memory limit for backup, restore, and migration operations, in bytes.
Template parameters
- TEMPLATE="directory"
- Value of this parameter is the directory in which all the files and directories shared between all CTs are stored.
Defaults for CT
Below parameters are defaults for CT, and gets overwritten by parameters in ve.conf(5) CT configuration file.
- VE_ROOT=directory
- Value of this parameter is the directory which serves as CT root mount point. Value must contain literal string $VEID, which will be substituted with actual numeric CT ID.
- VE_PRIVATE=directory
- Value of this parameter is the directory in which all the files and directories specific to that CT are stored. Value must contain literal string $VEID, which will be substituted with actual numeric CT ID.
- CONFIGFILE=name
- Specifies default configuration file for create action, corresponds to --config option of vzctl create.
Any other parameter that appears in per-CT configuration file ve.conf(5) can be also set here. Still, it is recommended to keep TEMPLATE, VE_PRIVATE and VE_ROOT in this configuration files, and all the other CT-related parameters in per-CT configuration files.
SEE ALSO
COPYRIGHT
Copyright (c) 1999-2017, Parallels International GmbH. All rights reserved. Copyright (c) 2017-2019 Virtuozzo International GmbH. All rights reserved.
| February 2011 | OpenVZ |
