Editing Man/vz.conf.5

== NAME ==

<p style="margin-left:0; margin-top: 1em">vz.conf &minus;
global OpenVZ configuration file</p>

== SYNOPSIS ==

<p style="margin-left:0; margin-top: 1em"><b>/etc/vz/vz.conf</b></p>

== DESCRIPTION ==

<p style="margin-left:11%; margin-top: 1em">This is the
global configuration file for OpenVZ. It consists of lines
in the form</p>

<p style="margin-left:11%; margin-top: 1em"><b>PARAMETER</b>=&quot;<i>value</i>&quot;</p>

<p style="margin-left:11%; margin-top: 1em">All parameter
names and values are case-sensitive. Quotes surrounding
<i>value</i> are required if value contains spaces, and are
optional otherwise. Extra spaces are not allowed. All
unrecognized lines will be ignored.</p>

=== Global parameters ===

<p style="margin-left:11%;"><b>VIRTUOZZO</b>=<b>yes</b>|<b>no</b></p>

<p style="margin-left:22%;">This parameter can be set to
<b>yes</b> or <b>no</b>, and used by the <b>vz</b> init
script. In case it is not set to <b>yes</b>, nothing will be
done to boot up OpenVZ on this node.</p>

<p style="margin-left:11%;"><b>LOCKDIR</b>=<i>directory</i></p>

<p style="margin-left:22%;">Set the directory to put lock
files to.</p>

<p style="margin-left:11%;"><b>VE0CPUUNITS</b>=<i>number</i></p>

<p style="margin-left:22%;">Value of this parameter sets
<b>cpuunits</b> for CT0 (host system).</p>

<p style="margin-left:11%;"><b>LOGGING</b>=<b>yes</b>|<b>no</b></p>

<p style="margin-left:22%;">Enables or disables logging.
This parameter can be set to <b>yes</b> or <b>no</b>,
default is <b>yes</b>.</p>

<p style="margin-left:11%;"><b>LOGFILE</b>=<i>file</i></p>

<p style="margin-left:22%;">Set location of log file.</p>

<p style="margin-left:11%;"><b>LOG_LEVEL</b>=<i>number</i></p>

<p style="margin-left:22%;">Set the logging level for the
log file (does not affect console output). The greater the
<i>number</i> is, the more information will be logged to the
<b>LOGFILE</b>. Default is <b>0</b>, which means to log
normal messages and errors. If set to <b>-1</b>, only errors
will be logged.</p>

<p style="margin-left:11%;"><b>VERBOSE</b>=<i>number</i></p>

<p style="margin-left:22%;">Set the logging level for
console/terminal output (does not affect log file). Default
is <b>0</b>, which means to log normal messages and errors.
Increasing the <b>number</b> makes [[Man/vzctl.8|<b>vzctl</b>(8)]] more
verbose.</p>

<p style="margin-left:11%;"><b>MODULES_DISABLED</b>=<b>yes</b>|<b>no</b></p>

<p style="margin-left:22%;">If the value of this parameter
is set to <b>yes</b>, no attempt to load kernel modules is
made by the <b>vz</b> initscript. This is helpful on systems
which have OpenVZ-specific features compiled into the kernel
(i. e. not as modules).</p>

<p style="margin-left:11%;"><b>IPTABLES_MODULES</b>=&quot;<i>module&nbsp;module&nbsp;...</i>&quot;</p>

<p style="margin-left:22%;">List of iptables kernel modules
to be loaded by <b>vz</b> initscript before loading OpenVZ
modules (which is required for iptables to work inside
containers).</p>

<p style="margin-left:11%;"><b>VZFASTBOOT</b>=<b>yes</b>|<b>no</b></p>

<p style="margin-left:22%;">If the value of this parameter
is set to <b>yes</b>, <b>vz</b> initscript called with
<b>start</b> argument will start the containers with
uncleanly shutdown quota state without performing quota
reinitialization (which is usually a time-consuming
process). After all the containers are started, the
initscript when restarts those containers with unclean quota
in a normal way (to recalculate/fix quotas).</p>

<p style="margin-left:11%;"><b>VE_STOP_MODE</b>=<b>suspend</b>|<b>stop</b></p>

