1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE database SYSTEM "configuration.dtd" []>
5 <database xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6 xsi:noNamespaceSchemaLocation="file:configuration.xsd">
8 <!-- Global configuration -->
9 <collection name=".defaults" use="optional">
10 <collection name="init" type="fixed">
12 <description>Default mtab file</description>
16 <link name="vdirbase">
17 <default>/vservers</default>
18 <description>A link to the default vserver rootdirectory.</description>
21 <link name="cachebase">
22 <default>/var/cache/vservers</default>
24 A link to the directory which will hold cached information about
29 <boolean id="global-nonamespace" name="nonamespace">
31 Disable namespace usage globally. It can be overridden for a single vserver
32 by setting the <optionref ref="global-namespace">namespace</optionref> flag
35 In this mode the <directory>/vservers</directory> directory must have
36 the 'barrier' attribute. Else, common chroot(2) exploits are possible.
40 <boolean id="global-nonamespace-cleanup" name="nonamespace-cleanup">
42 Disable namespace cleanup globally. It can be overridden for a single vserver
43 by setting the <optionref ref="namespace-cleanup">namespace-cleanup</optionref> flag
48 <list id="global-namespace-cleanup-skip" name="namespace-cleanup-skip">
50 List of paths to skip during namespace cleanup.
56 Path of the vserver run reverse directory. This directory contains
57 symlinks named with XID numbers which point back to the configuration
58 directory of vservers. Under kernel 2.4 this is required for the XID
59 to VSERVER mapping; Under kernel 2.6 it is unused.
61 NOTE: this link exists in 0.30.202+ only; in previous versions it was
62 a vserver specific setting.
68 Contains the pathname of the shell which will be used by the "vserver
69 ... enter" command. Can be overridden by the
70 <optionref ref="shell">per-guest shell</optionref>.
76 The default fstab file to put in newly built guests.
80 <boolean name="context.dynamic">
82 If this file exists, kernel-side dynamic contexts will be used by the "vserver
83 ... build" command. Otherwise a context will be generated, based on the
84 contents of <optionref>context.next</optionref>.
88 <scalar id="context.next" name="context.next">
90 The context id to use for the next guest created by "vserver ... build".
94 <collection name="apps">
95 <collection name="pkgmgmt">
97 <default>/vservers/.pkg</default>
99 <data name="apt.conf">
100 <description>The default apt.conf which is going to be used. It is overridden by
101 distribution specific configuration file.
106 <collection name="debootstrap">
107 <scalar name="mirror">
109 The Debian mirror to use with the <tool>debootstrap</tool> program
114 When the <tool>debootstrap</tool> package is not installed; fetch it
115 from this uri and install it at a temporary place.
120 <collection name="vdevmap">
121 <collection name="x" type="sybmolic">
122 <description>'x' is an arbitrary name, replace it with e.g. device names</description>
123 <boolean name="open">
124 <description>When this file exists, the device can be opened</description>
126 <boolean name="create">
127 <description>When this file exists, the device can be created (if the guest has <optionref ref="bcapabilities">CAP_MKNOD</optionref>)</description>
129 <boolean id="vdevmap-remap" name="remap">
131 When this file exists, <optionref ref="vdevmap-target">target</optionref> will
132 have to exist as well and opening the device will in fact open the target device
135 <scalar name="flags">
136 <description>This file will let you specify unimplemented flags manually</description>
138 <scalar name="device">
139 <description>Contains the name of a device node</description>
141 <scalar id="vdevmap-target" name="target">
142 <description>Contains the device node of the target node to open instead of the device when <optionref ref="vdevmap-remap">remap</optionref> is set</description>
147 <collection name="vshelper">
148 <link name="logfile">
150 The file where output will be logged to when <tool>vshelper</tool>
151 is invoked from the kernel. This should point somewhere e.g. into
152 <directory>/var/log</directory>.
156 <collection name="vshelper-methods">
157 <program name="handler" type="symbolic">
159 See <optionref ref="vshelper-action">vshelper/action</optionref>.
164 <boolean name="disabled">
166 When existing, the vshelper functionality will be disabled for all
171 <boolean name="debug">
173 When existing, the vshelper execution will be traced.
177 <boolean name="warning-disabled">
179 When existing, sanity checks for the vshelper functionality will be
186 <collection name="vprocunhide">
189 A list of files which will be made visible by vprocunhide. Wildcards are
190 allowed and anything ending in '/' will be processed recursively. When this file exists,
191 it overrides the defaults in SYSDEFAULTDIR/vprocunhide-files. The entries there must be
192 absolute filenames inclusive the leading '/proc'.
197 <collection name="init">
200 A symlink to the TTY device where input/output will be redirected from/to
201 at startup via initscript.
205 <hash id="global-environment" name="environment" since="0.30.211">
207 The environment to set when starting guests. Contains one VAR=VAL
213 <collection name="vunify">
214 <list name="exclude">
215 <description>Static list of excluded files.</description>
218 <collection name="hash" since="0.30.205">
220 A directory which will be used as the storage place for the
221 <tool>vhashify</tool> command.
223 <link name="id" type="symbolic">
225 Points to a directory within the filesystems which are used for the
226 vservers. There must be not more than one of such a directory per
231 <scalar name="method" since="0.30.299">
232 <default>SHA1</default>
233 <description>The used hash method.</description>
237 <boolean name="pkgmgmt-ignore" default="off" since="0.30.205">
239 When existing, information from packagemanagement will not be used to
240 create dynamic exclude-lists.
244 <boolean name="pgkmgmt-force" default="off" since="0.30.205">
246 When existing, information from packagemanagement will be used to
247 create dynamic exclude-lists. This option requires that (a known)
248 packagemanagement is configured for the vserver; else the requested
249 operation will fail. Most tools assume 'on' as the default value.
255 <collection name="vlogin">
256 <boolean id="vlogin-disable" name="disable" since="0.30.212">
258 When this file exists, vlogin isn't used on vserver <guest> enter.
263 <collection name="build">
264 <list name="options">
266 A list of default options to supply to vserver ... build, one option per line.
272 <collection name="interfaces" use="optional">
273 <boolean id="global-vlandev" name="vlandev" since="0.30.211">
275 When this file exists, the steps which setup and destroy a VLAN
276 interface will be executed.
281 <collection name="files">
282 <description>This directory contains some files which will be copied to the guests during build.</description>
284 <description>The default /etc/hosts file.</description>
286 <data name="nsswitch.conf">
287 <description>The default /etc/nsswitch.conf file.</description>
289 <data name="krb5.conf">
290 <description>The default /etc/krb5.conf file.</description>
292 <data name="krb.conf">
293 <description>The default /etc/krb.conf file.</description>
295 <data name="krb.realms">
296 <description>The default /etc/krb.realms file.</description>
298 <data name="ldap.conf">
299 <description>The default /etc/ldap.conf file.</description>
301 <data name="localtime">
302 <description>The default /etc/localtime file.</description>
304 <data name="resolv.conf">
305 <description>The default /etc/resolv.conf file.</description>
309 <collection name="cgroup" use="optional" since="0.30.216" id="global-cgroup">
311 This directory contains cgroup settings which should be applied to all guests.
312 See your kernel documentation for what settings are valid with your
317 The directory to mount the cgroup hierarchy at. The default is /dev/cgroup.
322 List of subsystems to enable on the cgroup mount point. The default is "all".
325 <list name="inherit">
327 Some subsystems start out with clean slates, making it impossible to use the
328 cgroup before certain things have been set. This is true for e.g. the cpuset
329 subsystem. This file contains a list of filenames which should be explicitly
330 inherited from the parent (root) cgroup, if not overridden elsewhere.
331 The default is cpuset.cpus and cpuset.mems.
334 <scalar name="name" id="global-cgroup-name">
336 If this file exists, all guests will be put in one cgroup named after the
337 contents of this file. The default is to put each guest in a cgroup named the
338 same thing as the guest.
343 If this file exists, all cgroups will be created underneath this directory
344 in the cgroup mount point.
347 <boolean name="per-ss">
349 If this file exists, each subsystem will have its own mount point.
355 <collection name=".distributions" use="optional">
356 <collection name="dist" type="symbolic">
358 <description></description>
360 <collection name="yum">
362 The default, yum-related content of the <directory>/etc</directory>
365 <scalar name="yum.conf">
367 The master yum configuration file. It supports the @YUMETCDIR@,
368 @YUMCACHEDIR@ and @YUMLOGDIR@ placeholder which will be replaced at
369 <command>vserver ... build</command> time.
373 <collection name="yum.repos.d">
374 <description>A directory with yum repositories.</description>
376 <data name="apt.conf">
378 The default apt.conf which is going to be used. It overrides the
379 apt.conf from CONFDIR/.defaults/apps/pkgmgmt.
382 <program name="initpre">
384 Script which will be executed before packages will be installed.
387 <parameter name="confdir">
389 The configuration directory of the vserver which is going to be set up.
392 <parameter name="util-vserver-vars">
394 The pathname of the util-vserver-vars file.
399 <program name="initpost">
401 Script which will be executed after packages are installed.
404 <parameter name="confdir">
406 The configuration directory of the vserver which is going to be set up.
409 <parameter name="vserver">
411 The pathname of the util-vserver-vars file.
417 <collection name="pkgs">
419 Contains files with packagenames.
423 File which contains the name of packages. On top of file the special
424 keywords '--reinstall' and '--can-fail' are possible.
429 <collection name="pubkeys">
431 Directory with GPG pubkeys which are used to sign the packages of this
436 <collection name="apt">
438 Default content of the <directory>/etc/apt/</directory> directory.
442 <collection name="rpm">
444 Default content of the <directory>/etc/rpm</directory> directory.
450 Directory which overrides <directory>/usr/lib/rpm</directory>.
453 <link name="execdir">
455 Directory with all executables and libraries which are required for
460 <link name="template">
462 Symlink to the default template for this distribution.
467 <!-- Vserver configuration -->
468 <collection name="vserver-name" type="symbolic">
470 The configuration directory for the vserver vserver-name.
474 <default>../.defaults/cachebase/VSERVERNAME</default>
476 Path of the storage area for cached information about this vserver.
481 <default>../.defaults/vdirbase/VSERVERNAME</default>
483 Path of the vserver root directory.
489 Points to a file which will contain the XID of the running vserver. When
490 the vserver is stopped, this can be a dangling symlink.
494 <list id="bcapabilities" name="bcapabilities">
496 Contains the system capabilities. See
497 <ulink url="http://svn.linux-vserver.org/svn/util-vserver/trunk/lib/bcaps-v13.c">lib/bcaps-v13.c</ulink>
501 <list name="ccapabilities">
503 Contains the context capabilities. See <ulink
504 url="http://svn.linux-vserver.org/svn/util-vserver/trunk/lib/ccaps-v13.c">lib/ccaps-v13.c</ulink>
508 <list name="ncapabilities" since="0.30.212">
510 Contains the network capabilities. See <ulink
511 url="http://svn.linux-vserver.org/svn/util-vserver/trunk/lib/ncaps-net.c">lib/ncaps-net.c</ulink>
515 <list name="umask" since="0.30.216">
517 Contains the namespaces allowed to be unshared. See <ulink
518 url="http://svn.linux-vserver.org/svn/util-vserver/trunk/lib/umask-v23.c">lib/umask-v23.c</ulink>
523 <boolean id="global-namespace" name="namespace">
525 Overrides the global <optionref ref="global-nonamespace">nonamespace</optionref> flag and enables
526 namespace usage for the current vserver.
530 <boolean name="nonamespace">
532 Disables namespace usage for the current vserver.
534 In this mode the <directory>/vservers</directory> directory must have
535 the 'barrier' attribute. Else, common chroot(2) exploits are possible.
539 <boolean id="namespace-cleanup" name="namespace-cleanup">
541 Overrides the global <optionref ref="global-nonamespace-cleanup">nonamespace-cleanup</optionref> flag and enables
542 namespace cleanup for the current vserver.
546 <list name="namespace-cleanup-skip">
548 List of paths to skip during namespace cleanup. This overrides the global
549 <optionref ref="global-namespace-cleanup-skip">namespace-cleanup-skip</optionref>
554 <hash name="schedule">
556 [deprecated; use <optionref ref="sched">sched</optionref> instead] Contains the
557 scheduler parameters, one per line.
559 The Hard CPU limit uses a mechanism called a Token Bucket. the
560 concept is simple: you have a bucket of a certain size which is
561 filled with a specified amount R of tokens each interval T until the
562 maximum is reached (excess tokens are spilled). At each timer tick,
563 a running process consumes one token from the bucket, unless the
564 bucket is empty. If the bucket is empty the process is put in the
565 hold queue. When the bucket has been refilled to at least M tokens,
566 all on hold processes are rescheduled.
568 See the <ulink url="http://linux-vserver.org/Scheduler+Parameters">Linux
569 VServer Wiki</ulink> for more information about this file.
572 <key id="fill_rate" name="fill-rate">
574 Amount of tokens append to the bucket each interval.
577 <key name="interval">
579 The intervall between refills of amount <optionref>fill_rate</optionref>. This
580 value is express in ticks.
585 Initial bucket contents.
588 <key name="tokens-min">
590 The minimum amount of tokens required to unhold processes
593 <key name="tokens-max">
598 <key name="priority-bias">
607 Contains the name of the vserver. When not given, the basename of the directory
608 will be assumed as this name.
613 The nice-level on which the vserver will be started.
616 <list name="capabilities">
618 Contains per line a capability. This file is used for the 2.4 kernel
619 only; for 2.6 use <optionref>bcapabilities</optionref>.
622 <scalar id="shell" name="shell">
624 Contains the pathname of the shell which will be used by the "vserver
628 <list name="personality">
630 Used to set the personality of the vserver. First line in the file
631 is the personality-type followed by flags (one item per line). See
632 <filename>/usr/include/linux/personality.h</filename> for possible
636 <list name="cflags" id="cflags" since="0.30.216">
638 Contains per line a flag. See <ulink
639 url="http://svn.linux-vserver.org/svn/util-vserver/trunk/lib/cflags-v13.c">lib/cflags-v13.c</ulink>
645 Old name for <optionref>cflags</optionref>. Deprecated.
648 <list name="nflags" since="0.30.212">
650 Contains a network flag per line. See <ulink
651 url="http://svn.linux-vserver.org/svn/util-vserver/trunk/lib/nflags-net.c">lib/nflags-net.c</ulink>
655 <scalar name="context">
657 Contains the context id which shall be used for the vserver. Valid range is 2 through 49151.
660 <scalar name="ncontext">
662 Contains the network context id which shall be used for the vserver. Valid range is 2 through 49151.
667 Contains the filesystem tag which shall be used for the vserver. Valid range is 2 through 49151.
670 <data id="fstab" name="fstab">
672 The fstab file for the vserver. Entries in this file will be mounted
673 within the network context of the host. Use the
674 <optionref>fstab.remote</optionref> file when you want that the
675 mounting happens in the network context of the vserver. In most cases
676 the 'fstab' file should be used.
679 <data id="fstab.remote" name="fstab.remote">
681 The fstab file for the vserver. Entries in this file will be mounted
682 within the network context of the guest; this means that mount will be
683 called as <command>chbind <options> mount ...</command>. See
684 <optionref>fstab</optionref> also.
687 <scalar name="badness">
689 Contains the bias to be applied to processes in this guest when the OOM-killer strikes.
693 <collection name="apps">
694 <collection name="init">
697 The initial-mtab which will be used for the vserver.
701 <scalar name="style">
703 Contains the init-style.
706 <enumeration value="sysv"/>
707 <enumeration value="plain"/>
708 <enumeration value="minit"/>
712 <scalar name="runlevel">
713 <description>The start runlevel.</description>
716 <scalar name="runlevel.start">
717 <description>The start runlevel.</description>
720 <scalar name="runlevel.stop">
721 <description>The stop runlevel.</description>
724 <scalar name="killseq">
726 Contains the 'signal [wait signal]*' sequence which is used to stop
731 <list name="cmd.start">
733 The command which is used to start the vserver. Each option must be on
738 <list name="cmd.start-sync">
740 The command which is used to wait on the vserver after it has been
741 started. Each option must be on a separate line. This file will be
742 ignored when the <optionref>sync</optionref> flag does not exist and the
743 '--sync' option was not used.
747 <list name="cmd.stop">
749 The command which is used to stop the vserver. Each option must be on
754 <list name="cmd.stop-sync">
756 The command which is used to wait on the vserver after it has been
757 stopped. Each option must be on a separate line. This file will be
758 ignored when the <optionref>sync</optionref> flag does not exist and the
759 '--sync' option was not used.
763 <list name="cmd.prepare">
765 The command which is used to setup the init-system (e.g. to set the
766 runlevel in the utmp-file). Each option must be on a separate line.
770 <boolean id="sync" name="sync">
772 If this file is not present, all 'cmd.*-sync files will be ignored.
778 A symlink to the TTY device where input/output will be redirected
779 from/to at startup via initscript.
785 This file is used to mark group of vservers which shall be started/stopped
786 together by the initscript. Content is a simple string like 'default'.
790 <list name="depends">
792 This file is used to configure vservers which must be running before
793 the current vserver can be started. At shutdown, the current vserver
794 will be stopped before its dependencies. Content of this file are
795 vserver ids (one name per line).
799 <hash name="environment" since="0.30.211">
801 The environment to set when starting the guest. Contains one VAR=VAL
807 <collection name="vdevmap">
808 <collection name="x" type="sybmolic">
809 <description>'x' is an arbitrary name, replace it with e.g. device names</description>
810 <boolean name="open">
811 <description>When this file exists, the device can be opened</description>
813 <boolean name="create">
814 <description>When this file exists, the device can be created (if the guest has <optionref ref="bcapabilities">CAP_MKNOD</optionref>)</description>
816 <boolean id="guest-vdevmap-remap" name="remap">
818 When this file exists, <optionref ref="guest-vdevmap-target">target</optionref> will
819 have to exist as well and opening the device will in fact open the target device
822 <scalar name="flags">
823 <description>This file will let you specify unimplemented flags manually</description>
825 <scalar name="device">
826 <description>Contains the name of a device node</description>
828 <scalar id="guest-vdevmap-target" name="target">
829 <description>Contains the device node of the target node to open instead of the device when <optionref ref="guest-vdevmap-remap">remap</optionref> is set</description>
834 <collection name="vshelper">
835 <scalar name="sync-timeout">
836 <default>30</default>
838 The timeout in seconds which is used when synchronising vserver
839 startup/shutdown with the vshelper. When not set, 30 seconds will be
844 <scalar id="vshelper-action" name="action">
845 <default>restart</default>
847 The action which is going to be executed when a vshelper event
848 occurs. The default value is 'restart', but there can be defined own
849 methods by placing scripts into the
850 <optionref>vshelper-methods</optionref> directories. These scripts are
851 fed with the same arguments as the <tool>vshelper</tool> script.
855 <program name="event" type="symbolic">
857 When existing, these scripts will be executed *instead* of the default
858 handler defined in 'action'. Their name must match the event which caused
859 the execution of <tool>vshelper</tool>; e.g. 'restart' or 'poweroff'. See
860 the vs_reboot() function in the kernel for more details.
863 <parameter name="xid">
865 The xid of the context calling the vshelper
868 <parameter name="event">
876 <boolean name="disabled">
878 When existing, the vshelper functionality will be disabled for this
883 <boolean name="debug">
885 When existing, the vshelper execution will be traced for this vserver.
889 <boolean name="warning-disabled">
891 When existing, sanity checks for the vshelper functionality will be
898 <collection id="vshelper-methods" name="vshelper-methods">
899 <program name="handler" type="symbolic">
901 See <optionref ref="vshelper-action">vshelper/action</optionref>.
906 <collection name="vunify">
908 This directory contains configuration data required for vserver
912 <list name="exclude">
914 <p>Static list of files which are excluded for unification. This list
915 supports an rsync-like syntax: when a file is prefixed by '+', it is a
916 candidate for unification; when there is no prefix or a '-' or a '~' it
917 will be excluded. Shell-wildcards are allowed for the filenames.</p>
918 <p>When used with <tool>vcopy</tool>, the '~' prefix prevents copying
919 of the file entirely (e.g. for keyfiles). With this tool, the file will
920 be copied instead of hardlinked when the '-' prefix is used.</p>
924 <link name="refserver.X" type="symbolic">
926 These are symlinks to the configuration directory
927 (e.g. CONFDIR/vservers/<id>) of a refserver. There may be
928 multiple such symlinks but they must be prefixed by 'refserver.' and
929 will be processed in alphanumerical order.
933 <collection name="hash" since="0.30.205">
935 A directory which will be used as the storage place for the
936 <tool>vhashify</tool> command.
938 <link name="id" type="symbolic">
940 Points to a directory within the filesystems which are used for the
941 vservers. There must be not more than one of such a directory per
946 <scalar name="method" since="0.30.299">
947 <default>SHA1</default>
948 <description>The used hash method.</description>
952 <boolean name="pkgmgmt-ignore" default="off" since="0.30.205">
954 When existing, information from packagemanagement will not be used to
955 create dynamic exclude-lists.
959 <boolean name="pgkmgmt-force" default="off" since="0.30.205">
961 When existing, information from packagemanagement will be used to
962 create dynamic exclude-lists. This option requires that (a known)
963 packagemanagement is configured for the vserver; else the requested
964 operation will fail. Most tools assume 'on' as the default value.
971 <collection name="scripts">
973 A directory for scripts. By default, when one of these scripts will be
974 executed, the execution of defaultscripts (within .../.defaults/scripts)
975 will be skipped. To execute them nevertheless, the $DONT_SKIP_DEFAULTS
976 environment variable must be set by one of the in-shellcontext scripts
977 (the non-executable ones).
980 <program name="initialize" since="0.30.211">
982 The scriptlet which will be executed before the root filesystem is mounted and
983 the configuration has been loaded. Before executing the script, the
984 configuration directory will be made the working directory.
987 <parameter name="action">
989 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
992 <parameter name="vserver-name">
994 The name of the current vserver.
999 <collection name="initialize.d" since="0.30.211">
1001 Repository of initialize like scripts. Before executing the script,
1002 the configuration directory will be made the working directory.
1004 <program name="script" type="symbolic">
1005 <description>See initialize.</description>
1007 <parameter name="action">
1009 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1012 <parameter name="vserver-name">
1014 The name of the current vserver.
1021 <program name="prepre-start">
1023 The scriptlet which will be executed before the network-interfaces are
1024 enabled and the directories are mounted. Before executing the script,
1025 the configuration directory will be made the working directory.
1028 <parameter name="action">
1030 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1033 <parameter name="vserver-name">
1035 The name of the current vserver.
1040 <collection name="prepre-start.d">
1042 Repository of prepre-start like scripts. Before executing the script,
1043 the configuration directory will be made the working directory.
1045 <program name="script" type="symbolic">
1046 <description>See prepre-start.</description>
1048 <parameter name="action">
1050 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1053 <parameter name="vserver-name">
1055 The name of the current vserver.
1062 <program name="pre-start">
1064 The scriptlet which will be executed after network-interfaces were
1065 enabled and the directories mounted, but before the vserver itself has
1066 been started. Before executing the script, the vserver root directory
1067 will be made the working directory.
1070 <parameter name="action">
1072 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1075 <parameter name="vserver-name">
1077 The name of the current vserver.
1082 <collection name="pre-start.d">
1084 Repository of pre-start like scripts. Before executing these scripts,
1085 the vserver root directory will be made the working directory.
1087 <program name="script" type="symbolic">
1088 <description>See pre-start.</description>
1090 <parameter name="action">
1092 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1095 <parameter name="vserver-name">
1097 The name of the current vserver.
1105 <program name="post-start">
1107 The scriptlet which will be executed after the vserver has been
1108 started. Before executing the script, the vserver root directory
1109 will be made the working directory.
1112 <parameter name="action">
1114 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1117 <parameter name="vserver-name">
1119 The name of the current vserver.
1124 <collection name="post-start.d">
1126 Repository of post-start like scripts. Before executing these scripts,
1127 the vserver root directory will be made the working directory.
1129 <program name="script" type="symbolic">
1130 <description>See post-start.</description>
1132 <parameter name="action">
1134 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1137 <parameter name="vserver-name">
1139 The name of the current vserver.
1147 <program name="pre-stop">
1149 The scriptlet which will be executed before the vserver will be
1150 stopped. Before executing the script, the vserver root directory
1151 will be made the working directory.
1154 <parameter name="action">
1156 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1159 <parameter name="vserver-name">
1161 The name of the current vserver.
1166 <collection name="pre-stop.d">
1168 Repository of pre-stop like scripts. Before executing the script, the
1169 vserver root directory will be made the working directory.
1171 <program name="script" type="symbolic">
1172 <description>See pre-stop.</description>
1174 <parameter name="action">
1176 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1179 <parameter name="vserver-name">
1181 The name of the current vserver.
1188 <program name="post-stop">
1190 The scriptlet which will be executed after the vserver has been
1191 stopped, but before the directories will be umounted and the the
1192 interfaces disabled. Before executing the script, the vserver root
1193 directory will be made the working directory.
1196 <parameter name="action">
1198 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1201 <parameter name="vserver-name">
1203 The name of the current vserver.
1208 <collection name="post-stop.d">
1210 Repository of post-stop like scripts. Before executing the script, the
1211 vserver root directory will be made the working directory.
1213 <program name="script" type="symbolic">
1214 <description>See post-stop.</description>
1216 <parameter name="action">
1218 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1221 <parameter name="vserver-name">
1223 The name of the current vserver.
1230 <program name="postpost-stop">
1232 The scriptlet which will be executed after the vserver has been stopped
1233 completely. Before executing the script, the vserver root directory
1234 will be made the working directory.
1237 <parameter name="action">
1239 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1242 <parameter name="vserver-name">
1244 The name of the current vserver.
1249 <collection name="postpost-stop.d">
1251 Repository of postpost-stop like scripts. Before executing the script,
1252 the vserver root directory will be made the working directory.
1254 <program name="script" type="symbolic">
1255 <description>See postpost-stop.</description>
1257 <parameter name="action">
1259 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1262 <parameter name="vserver-name">
1264 The name of the current vserver.
1272 <collection name="interfaces">
1273 <scalar name="bcast">
1274 <description>The guest's broadcast address.</description>
1276 <scalar name="lback">
1277 <description>The guest's loopback address.</description>
1280 <description>The default network device. See <optionref ref="per-if-dev">iface/dev</optionref> for more information.</description>
1282 <scalar name="prefix">
1283 <description>The default network prefix-length.</description>
1285 <scalar name="mask">
1286 <description>The default network mask.</description>
1288 <scalar name="scope">
1289 <description>The default scope of the network interfaces.</description>
1291 <boolean id="local-vlandev" name="vlandev" since="0.30.211">
1293 When this file exists, the steps which setup and destroy a VLAN
1294 interface will be executed for all interfaces of this vserver.
1297 <boolean id="local-novlandev" name="novlandev">
1299 When this file exists, the steps which setup and destroy a VLAN
1300 interface will be skipped. This overrides the global
1301 <optionref ref="global-vlandev">vlandev</optionref> setting for
1306 <collection name="iface" type="symbolic">
1308 'iface' is an arbitrary name for the interface; the value itself is
1309 not important but may be interesting regarding interface-creation and
1310 usage with <tool>chbind</tool>. Both happens in alphabetical order and
1311 numbers like '00' are good names for these directories.
1314 <boolean name="disabled">
1315 <description>When this file exists, this interface will be ignored.</description>
1319 <description>The IP address which will be assigned to this interface.</description>
1321 <scalar name="dev" id="per-if-dev">
1322 <description>The network device. When this is specified, the IP address will be assigned and removed when starting and stopping the guest.</description>
1324 <scalar name="prefix">
1325 <description>The network prefix-length.</description>
1327 <scalar name="mask">
1328 <description>The network mask.</description>
1330 <scalar name="scope">
1331 <description>The scope of the network interface.</description>
1333 <scalar name="name">
1335 When this file exists, the interface will be named with the text in
1336 this file. Without such an entry, the IP will not be shown by
1337 <tool>ifconfig</tool> but by <command>ip addr ls</command> only. Such
1338 a labeled interface is known as an "alias" also (e.g. 'eth0:foo').
1341 <boolean name="nodev">
1343 When this file exists, the interface will be assumed to exist
1344 already. This can be used to assign primary interfaces which are
1345 created by the host or another vserver.
1348 <boolean name="novlandev">
1350 When this file exists, the steps which setup and destroy a VLAN
1351 interface will be skipped. This will override the global
1352 <optionref ref="global-vlandev">vlandev</optionref> and the per-guest
1353 <optionref ref="local-vlandev">vlandev</optionref>.
1356 <boolean name="vlandev" since="0.30.211">
1358 When this file exists, the steps which setup and destroy a VLAN
1359 interface will be executed.
1362 <boolean name="tun" since="0.30.215">
1364 When this file exists, a tun interface will be created when the guest
1365 starts, and removed when the guest stops.
1368 <boolean name="tap" since="0.30.215">
1370 When this file exists, a tap interface will be created when the guest
1371 starts, and removed when the guest stops.
1374 <boolean name="nocsum" since="0.30.215">
1376 If a tun or tap interface is created, the presence of this file will
1377 disable checksumming on it.
1380 <boolean name="shared" since="0.30.215">
1382 When this file exists, the tun/tap interface created will not be
1383 owned by this particular guest.
1386 <scalar name="uid" since="0.30.215">
1388 Sets the ownership of tun/tap interfaces. Requires a user id, not a
1392 <scalar name="gid" since="0.30.215">
1394 Sets the group ownership of tun/tap interfaces. Requires a group id,
1398 <scalar name="linktype" since="0.30.215">
1400 Sets the link type of tun/tap interfaces.
1403 <scalar name="peer" since="0.30.216">
1405 Sets the peer for a point-to-point link, such as a tun interface.
1411 <collection name="ulimits">
1413 A directory with ulimits. Possible resources are cpu, data, fsize,
1414 locks, memlock, nofile, nproc, rss and/or stack.
1416 <scalar name="resource" type="symbolic">
1418 A file which contains the hard- and soft-limit of the given resource
1419 in the first line. The special keyword 'inf' is recognized.
1422 <scalar name="resource.hard" type="symbolic">
1424 A file which contains the hard-limit of the given resource in the first
1425 line. The special keyword 'inf' is recognized.
1428 <scalar name="resource.soft" type="symbolic">
1430 A file which contains the soft-limit of the given resource in the first
1431 line. The special keyword 'inf' is recognized.
1436 <collection name="rlimits">
1438 A directory with resource limits. Possible resources are cpu, fsize,
1439 data, stack, core, rss, nproc, nofile, memlock, as, locks, msgqueue,
1440 nsock, openfd, anon, shmem, semary, nsems and dentry. This
1441 configuration will be honored for kernel 2.6 only.
1443 <scalar name="resource" type="symbolic">
1445 A file which contains the hard- and soft-limit of the given resource
1446 in the first line. The special keyword 'inf' is recognized.
1449 <scalar name="resource.hard" type="symbolic">
1451 A file which contains the hard-limit of the given resource in the first
1452 line. The special keyword 'inf' is recognized.
1455 <scalar name="resource.soft" type="symbolic">
1457 A file which contains the soft-limit of the given resource in the first
1458 line. The special keyword 'inf' is recognized.
1461 <scalar name="resource.min" type="symbolic">
1463 A file which contains the guaranteed minimum of the given resource in
1464 the first line. The special keyword 'inf' is recognized.
1469 <collection name="uts">
1470 <scalar name="context">
1472 The context-name of the vserver. This file is listed for completeness
1473 only; the 'context' name is used and set internally by the util-vserver
1474 tools and can *not* be modified.
1477 <scalar name="sysname">
1478 <description>The sysname of the vserver</description>
1480 <scalar name="nodename">
1481 <description>The node-/hostname of the vserver</description>
1483 <scalar name="release">
1484 <description>The OS-release of the vserver</description>
1486 <scalar name="version">
1487 <description>The OS-version of the vserver</description>
1489 <scalar name="machine">
1490 <description>The machine-type of the vserver</description>
1492 <scalar name="domainname">
1493 <description>The NIS domainname of the vserver</description>
1497 <collection name="dlimits" since="0.30.210">
1499 Note that all entries are required for the disk limit to be applied.
1501 <collection name="x" type="symbolic">
1502 <description>'x' is an arbitrary name, replace it with e.g. integers</description>
1503 <scalar name="directory">
1504 <description>The directory to which the limit should be applied</description>
1506 <scalar name="inodes_total">
1507 <description>The amount of inodes this vserver should be limited to</description>
1509 <scalar name="space_total">
1510 <description>The amount of space this vserver should be limited to (measured in blocks of 1024 bytes)</description>
1512 <scalar name="reserved">
1513 <description>How much space (percentage-wise) should be reserved for the root user</description>
1518 <collection name="sysctl" since="0.30.213">
1519 <collection name="x" type="symbolic">
1520 <description>'x' is an arbitrary name, replace it with e.g. integers</description>
1521 <scalar name="setting">
1522 <description>The sysctl setting</description>
1524 <scalar name="value">
1525 <description>The value</description>
1530 <collection name="cpuset" since="0.30.211">
1532 Puts the guest in a cpuset. Required entries are name, cpus and mems.
1534 <scalar name="name">
1535 <description>The name of the cpuset for this vserver</description>
1537 <scalar name="cpus">
1538 <description>The list of CPUs in this cpuset</description>
1540 <scalar name="mems">
1541 <description>The list of Memory Nodes in this cpuset</description>
1543 <scalar name="cpu_exclusive">
1544 <description>Is the CPU assignment exclusive?</description>
1546 <scalar name="mems_exclusive">
1547 <description>Is the memory node assignment exclusive?</description>
1549 <scalar name="nocreate">
1550 <description>When this file exists, the cpuset will be assumed to exist already</description>
1554 <collection id="sched" name="sched" since="0.30.212">
1555 <scalar id="global-tokens" name="tokens">
1556 <description>The initial amount of tokens to put in the bucket</description>
1558 <scalar id="global-tokens-min" name="tokens-min">
1559 <description>The minimum amount of tokens required to unhold the context</description>
1561 <scalar id="global-tokens-max" name="tokens-max">
1562 <description>The bucket's size</description>
1564 <scalar id="global-fill-rate" name="fill-rate">
1565 <description>Amount of tokens to add each <optionref ref="global-interval">interval</optionref></description>
1567 <scalar id="global-interval" name="interval">
1568 <description>The interval between refills of the bucket</description>
1570 <scalar id="global-priority-bias" name="priority-bias">
1571 <description>Bias added to priorities calculated within the guest (result is clamped to -20/+19)</description>
1573 <scalar id="global-fill-rate2" name="fill-rate2">
1574 <description>Amount of tokens to add each <optionref ref="global-interval2">interval2</optionref> when advancing idle time</description>
1576 <scalar id="global-interval2" name="interval2">
1577 <description>The interval between refills of the bucket when advancing idle time</description>
1579 <boolean id="global-idle-time" name="idle-time">
1580 <description>When this file exists, advancing idle time is activated</description>
1582 <collection name="cpu-id" type="symbolic">
1583 <description>This directory contains per-CPU and/or per-bucket specific settings. Remember to set the <optionref ref="cpu-id">cpu-id</optionref> file. All CPUs inherit the global settings.</description>
1584 <scalar name="tokens">
1585 <description>The initial amount of tokens to put in the bucket</description>
1587 <scalar name="tokens-min">
1588 <description>The minimum amount of tokens required to unhold the context</description>
1590 <scalar name="tokens-max">
1591 <description>The bucket's size</description>
1593 <scalar name="fill-rate">
1594 <description>Amount of tokens to add each <optionref ref="local-interval">interval</optionref></description>
1596 <scalar id="local-interval" name="interval">
1597 <description>The interval between refills of the bucket</description>
1599 <scalar name="priority-bias">
1600 <description>Bias added to priorities calculated within the guest (result is clamped to -20/+19)</description>
1602 <scalar name="fill-rate2">
1603 <description>Amount of tokens to add each <optionref ref="local-interval2">interval2</optionref> when advancing idle time</description>
1605 <scalar id="local-interval2" name="interval2">
1606 <description>The interval between refills of the bucket when advancing idle time</description>
1608 <boolean name="idle-time">
1609 <description>When this file exists, advancing idle time is activated</description>
1611 <scalar id="cpu-id" name="cpu-id">
1612 <description>The CPU to apply these settings to</description>
1614 <scalar name="bucket-id">
1615 <description>The bucket to apply these settings to</description>
1620 <collection name="spaces" since="0.30.215">
1621 <boolean name="pid">
1622 <description>Enables pid virtualization for this guest</description>
1624 <boolean name="net">
1625 <description>Enable network virtualization for this guest</description>
1627 <scalar name="mask">
1628 <description>Contains a mask of spaces to clone/enter</description>
1632 <collection name="ionice" since="0.30.216">
1633 <scalar name="class">
1634 <description>The IO scheduling class to use for this guest (see ionice(1)).</description>
1636 <scalar name="priority">
1637 <description>The IO scheduling priority to use for this guest (see ionice(1)).</description>
1641 <collection name="cgroup" use="optional" since="0.30.216" id="guest-cgroup">
1643 This directory contains cgroup settings to be applied to this guest.
1644 See your kernel documentation for what settings are valid with your
1647 <scalar name="name">
1649 If this file exists, the guest will be put in a cgroup named after the
1650 contents of this file. The default is to name the cgroup the same thing as the
1652 <optionref ref="global-cgroup-name">.defaults/cgroup/name</optionref> says
1657 <scalar name="nocgroup" since="0.30.216">
1659 If this file exists,
1660 <optionref ref="global-cgroup">.defaults/cgroup</optionref> will be ignored