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.
320 <scalar name="subsys">
322 Comma-separated list of subsystems to enable on the cgroup mount point.
323 The default is "all".
326 <list name="inherit">
328 Some subsystems start out with clean slates, making it impossible to use the
329 cgroup before certain things have been set. This is true for e.g. the cpuset
330 subsystem. This file contains a list of filenames which should be explicitly
331 inherited from the parent (root) cgroup, if not overridden elsewhere.
332 The default is cpuset.cpus and cpuset.mems.
335 <scalar name="name" id="global-cgroup-name">
337 If this file exists, all guests will be put in one cgroup named after the
338 contents of this file. The default is to put each guest in a cgroup named the
339 same thing as the guest.
345 <collection name=".distributions" use="optional">
346 <collection name="dist" type="symbolic">
348 <description></description>
350 <collection name="yum">
352 The default, yum-related content of the <directory>/etc</directory>
355 <scalar name="yum.conf">
357 The master yum configuration file. It supports the @YUMETCDIR@,
358 @YUMCACHEDIR@ and @YUMLOGDIR@ placeholder which will be replaced at
359 <command>vserver ... build</command> time.
363 <collection name="yum.repos.d">
364 <description>A directory with yum repositories.</description>
366 <data name="apt.conf">
368 The default apt.conf which is going to be used. It overrides the
369 apt.conf from CONFDIR/.defaults/apps/pkgmgmt.
372 <program name="initpre">
374 Script which will be executed before packages will be installed.
377 <parameter name="confdir">
379 The configuration directory of the vserver which is going to be set up.
382 <parameter name="util-vserver-vars">
384 The pathname of the util-vserver-vars file.
389 <program name="initpost">
391 Script which will be executed after packages are installed.
394 <parameter name="confdir">
396 The configuration directory of the vserver which is going to be set up.
399 <parameter name="vserver">
401 The pathname of the util-vserver-vars file.
407 <collection name="pkgs">
409 Contains files with packagenames.
413 File which contains the name of packages. On top of file the special
414 keywords '--reinstall' and '--can-fail' are possible.
419 <collection name="pubkeys">
421 Directory with GPG pubkeys which are used to sign the packages of this
426 <collection name="apt">
428 Default content of the <directory>/etc/apt/</directory> directory.
432 <collection name="rpm">
434 Default content of the <directory>/etc/rpm</directory> directory.
440 Directory which overrides <directory>/usr/lib/rpm</directory>.
443 <link name="execdir">
445 Directory with all executables and libraries which are required for
450 <link name="template">
452 Symlink to the default template for this distribution.
457 <!-- Vserver configuration -->
458 <collection name="vserver-name" type="symbolic">
460 The configuration directory for the vserver vserver-name.
464 <default>../.defaults/cachebase/VSERVERNAME</default>
466 Path of the storage area for cached information about this vserver.
471 <default>../.defaults/vdirbase/VSERVERNAME</default>
473 Path of the vserver root directory.
479 Points to a file which will contain the XID of the running vserver. When
480 the vserver is stopped, this can be a dangling symlink.
484 <list id="bcapabilities" name="bcapabilities">
486 Contains the system capabilities. See
487 <ulink url="http://svn.linux-vserver.org/svn/util-vserver/trunk/lib/bcaps-v13.c">lib/bcaps-v13.c</ulink>
491 <list name="ccapabilities">
493 Contains the context capabilities. See <ulink
494 url="http://svn.linux-vserver.org/svn/util-vserver/trunk/lib/ccaps-v13.c">lib/ccaps-v13.c</ulink>
498 <list name="ncapabilities" since="0.30.212">
500 Contains the network capabilities. See <ulink
501 url="http://svn.linux-vserver.org/svn/util-vserver/trunk/lib/ncaps-net.c">lib/ncaps-net.c</ulink>
506 <boolean id="global-namespace" name="namespace">
508 Overrides the global <optionref ref="global-nonamespace">nonamespace</optionref> flag and enables
509 namespace usage for the current vserver.
513 <boolean name="nonamespace">
515 Disables namespace usage for the current vserver.
517 In this mode the <directory>/vservers</directory> directory must have
518 the 'barrier' attribute. Else, common chroot(2) exploits are possible.
522 <boolean id="namespace-cleanup" name="namespace-cleanup">
524 Overrides the global <optionref ref="global-nonamespace-cleanup">nonamespace-cleanup</optionref> flag and enables
525 namespace cleanup for the current vserver.
529 <list name="namespace-cleanup-skip">
531 List of paths to skip during namespace cleanup. This overrides the global
532 <optionref ref="global-namespace-cleanup-skip">namespace-cleanup-skip</optionref>
537 <hash name="schedule">
539 [deprecated; use <optionref ref="sched">sched</optionref> instead] Contains the
540 scheduler parameters, one per line.
542 The Hard CPU limit uses a mechanism called a Token Bucket. the
543 concept is simple: you have a bucket of a certain size which is
544 filled with a specified amount R of tokens each interval T until the
545 maximum is reached (excess tokens are spilled). At each timer tick,
546 a running process consumes one token from the bucket, unless the
547 bucket is empty. If the bucket is empty the process is put in the
548 hold queue. When the bucket has been refilled to at least M tokens,
549 all on hold processes are rescheduled.
551 See the <ulink url="http://linux-vserver.org/Scheduler+Parameters">Linux
552 VServer Wiki</ulink> for more information about this file.
555 <key id="fill_rate" name="fill-rate">
557 Amount of tokens append to the bucket each interval.
560 <key name="interval">
562 The intervall between refills of amount <optionref>fill_rate</optionref>. This
563 value is express in ticks.
568 Initial bucket contents.
571 <key name="tokens-min">
573 The minimum amount of tokens required to unhold processes
576 <key name="tokens-max">
581 <key name="priority-bias">
590 Contains the name of the vserver. When not given, the basename of the directory
591 will be assumed as this name.
596 The nice-level on which the vserver will be started.
599 <list name="capabilities">
601 Contains per line a capability. This file is used for the 2.4 kernel
602 only; for 2.6 use <optionref>bcapabilities</optionref>.
605 <scalar id="shell" name="shell">
607 Contains the pathname of the shell which will be used by the "vserver
611 <list name="personality">
613 Used to set the personality of the vserver. First line in the file
614 is the personality-type followed by flags (one item per line). See
615 <filename>/usr/include/linux/personality.h</filename> for possible
619 <list name="cflags" id="cflags" since="0.30.216">
621 Contains per line a flag. See <ulink
622 url="http://svn.linux-vserver.org/svn/util-vserver/trunk/lib/cflags-v13.c">lib/cflags-v13.c</ulink>
628 Old name for <optionref>cflags</optionref>. Deprecated.
631 <list name="nflags" since="0.30.212">
633 Contains a network flag per line. See <ulink
634 url="http://svn.linux-vserver.org/svn/util-vserver/trunk/lib/nflags-net.c">lib/nflags-net.c</ulink>
638 <scalar name="context">
640 Contains the context id which shall be used for the vserver. Valid range is 2 through 49151.
643 <scalar name="ncontext">
645 Contains the network context id which shall be used for the vserver. Valid range is 2 through 49151.
650 Contains the filesystem tag which shall be used for the vserver. Valid range is 2 through 49151.
653 <data id="fstab" name="fstab">
655 The fstab file for the vserver. Entries in this file will be mounted
656 within the network context of the host. Use the
657 <optionref>fstab.remote</optionref> file when you want that the
658 mounting happens in the network context of the vserver. In most cases
659 the 'fstab' file should be used.
662 <data id="fstab.remote" name="fstab.remote">
664 The fstab file for the vserver. Entries in this file will be mounted
665 within the network context of the guest; this means that mount will be
666 called as <command>chbind <options> mount ...</command>. See
667 <optionref>fstab</optionref> also.
670 <scalar name="badness">
672 Contains the bias to be applied to processes in this guest when the OOM-killer strikes.
676 <collection name="apps">
677 <collection name="init">
680 The initial-mtab which will be used for the vserver.
684 <scalar name="style">
686 Contains the init-style.
689 <enumeration value="sysv"/>
690 <enumeration value="plain"/>
691 <enumeration value="minit"/>
695 <scalar name="runlevel">
696 <description>The start runlevel.</description>
699 <scalar name="runlevel.start">
700 <description>The start runlevel.</description>
703 <scalar name="runlevel.stop">
704 <description>The stop runlevel.</description>
707 <scalar name="killseq">
709 Contains the 'signal [wait signal]*' sequence which is used to stop
714 <list name="cmd.start">
716 The command which is used to start the vserver. Each option must be on
721 <list name="cmd.start-sync">
723 The command which is used to wait on the vserver after it has been
724 started. Each option must be on a separate line. This file will be
725 ignored when the <optionref>sync</optionref> flag does not exist and the
726 '--sync' option was not used.
730 <list name="cmd.stop">
732 The command which is used to stop the vserver. Each option must be on
737 <list name="cmd.stop-sync">
739 The command which is used to wait on the vserver after it has been
740 stopped. Each option must be on a separate line. This file will be
741 ignored when the <optionref>sync</optionref> flag does not exist and the
742 '--sync' option was not used.
746 <list name="cmd.prepare">
748 The command which is used to setup the init-system (e.g. to set the
749 runlevel in the utmp-file). Each option must be on a separate line.
753 <boolean id="sync" name="sync">
755 If this file is not present, all 'cmd.*-sync files will be ignored.
761 A symlink to the TTY device where input/output will be redirected
762 from/to at startup via initscript.
768 This file is used to mark group of vservers which shall be started/stopped
769 together by the initscript. Content is a simple string like 'default'.
773 <list name="depends">
775 This file is used to configure vservers which must be running before
776 the current vserver can be started. At shutdown, the current vserver
777 will be stopped before its dependencies. Content of this file are
778 vserver ids (one name per line).
782 <hash name="environment" since="0.30.211">
784 The environment to set when starting the guest. Contains one VAR=VAL
790 <collection name="vdevmap">
791 <collection name="x" type="sybmolic">
792 <description>'x' is an arbitrary name, replace it with e.g. device names</description>
793 <boolean name="open">
794 <description>When this file exists, the device can be opened</description>
796 <boolean name="create">
797 <description>When this file exists, the device can be created (if the guest has <optionref ref="bcapabilities">CAP_MKNOD</optionref>)</description>
799 <boolean id="guest-vdevmap-remap" name="remap">
801 When this file exists, <optionref ref="guest-vdevmap-target">target</optionref> will
802 have to exist as well and opening the device will in fact open the target device
805 <scalar name="flags">
806 <description>This file will let you specify unimplemented flags manually</description>
808 <scalar name="device">
809 <description>Contains the name of a device node</description>
811 <scalar id="guest-vdevmap-target" name="target">
812 <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>
817 <collection name="vshelper">
818 <scalar name="sync-timeout">
819 <default>30</default>
821 The timeout in seconds which is used when synchronising vserver
822 startup/shutdown with the vshelper. When not set, 30 seconds will be
827 <scalar id="vshelper-action" name="action">
828 <default>restart</default>
830 The action which is going to be executed when a vshelper event
831 occurs. The default value is 'restart', but there can be defined own
832 methods by placing scripts into the
833 <optionref>vshelper-methods</optionref> directories. These scripts are
834 fed with the same arguments as the <tool>vshelper</tool> script.
838 <program name="event" type="symbolic">
840 When existing, these scripts will be executed *instead* of the default
841 handler defined in 'action'. Their name must match the event which caused
842 the execution of <tool>vshelper</tool>; e.g. 'restart' or 'poweroff'. See
843 the vs_reboot() function in the kernel for more details.
846 <parameter name="xid">
848 The xid of the context calling the vshelper
851 <parameter name="event">
859 <boolean name="disabled">
861 When existing, the vshelper functionality will be disabled for this
866 <boolean name="debug">
868 When existing, the vshelper execution will be traced for this vserver.
872 <boolean name="warning-disabled">
874 When existing, sanity checks for the vshelper functionality will be
881 <collection id="vshelper-methods" name="vshelper-methods">
882 <program name="handler" type="symbolic">
884 See <optionref ref="vshelper-action">vshelper/action</optionref>.
889 <collection name="vunify">
891 This directory contains configuration data required for vserver
895 <list name="exclude">
897 <p>Static list of files which are excluded for unification. This list
898 supports an rsync-like syntax: when a file is prefixed by '+', it is a
899 candidate for unification; when there is no prefix or a '-' or a '~' it
900 will be excluded. Shell-wildcards are allowed for the filenames.</p>
901 <p>When used with <tool>vcopy</tool>, the '~' prefix prevents copying
902 of the file entirely (e.g. for keyfiles). With this tool, the file will
903 be copied instead of hardlinked when the '-' prefix is used.</p>
907 <link name="refserver.X" type="symbolic">
909 These are symlinks to the configuration directory
910 (e.g. CONFDIR/vservers/<id>) of a refserver. There may be
911 multiple such symlinks but they must be prefixed by 'refserver.' and
912 will be processed in alphanumerical order.
916 <collection name="hash" since="0.30.205">
918 A directory which will be used as the storage place for the
919 <tool>vhashify</tool> command.
921 <link name="id" type="symbolic">
923 Points to a directory within the filesystems which are used for the
924 vservers. There must be not more than one of such a directory per
929 <scalar name="method" since="0.30.299">
930 <default>SHA1</default>
931 <description>The used hash method.</description>
935 <boolean name="pkgmgmt-ignore" default="off" since="0.30.205">
937 When existing, information from packagemanagement will not be used to
938 create dynamic exclude-lists.
942 <boolean name="pgkmgmt-force" default="off" since="0.30.205">
944 When existing, information from packagemanagement will be used to
945 create dynamic exclude-lists. This option requires that (a known)
946 packagemanagement is configured for the vserver; else the requested
947 operation will fail. Most tools assume 'on' as the default value.
954 <collection name="scripts">
956 A directory for scripts. By default, when one of these scripts will be
957 executed, the execution of defaultscripts (within .../.defaults/scripts)
958 will be skipped. To execute them nevertheless, the $DONT_SKIP_DEFAULTS
959 environment variable must be set by one of the in-shellcontext scripts
960 (the non-executable ones).
963 <program name="initialize" since="0.30.211">
965 The scriptlet which will be executed before the root filesystem is mounted and
966 the configuration has been loaded. Before executing the script, the
967 configuration directory will be made the working directory.
970 <parameter name="action">
972 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
975 <parameter name="vserver-name">
977 The name of the current vserver.
982 <collection name="initialize.d" since="0.30.211">
984 Repository of initialize like scripts. Before executing the script,
985 the configuration directory will be made the working directory.
987 <program name="script" type="symbolic">
988 <description>See initialize.</description>
990 <parameter name="action">
992 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
995 <parameter name="vserver-name">
997 The name of the current vserver.
1004 <program name="prepre-start">
1006 The scriptlet which will be executed before the network-interfaces are
1007 enabled and the directories are mounted. Before executing the script,
1008 the configuration directory will be made the working directory.
1011 <parameter name="action">
1013 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1016 <parameter name="vserver-name">
1018 The name of the current vserver.
1023 <collection name="prepre-start.d">
1025 Repository of prepre-start like scripts. Before executing the script,
1026 the configuration directory will be made the working directory.
1028 <program name="script" type="symbolic">
1029 <description>See prepre-start.</description>
1031 <parameter name="action">
1033 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1036 <parameter name="vserver-name">
1038 The name of the current vserver.
1045 <program name="pre-start">
1047 The scriptlet which will be executed after network-interfaces were
1048 enabled and the directories mounted, but before the vserver itself has
1049 been started. Before executing the script, the vserver root directory
1050 will be made the working directory.
1053 <parameter name="action">
1055 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1058 <parameter name="vserver-name">
1060 The name of the current vserver.
1065 <collection name="pre-start.d">
1067 Repository of pre-start like scripts. Before executing these scripts,
1068 the vserver root directory will be made the working directory.
1070 <program name="script" type="symbolic">
1071 <description>See pre-start.</description>
1073 <parameter name="action">
1075 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1078 <parameter name="vserver-name">
1080 The name of the current vserver.
1088 <program name="post-start">
1090 The scriptlet which will be executed after the vserver has been
1091 started. Before executing the script, the vserver root directory
1092 will be made the working directory.
1095 <parameter name="action">
1097 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1100 <parameter name="vserver-name">
1102 The name of the current vserver.
1107 <collection name="post-start.d">
1109 Repository of post-start like scripts. Before executing these scripts,
1110 the vserver root directory will be made the working directory.
1112 <program name="script" type="symbolic">
1113 <description>See post-start.</description>
1115 <parameter name="action">
1117 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1120 <parameter name="vserver-name">
1122 The name of the current vserver.
1130 <program name="pre-stop">
1132 The scriptlet which will be executed before the vserver will be
1133 stopped. Before executing the script, the vserver root directory
1134 will be made the working directory.
1137 <parameter name="action">
1139 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1142 <parameter name="vserver-name">
1144 The name of the current vserver.
1149 <collection name="pre-stop.d">
1151 Repository of pre-stop like scripts. Before executing the script, the
1152 vserver root directory will be made the working directory.
1154 <program name="script" type="symbolic">
1155 <description>See pre-stop.</description>
1157 <parameter name="action">
1159 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1162 <parameter name="vserver-name">
1164 The name of the current vserver.
1171 <program name="post-stop">
1173 The scriptlet which will be executed after the vserver has been
1174 stopped, but before the directories will be umounted and the the
1175 interfaces disabled. Before executing the script, the vserver root
1176 directory will be made the working directory.
1179 <parameter name="action">
1181 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1184 <parameter name="vserver-name">
1186 The name of the current vserver.
1191 <collection name="post-stop.d">
1193 Repository of post-stop like scripts. Before executing the script, the
1194 vserver root directory will be made the working directory.
1196 <program name="script" type="symbolic">
1197 <description>See post-stop.</description>
1199 <parameter name="action">
1201 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1204 <parameter name="vserver-name">
1206 The name of the current vserver.
1213 <program name="postpost-stop">
1215 The scriptlet which will be executed after the vserver has been stopped
1216 completely. Before executing the script, the vserver root directory
1217 will be made the working directory.
1220 <parameter name="action">
1222 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1225 <parameter name="vserver-name">
1227 The name of the current vserver.
1232 <collection name="postpost-stop.d">
1234 Repository of postpost-stop like scripts. Before executing the script,
1235 the vserver root directory will be made the working directory.
1237 <program name="script" type="symbolic">
1238 <description>See postpost-stop.</description>
1240 <parameter name="action">
1242 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1245 <parameter name="vserver-name">
1247 The name of the current vserver.
1255 <collection name="interfaces">
1256 <scalar name="bcast">
1257 <description>The guest's broadcast address.</description>
1259 <scalar name="lback">
1260 <description>The guest's loopback address.</description>
1263 <description>The default network device. See <optionref ref="per-if-dev">iface/dev</optionref> for more information.</description>
1265 <scalar name="prefix">
1266 <description>The default network prefix-length.</description>
1268 <scalar name="mask">
1269 <description>The default network mask.</description>
1271 <scalar name="scope">
1272 <description>The default scope of the network interfaces.</description>
1274 <boolean id="local-vlandev" name="vlandev" since="0.30.211">
1276 When this file exists, the steps which setup and destroy a VLAN
1277 interface will be executed for all interfaces of this vserver.
1280 <boolean id="local-novlandev" name="novlandev">
1282 When this file exists, the steps which setup and destroy a VLAN
1283 interface will be skipped. This overrides the global
1284 <optionref ref="global-vlandev">vlandev</optionref> setting for
1289 <collection name="iface" type="symbolic">
1291 'iface' is an arbitrary name for the interface; the value itself is
1292 not important but may be interesting regarding interface-creation and
1293 usage with <tool>chbind</tool>. Both happens in alphabetical order and
1294 numbers like '00' are good names for these directories.
1297 <boolean name="disabled">
1298 <description>When this file exists, this interface will be ignored.</description>
1302 <description>The IP address which will be assigned to this interface.</description>
1304 <scalar name="dev" id="per-if-dev">
1305 <description>The network device. When this is specified, the IP address will be assigned and removed when starting and stopping the guest.</description>
1307 <scalar name="prefix">
1308 <description>The network prefix-length.</description>
1310 <scalar name="mask">
1311 <description>The network mask.</description>
1313 <scalar name="scope">
1314 <description>The scope of the network interface.</description>
1316 <scalar name="name">
1318 When this file exists, the interface will be named with the text in
1319 this file. Without such an entry, the IP will not be shown by
1320 <tool>ifconfig</tool> but by <command>ip addr ls</command> only. Such
1321 a labeled interface is known as an "alias" also (e.g. 'eth0:foo').
1324 <boolean name="nodev">
1326 When this file exists, the interface will be assumed to exist
1327 already. This can be used to assign primary interfaces which are
1328 created by the host or another vserver.
1331 <boolean name="novlandev">
1333 When this file exists, the steps which setup and destroy a VLAN
1334 interface will be skipped. This will override the global
1335 <optionref ref="global-vlandev">vlandev</optionref> and the per-guest
1336 <optionref ref="local-vlandev">vlandev</optionref>.
1339 <boolean name="vlandev" since="0.30.211">
1341 When this file exists, the steps which setup and destroy a VLAN
1342 interface will be executed.
1345 <boolean name="tun" since="0.30.215">
1347 When this file exists, a tun interface will be created when the guest
1348 starts, and removed when the guest stops.
1351 <boolean name="tap" since="0.30.215">
1353 When this file exists, a tap interface will be created when the guest
1354 starts, and removed when the guest stops.
1357 <boolean name="nocsum" since="0.30.215">
1359 If a tun or tap interface is created, the presence of this file will
1360 disable checksumming on it.
1363 <boolean name="shared" since="0.30.215">
1365 When this file exists, the tun/tap interface created will not be
1366 owned by this particular guest.
1369 <scalar name="uid" since="0.30.215">
1371 Sets the ownership of tun/tap interfaces. Requires a user id, not a
1375 <scalar name="gid" since="0.30.215">
1377 Sets the group ownership of tun/tap interfaces. Requires a group id,
1381 <scalar name="linktype" since="0.30.215">
1383 Sets the link type of tun/tap interfaces.
1386 <scalar name="peer" since="0.30.216">
1388 Sets the peer for a point-to-point link, such as a tun interface.
1394 <collection name="ulimits">
1396 A directory with ulimits. Possible resources are cpu, data, fsize,
1397 locks, memlock, nofile, nproc, rss and/or stack.
1399 <scalar name="resource" type="symbolic">
1401 A file which contains the hard- and soft-limit of the given resource
1402 in the first line. The special keyword 'inf' is recognized.
1405 <scalar name="resource.hard" type="symbolic">
1407 A file which contains the hard-limit of the given resource in the first
1408 line. The special keyword 'inf' is recognized.
1411 <scalar name="resource.soft" type="symbolic">
1413 A file which contains the soft-limit of the given resource in the first
1414 line. The special keyword 'inf' is recognized.
1419 <collection name="rlimits">
1421 A directory with resource limits. Possible resources are cpu, fsize,
1422 data, stack, core, rss, nproc, nofile, memlock, as, locks, msgqueue,
1423 nsock, openfd, anon, shmem, semary, nsems and dentry. This
1424 configuration will be honored for kernel 2.6 only.
1426 <scalar name="resource" type="symbolic">
1428 A file which contains the hard- and soft-limit of the given resource
1429 in the first line. The special keyword 'inf' is recognized.
1432 <scalar name="resource.hard" type="symbolic">
1434 A file which contains the hard-limit of the given resource in the first
1435 line. The special keyword 'inf' is recognized.
1438 <scalar name="resource.soft" type="symbolic">
1440 A file which contains the soft-limit of the given resource in the first
1441 line. The special keyword 'inf' is recognized.
1444 <scalar name="resource.min" type="symbolic">
1446 A file which contains the guaranteed minimum of the given resource in
1447 the first line. The special keyword 'inf' is recognized.
1452 <collection name="uts">
1453 <scalar name="context">
1455 The context-name of the vserver. This file is listed for completeness
1456 only; the 'context' name is used and set internally by the util-vserver
1457 tools and can *not* be modified.
1460 <scalar name="sysname">
1461 <description>The sysname of the vserver</description>
1463 <scalar name="nodename">
1464 <description>The node-/hostname of the vserver</description>
1466 <scalar name="release">
1467 <description>The OS-release of the vserver</description>
1469 <scalar name="version">
1470 <description>The OS-version of the vserver</description>
1472 <scalar name="machine">
1473 <description>The machine-type of the vserver</description>
1475 <scalar name="domainname">
1476 <description>The NIS domainname of the vserver</description>
1480 <collection name="dlimits" since="0.30.210">
1482 Note that all entries are required for the disk limit to be applied.
1484 <collection name="x" type="symbolic">
1485 <description>'x' is an arbitrary name, replace it with e.g. integers</description>
1486 <scalar name="directory">
1487 <description>The directory to which the limit should be applied</description>
1489 <scalar name="inodes_total">
1490 <description>The amount of inodes this vserver should be limited to</description>
1492 <scalar name="space_total">
1493 <description>The amount of space this vserver should be limited to (measured in blocks of 1024 bytes)</description>
1495 <scalar name="reserved">
1496 <description>How much space (percentage-wise) should be reserved for the root user</description>
1501 <collection name="sysctl" since="0.30.213">
1502 <collection name="x" type="symbolic">
1503 <description>'x' is an arbitrary name, replace it with e.g. integers</description>
1504 <scalar name="setting">
1505 <description>The sysctl setting</description>
1507 <scalar name="value">
1508 <description>The value</description>
1513 <collection name="cpuset" since="0.30.211">
1515 Puts the guest in a cpuset. Required entries are name, cpus and mems.
1517 <scalar name="name">
1518 <description>The name of the cpuset for this vserver</description>
1520 <scalar name="cpus">
1521 <description>The list of CPUs in this cpuset</description>
1523 <scalar name="mems">
1524 <description>The list of Memory Nodes in this cpuset</description>
1526 <scalar name="cpu_exclusive">
1527 <description>Is the CPU assignment exclusive?</description>
1529 <scalar name="mems_exclusive">
1530 <description>Is the memory node assignment exclusive?</description>
1532 <scalar name="nocreate">
1533 <description>When this file exists, the cpuset will be assumed to exist already</description>
1537 <collection id="sched" name="sched" since="0.30.212">
1538 <scalar id="global-tokens" name="tokens">
1539 <description>The initial amount of tokens to put in the bucket</description>
1541 <scalar id="global-tokens-min" name="tokens-min">
1542 <description>The minimum amount of tokens required to unhold the context</description>
1544 <scalar id="global-tokens-max" name="tokens-max">
1545 <description>The bucket's size</description>
1547 <scalar id="global-fill-rate" name="fill-rate">
1548 <description>Amount of tokens to add each <optionref ref="global-interval">interval</optionref></description>
1550 <scalar id="global-interval" name="interval">
1551 <description>The interval between refills of the bucket</description>
1553 <scalar id="global-priority-bias" name="priority-bias">
1554 <description>Bias added to priorities calculated within the guest (result is clamped to -20/+19)</description>
1556 <scalar id="global-fill-rate2" name="fill-rate2">
1557 <description>Amount of tokens to add each <optionref ref="global-interval2">interval2</optionref> when advancing idle time</description>
1559 <scalar id="global-interval2" name="interval2">
1560 <description>The interval between refills of the bucket when advancing idle time</description>
1562 <boolean id="global-idle-time" name="idle-time">
1563 <description>When this file exists, advancing idle time is activated</description>
1565 <collection name="cpu-id" type="symbolic">
1566 <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>
1567 <scalar name="tokens">
1568 <description>The initial amount of tokens to put in the bucket</description>
1570 <scalar name="tokens-min">
1571 <description>The minimum amount of tokens required to unhold the context</description>
1573 <scalar name="tokens-max">
1574 <description>The bucket's size</description>
1576 <scalar name="fill-rate">
1577 <description>Amount of tokens to add each <optionref ref="local-interval">interval</optionref></description>
1579 <scalar id="local-interval" name="interval">
1580 <description>The interval between refills of the bucket</description>
1582 <scalar name="priority-bias">
1583 <description>Bias added to priorities calculated within the guest (result is clamped to -20/+19)</description>
1585 <scalar name="fill-rate2">
1586 <description>Amount of tokens to add each <optionref ref="local-interval2">interval2</optionref> when advancing idle time</description>
1588 <scalar id="local-interval2" name="interval2">
1589 <description>The interval between refills of the bucket when advancing idle time</description>
1591 <boolean name="idle-time">
1592 <description>When this file exists, advancing idle time is activated</description>
1594 <scalar id="cpu-id" name="cpu-id">
1595 <description>The CPU to apply these settings to</description>
1597 <scalar name="bucket-id">
1598 <description>The bucket to apply these settings to</description>
1603 <collection name="spaces" since="0.30.215">
1604 <boolean name="pid">
1605 <description>Enables pid virtualization for this guest</description>
1607 <boolean name="net">
1608 <description>Enable network virtualization for this guest</description>
1610 <scalar name="mask">
1611 <description>Contains a mask of spaces to clone/enter</description>
1615 <collection name="ionice" since="0.30.216">
1616 <scalar name="class">
1617 <description>The IO scheduling class to use for this guest (see ionice(1)).</description>
1619 <scalar name="priority">
1620 <description>The IO scheduling priority to use for this guest (see ionice(1)).</description>
1624 <collection name="cgroup" use="optional" since="0.30.216" id="guest-cgroup">
1626 This directory contains cgroup settings to be applied to this guest.
1627 See your kernel documentation for what settings are valid with your
1630 <scalar name="name">
1632 If this file exists, the guest will be put in a cgroup named after the
1633 contents of this file. The default is to name the cgroup the same thing as the
1635 <optionref ref="global-cgroup-name">.defaults/cgroup/name</optionref> says
1640 <scalar name="nocgroup" since="0.30.216">
1642 If this file exists,
1643 <optionref ref="global-cgroup">.defaults/cgroup</optionref> will be ignored