<p style="margin-left:22%;">If the value of this parameter
is set to <b>suspend</b> or not set at all, <b>vz</b>
initscript called with <b>stop</b> argument will try to
suspend the running containers, instead of stopping them.
Suspended containers when will be restored on <b>vz
start</b>. This feature usually helps to decrease the reboot
time. If a container fails to suspend, it will be stopped
anyway.</p>

<p style="margin-left:11%;"><b>VE_PARALLEL</b>=<i>number</i></p>

<p style="margin-left:22%;">A number of containers to be
started or stopped simultaneously on node startup or
shutdown. If not specified, the number is calculated based
on amount of CPU cores. Used by the <b>vz</b>
initscript.</p>

<p style="margin-left:11%;"><b>TEMPLATE</b>=<i>directory</i></p>

<p style="margin-left:22%;">Value of this parameter is a
directory in which all container template data are
stored.</p>

<p style="margin-left:11%;"><b>SKIP_SYSCTL_SETUP</b>=<b>yes</b></p>

<p style="margin-left:22%;">If this parameter is not
present, <b>init.d/vz start</b> sets some
<b>sysctl.conf</b>(5) parameters required or recommended by
OpenVZ (with the help of <b>vz-postinstall sysctl</b>
script), and then adds this parameter to <b>vz.conf</b>.</p>

=== Network interface parameters ===

<p style="margin-left:11%;"><b>VE_ROUTE_SRC_DEV</b>=&quot;<i>device</i>&quot;</p>

<p style="margin-left:22%;">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.</p>

<p style="margin-left:11%;"><b>NEIGHBOUR_DEVS</b>=&quot;<b>all</b>|<b>detect</b>|<b>list:</b><i>dev1&nbsp;</i>[<i>dev2&nbsp;</i>...]&quot;</p>

<p style="margin-left:22%;">Controls on which interfaces to
add/remove ARP records for a container IP, also which
interfaces to use to query/announce ARP.</p>

<p style="margin-left:22%; margin-top: 1em">If set to
<b>all</b>, an empty string, or unset, all possible network
interfaces (i.e. the ones that are UP and doesn&rsquo;t have
NOARP, SLAVE, or LOOPBACK flags) are used. This is the
default mode.</p>

<p style="margin-left:22%; margin-top: 1em">If set to
<b>detect</b>, the right network interface (i.e. the one
which is in the same subnet as a container IP) will be
chosen automatically.</p>

<p style="margin-left:22%; margin-top: 1em">If the value
starts with <b>list:</b> prefix, the space-separated list of
interfaces following the prefix is used.</p>

<p style="margin-left:11%;"><b>ERROR_ON_ARPFAIL</b>=<b>yes</b>|<b>no</b></p>

<p style="margin-left:22%;">In case the value of this
parameter is set to <b>yes</b>, vzctl will fail to start a
container if there is another host with the same IP present
in the network. Any other value makes vzctl to only print
the warning (which is the default behavior).</p>

<p style="margin-left:11%;"><b>SKIP_ARPDETECT</b>=<b>yes</b>|<b>no</b></p>

<p style="margin-left:22%;">In case the value of this
parameter is set to <b>yes</b>, vzctl will not use ARP
queries when starting a container in order to detect if
there is another host with the same IP present in the
network. Note that for each IP, vzctl sends ARP query and
waits up to 1 second for response. Any other value means to
do ARP detection.</p>

=== Defaults for vzctl create ===

<p style="margin-top: 1em">These parameters are defaults
for <b>vzctl create</b> and can be overwritten by its
appropriate command line options.</p>

<p style="margin-left:11%;"><b>DEF_OSTEMPLATE</b>=<i>name</i></p>

<p style="margin-left:22%;">Default OS template to create a
container from. Corresponds to <b>--ostemplate</b> option of
<b>vzctl create</b>.</p>

<p style="margin-left:11%;"><b>CONFIGFILE</b>=<i>name</i></p>

<p style="margin-left:22%;">Default configuration file
(<b>/etc/vz/conf/ve-</b><i>name</i><b>.conf-sample</b>) used
to create a new container. Corresponds to <b>--config</b>
option of <b>vzctl create</b>.</p>

<p style="margin-left:11%;"><b>VE_LAYOUT</b>=<b>simfs</b>|<b>ploop</b>[<b>:</b>{<b>plain</b>|<b>expanded</b>|<b>raw</b>}]</p>

<p style="margin-left:22%;">Default CT filesystem layout
for a new container, can either be <b>ploop</b> or
<b>simfs</b>. In case <b>ploop</b> is used, one can
additionally specify ploop disk image format after a colon.
Possible ploop formats are <b>expanded</b>, <b>plain</b> and
<b>raw</b>. Default is <b>expanded</b>. Using <b>raw</b> is
not recommended and is not supported.</p>

<p style="margin-left:22%; margin-top: 1em">Corresponds to
<b>--layout</b> option of <b>vzctl create</b>.</p>

=== Defaults for containers ===

<p style="margin-top: 1em">Below parameters are defaults
for containers, and can be overwritten by parameters in
[[Man/ctid.conf.5|<b>ctid.conf</b>(5)]] per-container configuration file.</p>

<p style="margin-left:11%;"><b>DISK_QUOTA</b>=<b>yes</b>|<b>no</b></p>

<p style="margin-left:22%;">In case the value of this
parameter is set to <b>no</b>, all disk quota operations are
disabled.</p>

<p style="margin-left:11%;"><b>VE_ROOT</b>=<i>directory</i></p>

<p style="margin-left:22%;">Value of this parameter is the
<i>directory</i> which serves as container root mount point.
Value must contain literal string <b>$VEID</b>, which will
be substituted with the actual numeric CT ID.</p>

<p style="margin-left:11%;"><b>VE_PRIVATE</b>=<i>directory</i></p>

<p style="margin-left:22%;">Value of this parameter is the
<i>directory</i> in which all the files and directories
specific to that container are stored. Value must contain
literal string <b>$VEID</b>, which will be substituted with
the actual numeric CT ID.</p>

<p style="margin-left:11%;"><b>STOP_TIMEOUT</b>=&quot;<i>number</i>&quot;</p>

<p style="margin-left:22%;">Time to wait for a container to
shut down on <b>vzctl stop</b>, before forcibly killing it,
in seconds. Hardcoded to 120 if not set.</p>

<p style="margin-left:11%;"><b>NAMESERVER</b>=&quot;<i>ip&nbsp;</i>[<i>ip&nbsp;</i>...]&quot;</p>

<p style="margin-left:22%;">Default value for containers
nameserver(s). Several name server addresses are divided by
spaces. If set to <b>inherit</b>, values from host
system&rsquo;s <b>/etc/resolv.conf</b> are used.</p>

<p style="margin-left:11%;"><b>SEARCHDOMAIN</b>=&quot;<i>domain&nbsp;</i>[<i>domain&nbsp;</i>...]&quot;</p>

<p style="margin-left:22%;">Default value for containers
search domains. Several search domains are divided by
spaces. If set to <b>inherit</b>, values from host
system&rsquo;s <b>/etc/resolv.conf</b> are used.</p>

<p style="margin-left:11%; margin-top: 1em">Most of the
other parameters that appear in per-container configuration
files [[Man/ctid.conf.5|<b>ctid.conf</b>(5)]] can be also set here. Still, it is
recommended to keep <b>TEMPLATE</b>, <b>VE_PRIVATE</b> and
<b>VE_ROOT</b> in this configuration file, and all the other
container related parameters in per-container configuration
files.</p>

== SEE ALSO ==

<p style="margin-left:11%; margin-top: 1em">[[Man/vzctl.8|<b>vzctl</b>(8)]],
[[Man/ctid.conf.5|<b>ctid.conf</b>(5)]].</p>

== LICENSE ==

<p style="margin-left:11%; margin-top: 1em">Copyright (C)
2000-2011, Parallels, Inc. Licensed under GNU GPL.</p>
@@ Line 176: / Line 176: @@
 waits up to 1 second for response. Any other value means to
 do ARP detection.</p>
-<p style="margin-left:11%;"><b>FORCE_ROUTE</b>=<b>yes</b>|<b>no</b></p>
-<p style="margin-left:22%;">In case the value of this
-parameter is set to <b>yes</b>, vzctl will attempt to change
-an existing route to point to a container when starting a
-container if new route setup fails. Any other value means to
-only attempt to add new routes (default behavior).</p>
 === Defaults for vzctl create ===