Add base to all the right spots.
[util-vserver.git] / doc / configuration.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE database SYSTEM "configuration.dtd" []>
3 <!-- $Id$ -->
4
5 <database xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6           xsi:noNamespaceSchemaLocation="file:configuration.xsd">
7
8   <!-- Global configuration -->
9   <collection name=".defaults" use="optional">
10     <collection name="init" type="fixed">
11       <data name="mtab">
12         <description>Default mtab file</description>
13       </data>
14     </collection>
15
16     <link name="vdirbase">
17       <default>/vservers</default>
18       <description>A link to the default vserver rootdirectory.</description>
19     </link>
20
21     <link name="cachebase">
22       <default>/var/cache/vservers</default>
23       <description>
24 A link to the directory which will hold cached information about
25 vservers.
26       </description>
27     </link>
28
29     <boolean id="global-nonamespace" name="nonamespace">
30       <description>
31 Disable namespace usage globally. It can be overridden for a single vserver
32 by setting the <optionref ref="global-namespace">namespace</optionref> flag
33 there.
34
35 In this mode the <directory>/vservers</directory> directory must have
36 the 'barrier' attribute. Else, common chroot(2) exploits are possible.
37       </description>
38     </boolean>
39
40     <boolean id="global-nonamespace-cleanup" name="nonamespace-cleanup">
41       <description>
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
44 there.
45       </description>
46     </boolean>
47
48     <list id="global-namespace-cleanup-skip" name="namespace-cleanup-skip">
49       <description>
50 List of paths to skip during namespace cleanup.
51       </description>
52     </list>
53
54     <link name="run.rev">
55       <description>
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.
60
61 NOTE: this link exists in 0.30.202+ only; in previous versions it was
62 a vserver specific setting.
63       </description>
64     </link>
65
66     <scalar name="shell">
67       <description>
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>.
71       </description>
72     </scalar>
73
74     <data name="fstab">
75       <description>
76 The default fstab file to put in newly built guests.
77       </description>
78     </data>
79
80     <boolean name="context.dynamic">
81       <description>
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>.
85       </description>
86     </boolean>
87
88     <scalar id="context.next" name="context.next">
89       <description>
90 The context id to use for the next guest created by "vserver ... build".
91       </description>
92     </scalar>
93     
94     <collection name="apps">
95       <collection name="pkgmgmt">
96         <link name="base">
97           <default>/vservers/.pkg</default>
98         </link>
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.
102           </description>
103         </data>
104       </collection>
105       
106       <collection name="debootstrap">
107         <scalar name="mirror">
108           <description>
109 The Debian mirror to use with the <tool>debootstrap</tool> program
110           </description>
111         </scalar>
112         <scalar name="uri">
113           <description>
114 When the <tool>debootstrap</tool> package is not installed; fetch it
115 from this uri and install it at a temporary place.
116           </description>
117         </scalar>
118       </collection>
119
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>
125           </boolean>
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>
128           </boolean>
129           <boolean id="vdevmap-remap" name="remap">
130             <description>
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
133             </description>
134           </boolean>
135           <scalar name="flags">
136             <description>This file will let you specify unimplemented flags manually</description>
137           </scalar>
138           <scalar name="device">
139             <description>Contains the name of a device node</description>
140           </scalar>
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>
143           </scalar>
144         </collection>
145       </collection>
146
147       <collection name="vshelper">
148         <link name="logfile">
149           <description>
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>.
153           </description>
154         </link>
155
156         <collection name="vshelper-methods">
157           <program name="handler" type="symbolic">
158             <description>
159 See <optionref ref="vshelper-action">vshelper/action</optionref>.
160             </description>
161           </program>
162         </collection>
163
164         <boolean name="disabled">
165           <description>
166 When existing, the vshelper functionality will be disabled for all
167 vservers.
168           </description>
169         </boolean>
170
171         <boolean name="debug">
172           <description>
173 When existing, the vshelper execution will be traced.
174           </description>
175         </boolean>
176         
177         <boolean name="warning-disabled">
178           <description>
179 When existing, sanity checks for the vshelper functionality will be
180 skipped.
181           </description>
182         </boolean>
183
184       </collection>
185       
186       <collection name="vprocunhide">
187         <list name="files">
188           <description>
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'.
193           </description>
194         </list>
195       </collection>
196       
197       <collection name="init">
198         <link name="tty">
199           <description>
200 A symlink to the TTY device where input/output will be redirected from/to
201 at startup via initscript.
202           </description>
203         </link>
204
205         <hash id="global-environment" name="environment" since="0.30.211">
206           <description>
207 The environment to set when starting guests. Contains one VAR=VAL
208 pair per line.
209           </description>
210         </hash>
211       </collection>
212       
213       <collection name="vunify">
214         <list name="exclude">
215           <description>Static list of excluded files.</description>
216         </list>
217
218         <collection name="hash" since="0.30.205">
219           <description>
220 A directory which will be used as the storage place for the
221 <tool>vhashify</tool> command.
222           </description>
223           <link name="id" type="symbolic">
224             <description>
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
227 filesystem.
228             </description>
229           </link>
230
231           <scalar name="method" since="0.30.299">
232             <default>SHA1</default>
233             <description>The used hash method.</description>
234           </scalar>
235         </collection>
236
237         <boolean name="pkgmgmt-ignore" default="off" since="0.30.205">
238           <description>
239 When existing, information from packagemanagement will not be used to
240 create dynamic exclude-lists.
241           </description>
242         </boolean>
243
244         <boolean name="pgkmgmt-force" default="off" since="0.30.205">
245           <description>
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.
250           </description>
251         </boolean>
252
253       </collection>
254
255       <collection name="vlogin">
256         <boolean id="vlogin-disable" name="disable" since="0.30.212">
257           <description>
258 When this file exists, vlogin isn't used on vserver &lt;guest&gt; enter.
259           </description>
260         </boolean>
261       </collection>
262
263       <collection name="build">
264         <list name="options">
265           <description>
266 A list of default options to supply to vserver ... build, one option per line.
267           </description>
268         </list>
269       </collection>
270     </collection>
271
272     <collection name="interfaces" use="optional">
273       <boolean id="global-vlandev" name="vlandev" since="0.30.211">
274         <description>
275 When this file exists, the steps which setup and destroy a VLAN
276 interface will be executed.
277         </description>
278       </boolean>
279     </collection>
280
281     <collection name="files">
282       <description>This directory contains some files which will be copied to the guests during build.</description>
283       <data name="hosts">
284         <description>The default /etc/hosts file.</description>
285       </data>
286       <data name="nsswitch.conf">
287         <description>The default /etc/nsswitch.conf file.</description>
288       </data>
289       <data name="krb5.conf">
290         <description>The default /etc/krb5.conf file.</description>
291       </data>
292       <data name="krb.conf">
293         <description>The default /etc/krb.conf file.</description>
294       </data>
295       <data name="krb.realms">
296         <description>The default /etc/krb.realms file.</description>
297       </data>
298       <data name="ldap.conf">
299         <description>The default /etc/ldap.conf file.</description>
300       </data>
301       <data name="localtime">
302         <description>The default /etc/localtime file.</description>
303       </data>
304       <data name="resolv.conf">
305         <description>The default /etc/resolv.conf file.</description>
306       </data>
307     </collection>
308
309     <collection name="cgroup" use="optional" since="0.30.216" id="global-cgroup">
310       <description>
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
313 configuration.
314       </description>
315       <scalar name="mnt">
316         <description>
317 The directory to mount the cgroup hierarchy at. The default is /dev/cgroup.
318         </description>
319       </scalar>
320       <scalar name="subsys">
321         <description>
322 Comma-separated list of subsystems to enable on the cgroup mount point.
323 The default is "all".
324         </description>
325       </scalar>
326       <list name="inherit">
327         <description>
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.
333         </description>
334       </list>
335       <scalar name="name" id="global-cgroup-name">
336         <description>
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.
340         </description>
341       </scalar>
342       <scalar name="base">
343         <description>
344 If this file exists, all cgroups will be created underneath this directory
345 in the cgroup mount point.
346         </description>
347       </scalar>
348     </collection>
349   </collection>
350     
351   <collection name=".distributions" use="optional">
352     <collection name="dist" type="symbolic">
353       <scalar name="dev">
354         <description></description>
355       </scalar>
356       <collection name="yum">
357         <description>
358 The default, yum-related content of the <directory>/etc</directory>
359 directory.
360         </description>
361         <scalar name="yum.conf">
362           <description>
363 The master yum configuration file. It supports the @YUMETCDIR@,
364 @YUMCACHEDIR@ and @YUMLOGDIR@ placeholder which will be replaced at
365 <command>vserver ... build</command> time.
366           </description>
367         </scalar>
368       </collection>
369       <collection name="yum.repos.d">
370         <description>A directory with yum repositories.</description>
371       </collection>
372       <data name="apt.conf">
373         <description>
374 The default apt.conf which is going to be used. It overrides the
375 apt.conf from CONFDIR/.defaults/apps/pkgmgmt.
376         </description>
377       </data>
378       <program name="initpre">
379         <description>
380 Script which will be executed before packages will be installed.
381           </description>
382         <parameterList>
383           <parameter name="confdir">
384             <description>
385 The configuration directory of the vserver which is going to be set up.
386             </description>
387           </parameter>
388           <parameter name="util-vserver-vars">
389             <description>
390 The pathname of the util-vserver-vars file.
391             </description>
392           </parameter>
393         </parameterList>
394       </program>
395       <program name="initpost">
396         <description>
397 Script which will be executed after packages are installed.
398           </description>
399         <parameterList>
400           <parameter name="confdir">
401             <description>
402 The configuration directory of the vserver which is going to be set up.
403             </description>
404           </parameter>
405           <parameter name="vserver">
406             <description>
407 The pathname of the util-vserver-vars file.
408             </description>
409           </parameter>
410         </parameterList>
411       </program>
412       
413       <collection name="pkgs">
414         <description>
415 Contains files with packagenames.
416         </description>
417         <list name="list">
418           <description>
419 File which contains the name of packages. On top of file the special
420 keywords '--reinstall' and '--can-fail' are possible.
421           </description>
422         </list>
423       </collection>
424       
425       <collection name="pubkeys">
426         <description>
427 Directory with GPG pubkeys which are used to sign the packages of this
428 distribution.
429         </description>
430       </collection>
431       
432       <collection name="apt">
433         <description>
434 Default content of the <directory>/etc/apt/</directory> directory.
435         </description>
436       </collection>
437       
438       <collection name="rpm">
439         <description>
440 Default content of the <directory>/etc/rpm</directory> directory.
441         </description>
442       </collection>
443       
444       <link name="rpmlib">
445         <description>
446 Directory which overrides <directory>/usr/lib/rpm</directory>.
447         </description>
448       </link>
449       <link name="execdir">
450         <description>
451 Directory with all executables and libraries which are required for
452 this distribution.
453         </description>
454       </link>
455     </collection>
456     <link name="template">
457       <description>
458 Symlink to the default template for this distribution.
459       </description>
460     </link>
461   </collection>
462   
463   <!-- Vserver configuration -->
464   <collection name="vserver-name" type="symbolic">
465     <description>
466 The configuration directory for the vserver vserver-name.
467     </description>
468
469     <link name="cache">
470       <default>../.defaults/cachebase/VSERVERNAME</default>
471       <description>
472 Path of the storage area for cached information about this vserver.
473       </description>
474     </link>
475     
476     <link name="vdir">
477       <default>../.defaults/vdirbase/VSERVERNAME</default>
478       <description>
479 Path of the vserver root directory.
480       </description>
481     </link>
482
483     <link name="run">
484       <description>
485 Points to a file which will contain the XID of the running vserver. When
486 the vserver is stopped, this can be a dangling symlink.
487       </description>
488     </link>
489
490     <list id="bcapabilities" name="bcapabilities">
491       <description>
492 Contains the system capabilities. See
493 <ulink url="http://svn.linux-vserver.org/svn/util-vserver/trunk/lib/bcaps-v13.c">lib/bcaps-v13.c</ulink>
494 for possible values.
495       </description>
496     </list>
497     <list name="ccapabilities">
498       <description>
499 Contains the context capabilities. See <ulink
500 url="http://svn.linux-vserver.org/svn/util-vserver/trunk/lib/ccaps-v13.c">lib/ccaps-v13.c</ulink>
501 for possible values.
502       </description>
503     </list>
504     <list name="ncapabilities" since="0.30.212">
505       <description>
506 Contains the network capabilities. See <ulink
507 url="http://svn.linux-vserver.org/svn/util-vserver/trunk/lib/ncaps-net.c">lib/ncaps-net.c</ulink>
508 for possible values.
509       </description>
510     </list>
511
512     <boolean id="global-namespace" name="namespace">
513       <description>
514 Overrides the global <optionref ref="global-nonamespace">nonamespace</optionref> flag and enables
515 namespace usage for the current vserver.
516       </description>
517     </boolean>
518
519     <boolean name="nonamespace">
520       <description>
521 Disables namespace usage for the current vserver.
522
523 In this mode the <directory>/vservers</directory> directory must have
524 the 'barrier' attribute. Else, common chroot(2) exploits are possible.
525       </description>
526     </boolean>
527
528     <boolean id="namespace-cleanup" name="namespace-cleanup">
529       <description>
530 Overrides the global <optionref ref="global-nonamespace-cleanup">nonamespace-cleanup</optionref> flag and enables
531 namespace cleanup for the current vserver.
532       </description>
533     </boolean>
534
535     <list name="namespace-cleanup-skip">
536       <description>
537 List of paths to skip during namespace cleanup. This overrides the global
538 <optionref ref="global-namespace-cleanup-skip">namespace-cleanup-skip</optionref>
539 file.
540       </description>
541     </list>
542
543     <hash name="schedule">
544       <description>
545 [deprecated; use <optionref ref="sched">sched</optionref> instead] Contains the
546 scheduler parameters, one per line.
547
548 The Hard CPU limit uses a mechanism called a Token Bucket.  the
549 concept is simple: you have a bucket of a certain size which is
550 filled with a specified amount R of tokens each interval T until the
551 maximum is reached (excess tokens are spilled). At each timer tick,
552 a running process consumes one token from the bucket, unless the
553 bucket is empty. If the bucket is empty the process is put in the
554 hold queue. When the bucket has been refilled to at least M tokens,
555 all on hold processes are rescheduled.
556
557 See the <ulink url="http://linux-vserver.org/Scheduler+Parameters">Linux
558 VServer Wiki</ulink> for more information about this file.
559       </description>
560       <keys>
561         <key id="fill_rate" name="fill-rate">
562           <description>
563 Amount of tokens append to the bucket each interval.
564             </description>
565         </key>
566         <key name="interval">
567           <description>
568 The intervall between refills of amount <optionref>fill_rate</optionref>. This
569 value is express in ticks.
570           </description>
571         </key>
572         <key name="tokens">
573           <description>
574 Initial bucket contents.
575           </description>
576         </key>
577         <key name="tokens-min">
578           <description>
579 The minimum amount of tokens required to unhold processes
580           </description>
581         </key>
582         <key name="tokens-max">
583           <description>
584 The bucket size.
585           </description>
586         </key>
587         <key name="priority-bias">
588           <description>
589 ???
590           </description>
591         </key>
592       </keys>
593     </hash>
594     <scalar name="name">
595       <description>
596 Contains the name of the vserver. When not given, the basename of the directory
597 will be assumed as this name.
598       </description>
599     </scalar>
600     <scalar name="nice">
601       <description>
602 The nice-level on which the vserver will be started.
603       </description>
604     </scalar>
605     <list name="capabilities">
606       <description>
607 Contains per line a capability. This file is used for the 2.4 kernel
608 only; for 2.6 use <optionref>bcapabilities</optionref>.
609       </description>
610     </list>
611     <scalar id="shell" name="shell">
612       <description>
613 Contains the pathname of the shell which will be used by the "vserver
614 ... enter" command.
615       </description>
616     </scalar>
617     <list name="personality">
618       <description>
619 Used to set the personality of the vserver. First line in the file
620 is the personality-type followed by flags (one item per line). See
621 <filename>/usr/include/linux/personality.h</filename> for possible
622 values.
623       </description>
624     </list>
625     <list name="cflags" id="cflags" since="0.30.216">
626       <description>
627 Contains per line a flag. See <ulink
628 url="http://svn.linux-vserver.org/svn/util-vserver/trunk/lib/cflags-v13.c">lib/cflags-v13.c</ulink>
629 for possible values.
630       </description>
631     </list>
632     <list name="flags">
633       <description>
634 Old name for <optionref>cflags</optionref>. Deprecated.
635       </description>
636     </list>
637     <list name="nflags" since="0.30.212">
638       <description>
639 Contains a network flag per line. See <ulink
640 url="http://svn.linux-vserver.org/svn/util-vserver/trunk/lib/nflags-net.c">lib/nflags-net.c</ulink>
641 for possible values.
642       </description>
643     </list>
644     <scalar name="context">
645       <description>
646 Contains the context id which shall be used for the vserver. Valid range is 2 through 49151.
647         </description>
648     </scalar>
649     <scalar name="ncontext">
650       <description>
651 Contains the network context id which shall be used for the vserver. Valid range is 2 through 49151.
652       </description>
653     </scalar>
654     <scalar name="tag">
655       <description>
656 Contains the filesystem tag which shall be used for the vserver. Valid range is 2 through 49151.
657       </description>
658     </scalar>
659     <data id="fstab" name="fstab">
660       <description>
661 The fstab file for the vserver. Entries in this file will be mounted
662 within the network context of the host. Use the
663 <optionref>fstab.remote</optionref> file when you want that the
664 mounting happens in the network context of the vserver. In most cases
665 the 'fstab' file should be used.
666       </description>
667     </data>
668     <data id="fstab.remote" name="fstab.remote">
669       <description>
670 The fstab file for the vserver. Entries in this file will be mounted
671 within the network context of the guest; this means that mount will be
672 called as <command>chbind &lt;options&gt; mount ...</command>. See
673 <optionref>fstab</optionref> also.
674       </description>
675     </data>
676     <scalar name="badness">
677       <description>
678 Contains the bias to be applied to processes in this guest when the OOM-killer strikes.
679       </description>
680     </scalar>
681     
682     <collection name="apps">
683       <collection name="init">
684         <data name="mtab">
685           <description>
686 The initial-mtab which will be used for the vserver.
687           </description>
688         </data>
689         
690         <scalar name="style">
691           <description>
692 Contains the init-style.
693           </description>
694           <restriction>
695             <enumeration value="sysv"/>
696             <enumeration value="plain"/>
697             <enumeration value="minit"/>
698           </restriction>
699         </scalar>
700         
701         <scalar name="runlevel">
702           <description>The start runlevel.</description>
703         </scalar>
704         
705         <scalar name="runlevel.start">
706           <description>The start runlevel.</description>
707         </scalar>
708         
709         <scalar name="runlevel.stop">
710           <description>The stop runlevel.</description>
711         </scalar>
712         
713         <scalar name="killseq">
714           <description>
715 Contains the 'signal [wait signal]*' sequence which is used to stop
716 the vserver.
717           </description>
718         </scalar>
719         
720         <list name="cmd.start">
721           <description>
722 The command which is used to start the vserver. Each option must be on
723 a separate line.
724           </description>
725         </list>
726         
727         <list name="cmd.start-sync">
728           <description>
729 The command which is used to wait on the vserver after it has been
730 started. Each option must be on a separate line. This file will be
731 ignored when the <optionref>sync</optionref> flag does not exist and the
732 '--sync' option was not used.
733           </description>
734         </list>
735         
736         <list name="cmd.stop">
737           <description>
738 The command which is used to stop the vserver. Each option must be on
739 a separate line.
740           </description>
741         </list>
742         
743         <list name="cmd.stop-sync">
744           <description>
745 The command which is used to wait on the vserver after it has been
746 stopped. Each option must be on a separate line. This file will be
747 ignored when the <optionref>sync</optionref> flag does not exist and the
748 '--sync' option was not used.
749           </description>
750         </list>
751         
752         <list name="cmd.prepare">
753           <description>
754 The command which is used to setup the init-system (e.g. to set the
755 runlevel in the utmp-file). Each option must be on a separate line.
756           </description>
757         </list>
758         
759         <boolean id="sync" name="sync">
760           <description>
761 If this file is not present, all 'cmd.*-sync files will be ignored.
762             </description>
763         </boolean>
764         
765         <link name="tty">
766           <description>
767 A symlink to the TTY device where input/output will be redirected
768 from/to at startup via initscript.
769           </description>
770         </link>
771         
772         <scalar name="mark">
773           <description>
774 This file is used to mark group of vservers which shall be started/stopped
775 together by the initscript. Content is a simple string like 'default'.
776           </description>
777         </scalar>
778         
779         <list name="depends">
780           <description>
781 This file is used to configure vservers which must be running before
782 the current vserver can be started. At shutdown, the current vserver
783 will be stopped before its dependencies. Content of this file are
784 vserver ids (one name per line).
785           </description>
786         </list>
787
788         <hash name="environment" since="0.30.211">
789           <description>
790 The environment to set when starting the guest. Contains one VAR=VAL
791 pair per line.
792           </description>
793         </hash>
794       </collection>
795
796       <collection name="vdevmap">
797         <collection name="x" type="sybmolic">
798           <description>'x' is an arbitrary name, replace it with e.g. device names</description>
799           <boolean name="open">
800             <description>When this file exists, the device can be opened</description>
801           </boolean>
802           <boolean name="create">
803             <description>When this file exists, the device can be created (if the guest has <optionref ref="bcapabilities">CAP_MKNOD</optionref>)</description>
804           </boolean>
805           <boolean id="guest-vdevmap-remap" name="remap">
806             <description>
807 When this file exists, <optionref ref="guest-vdevmap-target">target</optionref> will
808 have to exist as well and opening the device will in fact open the target device
809             </description>
810           </boolean>
811           <scalar name="flags">
812             <description>This file will let you specify unimplemented flags manually</description>
813           </scalar>
814           <scalar name="device">
815             <description>Contains the name of a device node</description>
816           </scalar>
817           <scalar id="guest-vdevmap-target" name="target">
818             <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>
819           </scalar>
820         </collection>
821       </collection>
822   
823       <collection name="vshelper">
824         <scalar name="sync-timeout">
825           <default>30</default>
826           <description>
827 The timeout in seconds which is used when synchronising vserver
828 startup/shutdown with the vshelper. When not set, 30 seconds will be
829 assumed.
830           </description>
831         </scalar>
832         
833         <scalar id="vshelper-action" name="action">
834           <default>restart</default>
835           <description>
836 The action which is going to be executed when a vshelper event
837 occurs. The default value is 'restart', but there can be defined own
838 methods by placing scripts into the
839 <optionref>vshelper-methods</optionref> directories. These scripts are
840 fed with the same arguments as the <tool>vshelper</tool> script.
841           </description>
842         </scalar>
843         
844         <program name="event" type="symbolic">
845           <description>
846 When existing, these scripts will be executed *instead* of the default
847 handler defined in 'action'. Their name must match the event which caused
848 the execution of <tool>vshelper</tool>; e.g. 'restart' or 'poweroff'. See
849 the vs_reboot() function in the kernel for more details.
850           </description>
851           <parameterList>
852             <parameter name="xid">
853               <description>
854 The xid of the context calling the vshelper
855               </description>
856             </parameter>
857             <parameter name="event">
858               <description>
859 The reboot-event.
860               </description>
861             </parameter>
862           </parameterList>
863         </program>
864         
865         <boolean name="disabled">
866           <description>
867 When existing, the vshelper functionality will be disabled for this
868 vserver.
869           </description>
870         </boolean>
871
872         <boolean name="debug">
873           <description>
874 When existing, the vshelper execution will be traced for this vserver.
875           </description>
876         </boolean>
877         
878         <boolean name="warning-disabled">
879           <description>
880 When existing, sanity checks for the vshelper functionality will be
881 skipped.
882           </description>
883         </boolean>
884         
885       </collection>
886       
887       <collection id="vshelper-methods" name="vshelper-methods">
888         <program name="handler" type="symbolic">
889           <description>
890 See <optionref ref="vshelper-action">vshelper/action</optionref>.
891           </description>
892         </program>
893       </collection>
894       
895       <collection name="vunify">
896         <description>
897 This directory contains configuration data required for vserver
898 unification.
899         </description>
900         
901         <list name="exclude">
902           <description>
903 <p>Static list of files which are excluded for unification. This list
904 supports an rsync-like syntax: when a file is prefixed by '+', it is a
905 candidate for unification; when there is no prefix or a '-' or a '~' it
906 will be excluded. Shell-wildcards are allowed for the filenames.</p>
907 <p>When used with <tool>vcopy</tool>, the '~' prefix prevents copying
908 of the file entirely (e.g. for keyfiles). With this tool, the file will
909 be copied instead of hardlinked when the '-' prefix is used.</p>
910           </description>
911         </list>
912         
913         <link name="refserver.X" type="symbolic">
914           <description>
915 These are symlinks to the configuration directory
916 (e.g. CONFDIR/vservers/&lt;id&gt;) of a refserver. There may be
917 multiple such symlinks but they must be prefixed by 'refserver.' and
918 will be processed in alphanumerical order.
919           </description>
920         </link>
921
922         <collection name="hash" since="0.30.205">
923           <description>
924 A directory which will be used as the storage place for the
925 <tool>vhashify</tool> command.
926           </description>
927           <link name="id" type="symbolic">
928             <description>
929 Points to a directory within the filesystems which are used for the
930 vservers. There must be not more than one of such a directory per
931 filesystem.
932             </description>
933           </link>
934
935           <scalar name="method"  since="0.30.299">
936             <default>SHA1</default>
937             <description>The used hash method.</description>
938           </scalar>
939         </collection>
940
941         <boolean name="pkgmgmt-ignore" default="off" since="0.30.205">
942           <description>
943 When existing, information from packagemanagement will not be used to
944 create dynamic exclude-lists.
945           </description>
946         </boolean>
947
948         <boolean name="pgkmgmt-force" default="off" since="0.30.205">
949           <description>
950 When existing, information from packagemanagement will be used to
951 create dynamic exclude-lists. This option requires that (a known)
952 packagemanagement is configured for the vserver; else the requested
953 operation will fail. Most tools assume 'on' as the default value.
954           </description>
955         </boolean>
956         
957       </collection>
958     </collection>
959     
960     <collection name="scripts">
961       <description>
962 A directory for scripts. By default, when one of these scripts will be
963 executed, the execution of defaultscripts (within .../.defaults/scripts)
964 will be skipped. To execute them nevertheless, the $DONT_SKIP_DEFAULTS
965 environment variable must be set by one of the in-shellcontext scripts
966 (the non-executable ones).
967       </description>
968       
969       <program name="initialize" since="0.30.211">
970         <description>
971 The scriptlet which will be executed before the root filesystem is mounted and
972 the configuration has been loaded. Before executing the script, the
973 configuration directory will be made the working directory.
974         </description>
975         <parameterList>
976           <parameter name="action">
977             <description>
978 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
979             </description>
980           </parameter>
981           <parameter name="vserver-name">
982             <description>
983 The name of the current vserver.
984             </description>
985           </parameter>
986         </parameterList>
987       </program>
988       <collection name="initialize.d" since="0.30.211">
989         <description>
990 Repository of initialize like scripts.  Before executing the script,
991 the configuration directory will be made the working directory.
992         </description>
993         <program name="script" type="symbolic">
994           <description>See initialize.</description>
995           <parameterList>
996             <parameter name="action">
997               <description>
998 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
999               </description>
1000             </parameter>
1001             <parameter name="vserver-name">
1002               <description>
1003 The name of the current vserver.
1004               </description>
1005             </parameter>
1006           </parameterList>
1007         </program>
1008       </collection>
1009       
1010       <program name="prepre-start">
1011         <description>
1012 The scriptlet which will be executed before the network-interfaces are
1013 enabled and the directories are mounted. Before executing the script,
1014 the configuration directory will be made the working directory.
1015         </description>
1016         <parameterList>
1017           <parameter name="action">
1018             <description>
1019 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1020             </description>
1021           </parameter>
1022           <parameter name="vserver-name">
1023             <description>
1024 The name of the current vserver.
1025             </description>
1026           </parameter>
1027         </parameterList>
1028       </program>
1029       <collection name="prepre-start.d">
1030         <description>
1031 Repository of prepre-start like scripts.  Before executing the script,
1032 the configuration directory will be made the working directory.
1033         </description>
1034         <program name="script" type="symbolic">
1035           <description>See prepre-start.</description>
1036           <parameterList>
1037             <parameter name="action">
1038               <description>
1039 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1040               </description>
1041             </parameter>
1042             <parameter name="vserver-name">
1043               <description>
1044 The name of the current vserver.
1045               </description>
1046             </parameter>
1047           </parameterList>
1048         </program>
1049       </collection>
1050       
1051       <program name="pre-start">
1052         <description>
1053 The scriptlet which will be executed after network-interfaces were
1054 enabled and the directories mounted, but before the vserver itself has
1055 been started.  Before executing the script, the vserver root directory
1056 will be made the working directory.
1057         </description>
1058         <parameterList>
1059           <parameter name="action">
1060             <description>
1061 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1062             </description>
1063           </parameter>
1064           <parameter name="vserver-name">
1065             <description>
1066 The name of the current vserver.
1067             </description>
1068           </parameter>
1069         </parameterList>
1070       </program>
1071       <collection name="pre-start.d">
1072         <description>
1073 Repository of pre-start like scripts. Before executing these scripts,
1074 the vserver root directory will be made the working directory.
1075         </description>
1076         <program name="script" type="symbolic">
1077           <description>See pre-start.</description>
1078           <parameterList>
1079             <parameter name="action">
1080               <description>
1081 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1082               </description>
1083             </parameter>
1084             <parameter name="vserver-name">
1085               <description>
1086 The name of the current vserver.
1087               </description>
1088             </parameter>
1089           </parameterList>
1090         </program>
1091       </collection>
1092       
1093
1094       <program name="post-start">
1095         <description>
1096 The scriptlet which will be executed after the vserver has been
1097 started. Before executing the script, the vserver root directory
1098 will be made the working directory.
1099         </description>
1100         <parameterList>
1101           <parameter name="action">
1102             <description>
1103 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1104             </description>
1105           </parameter>
1106           <parameter name="vserver-name">
1107             <description>
1108 The name of the current vserver.
1109             </description>
1110           </parameter>
1111         </parameterList>
1112       </program>
1113       <collection name="post-start.d">
1114         <description>
1115 Repository of post-start like scripts. Before executing these scripts,
1116 the vserver root directory will be made the working directory.
1117         </description>
1118         <program name="script" type="symbolic">
1119           <description>See post-start.</description>
1120           <parameterList>
1121             <parameter name="action">
1122               <description>
1123 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1124               </description>
1125             </parameter>
1126             <parameter name="vserver-name">
1127               <description>
1128 The name of the current vserver.
1129               </description>
1130             </parameter>
1131           </parameterList>
1132         </program>
1133       </collection>
1134
1135
1136       <program name="pre-stop">
1137         <description>
1138 The scriptlet which will be executed before the vserver will be
1139 stopped. Before executing the script, the vserver root directory
1140 will be made the working directory.
1141         </description>
1142         <parameterList>
1143           <parameter name="action">
1144             <description>
1145 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1146             </description>
1147           </parameter>
1148           <parameter name="vserver-name">
1149             <description>
1150 The name of the current vserver.
1151             </description>
1152           </parameter>
1153         </parameterList>
1154       </program>
1155       <collection name="pre-stop.d">
1156         <description>
1157 Repository of pre-stop like scripts. Before executing the script, the
1158 vserver root directory will be made the working directory.
1159         </description>
1160         <program name="script" type="symbolic">
1161           <description>See pre-stop.</description>
1162           <parameterList>
1163             <parameter name="action">
1164               <description>
1165 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1166               </description>
1167             </parameter>
1168             <parameter name="vserver-name">
1169               <description>
1170 The name of the current vserver.
1171               </description>
1172             </parameter>
1173           </parameterList>
1174         </program>
1175       </collection>
1176
1177       <program name="post-stop">
1178         <description>
1179 The scriptlet which will be executed after the vserver has been
1180 stopped, but before the directories will be umounted and the the
1181 interfaces disabled. Before executing the script, the vserver root
1182 directory will be made the working directory.
1183         </description>
1184         <parameterList>
1185           <parameter name="action">
1186             <description>
1187 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1188             </description>
1189           </parameter>
1190           <parameter name="vserver-name">
1191             <description>
1192 The name of the current vserver.
1193             </description>
1194           </parameter>
1195         </parameterList>
1196       </program>
1197       <collection name="post-stop.d">
1198         <description>
1199 Repository of post-stop like scripts. Before executing the script, the
1200 vserver root directory will be made the working directory.
1201         </description>
1202         <program name="script" type="symbolic">
1203           <description>See post-stop.</description>
1204           <parameterList>
1205             <parameter name="action">
1206               <description>
1207 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1208               </description>
1209             </parameter>
1210             <parameter name="vserver-name">
1211               <description>
1212 The name of the current vserver.
1213               </description>
1214             </parameter>
1215           </parameterList>
1216         </program>
1217       </collection>
1218       
1219       <program name="postpost-stop">
1220         <description>
1221 The scriptlet which will be executed after the vserver has been stopped
1222 completely. Before executing the script, the vserver root directory
1223 will be made the working directory.
1224         </description>
1225         <parameterList>
1226           <parameter name="action">
1227             <description>
1228 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1229             </description>
1230           </parameter>
1231           <parameter name="vserver-name">
1232             <description>
1233 The name of the current vserver.
1234             </description>
1235           </parameter>
1236         </parameterList>
1237       </program>
1238       <collection name="postpost-stop.d">
1239         <description>
1240 Repository of postpost-stop like scripts. Before executing the script,
1241 the vserver root directory will be made the working directory.
1242         </description>
1243         <program name="script" type="symbolic">
1244           <description>See postpost-stop.</description>
1245           <parameterList>
1246             <parameter name="action">
1247               <description>
1248 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1249               </description>
1250             </parameter>
1251             <parameter name="vserver-name">
1252               <description>
1253 The name of the current vserver.
1254               </description>
1255             </parameter>
1256           </parameterList>
1257         </program>
1258       </collection>
1259     </collection>
1260     
1261     <collection name="interfaces">
1262       <scalar name="bcast">
1263         <description>The guest's broadcast address.</description>
1264       </scalar>
1265       <scalar name="lback">
1266         <description>The guest's loopback address.</description>
1267       </scalar>
1268       <scalar name="dev">
1269         <description>The default network device. See <optionref ref="per-if-dev">iface/dev</optionref> for more information.</description>
1270       </scalar>
1271       <scalar name="prefix">
1272         <description>The default network prefix-length.</description>
1273       </scalar>
1274       <scalar name="mask">
1275         <description>The default network mask.</description>
1276       </scalar>
1277       <scalar name="scope">
1278         <description>The default scope of the network interfaces.</description>
1279       </scalar>
1280       <boolean id="local-vlandev" name="vlandev" since="0.30.211">
1281         <description>
1282 When this file exists, the steps which setup and destroy a VLAN
1283 interface will be executed for all interfaces of this vserver.
1284         </description>
1285       </boolean>
1286       <boolean id="local-novlandev" name="novlandev">
1287         <description>
1288 When this file exists, the steps which setup and destroy a VLAN
1289 interface will be skipped. This overrides the global
1290 <optionref ref="global-vlandev">vlandev</optionref> setting for
1291 this vserver.
1292         </description>
1293       </boolean>
1294       
1295       <collection name="iface" type="symbolic">
1296         <description>
1297 'iface' is an arbitrary name for the interface; the value itself is
1298 not important but may be interesting regarding interface-creation and
1299 usage with <tool>chbind</tool>. Both happens in alphabetical order and
1300 numbers like '00' are good names for these directories.
1301         </description>
1302         
1303         <boolean name="disabled">
1304           <description>When this file exists, this interface will be ignored.</description>
1305         </boolean>
1306         
1307         <scalar name="ip">
1308           <description>The IP address which will be assigned to this interface.</description>
1309         </scalar>
1310         <scalar name="dev" id="per-if-dev">
1311           <description>The network device. When this is specified, the IP address will be assigned and removed when starting and stopping the guest.</description>
1312         </scalar>
1313         <scalar name="prefix">
1314           <description>The network prefix-length.</description>
1315         </scalar>
1316         <scalar name="mask">
1317           <description>The network mask.</description>
1318         </scalar>
1319         <scalar name="scope">
1320           <description>The scope of the network interface.</description>
1321         </scalar>
1322         <scalar name="name">
1323           <description>
1324 When this file exists, the interface will be named with the text in
1325 this file. Without such an entry, the IP will not be shown by
1326 <tool>ifconfig</tool> but by <command>ip addr ls</command> only.  Such
1327 a labeled interface is known as an "alias" also (e.g. 'eth0:foo').
1328           </description>
1329         </scalar>
1330         <boolean name="nodev">
1331           <description>
1332 When this file exists, the interface will be assumed to exist
1333 already. This can be used to assign primary interfaces which are
1334 created by the host or another vserver.
1335           </description>
1336         </boolean>
1337         <boolean name="novlandev">
1338           <description>
1339 When this file exists, the steps which setup and destroy a VLAN
1340 interface will be skipped. This will override the global
1341 <optionref ref="global-vlandev">vlandev</optionref> and the per-guest
1342 <optionref ref="local-vlandev">vlandev</optionref>.
1343           </description>
1344         </boolean>
1345         <boolean name="vlandev" since="0.30.211">
1346           <description>
1347 When this file exists, the steps which setup and destroy a VLAN
1348 interface will be executed.
1349           </description>
1350         </boolean>
1351         <boolean name="tun" since="0.30.215">
1352           <description>
1353 When this file exists, a tun interface will be created when the guest
1354 starts, and removed when the guest stops.
1355           </description>
1356         </boolean>
1357         <boolean name="tap" since="0.30.215">
1358           <description>
1359 When this file exists, a tap interface will be created when the guest
1360 starts, and removed when the guest stops.
1361           </description>
1362         </boolean>
1363         <boolean name="nocsum" since="0.30.215">
1364           <description>
1365 If a tun or tap interface is created, the presence of this file will
1366 disable checksumming on it.
1367           </description>
1368         </boolean>
1369         <boolean name="shared" since="0.30.215">
1370           <description>
1371 When this file exists, the tun/tap interface created will not be
1372 owned by this particular guest.
1373           </description>
1374         </boolean>
1375         <scalar name="uid" since="0.30.215">
1376           <description>
1377 Sets the ownership of tun/tap interfaces. Requires a user id, not a
1378 username.
1379           </description>
1380         </scalar>
1381         <scalar name="gid" since="0.30.215">
1382           <description>
1383 Sets the group ownership of tun/tap interfaces. Requires a group id,
1384 not a group name.
1385           </description>
1386         </scalar>
1387         <scalar name="linktype" since="0.30.215">
1388           <description>
1389 Sets the link type of tun/tap interfaces.
1390           </description>
1391         </scalar>
1392         <scalar name="peer" since="0.30.216">
1393           <description>
1394 Sets the peer for a point-to-point link, such as a tun interface.
1395           </description>
1396         </scalar>
1397       </collection>
1398     </collection>
1399     
1400     <collection name="ulimits">
1401       <description>
1402 A directory with ulimits. Possible resources are cpu, data, fsize,
1403 locks, memlock, nofile, nproc, rss and/or stack.
1404       </description>
1405       <scalar name="resource" type="symbolic">
1406         <description>
1407 A file which contains the hard- and soft-limit of the given resource
1408 in the first line. The special keyword 'inf' is recognized.
1409         </description>
1410       </scalar>
1411       <scalar name="resource.hard" type="symbolic">
1412         <description>
1413 A file which contains the hard-limit of the given resource in the first
1414 line. The special keyword 'inf' is recognized.
1415         </description>
1416       </scalar>
1417       <scalar name="resource.soft" type="symbolic">
1418         <description>
1419 A file which contains the soft-limit of the given resource in the first
1420 line. The special keyword 'inf' is recognized.
1421         </description>
1422       </scalar>
1423     </collection>
1424     
1425     <collection name="rlimits">
1426       <description>
1427 A directory with resource limits. Possible resources are cpu, fsize,
1428 data, stack, core, rss, nproc, nofile, memlock, as, locks, msgqueue,
1429 nsock, openfd, anon, shmem, semary, nsems and dentry. This
1430 configuration will be honored for kernel 2.6 only.
1431       </description>
1432       <scalar name="resource" type="symbolic">
1433         <description>
1434 A file which contains the hard- and soft-limit of the given resource
1435 in the first line. The special keyword 'inf' is recognized.
1436         </description>
1437       </scalar>
1438       <scalar name="resource.hard" type="symbolic">
1439         <description>
1440 A file which contains the hard-limit of the given resource in the first
1441 line. The special keyword 'inf' is recognized.
1442         </description>
1443       </scalar>
1444       <scalar name="resource.soft" type="symbolic">
1445         <description>
1446 A file which contains the soft-limit of the given resource in the first
1447 line. The special keyword 'inf' is recognized.
1448         </description>
1449       </scalar>
1450       <scalar name="resource.min" type="symbolic">
1451         <description>
1452 A file which contains the guaranteed minimum of the given resource in
1453 the first line. The special keyword 'inf' is recognized.
1454         </description>
1455       </scalar>
1456     </collection>
1457     
1458     <collection name="uts">
1459       <scalar name="context">
1460         <description>
1461 The context-name of the vserver. This file is listed for completeness
1462 only; the 'context' name is used and set internally by the util-vserver
1463 tools and can *not* be modified.
1464         </description>
1465       </scalar>
1466       <scalar name="sysname">
1467         <description>The sysname of the vserver</description>
1468       </scalar>
1469       <scalar name="nodename">
1470         <description>The node-/hostname of the vserver</description>
1471       </scalar>
1472       <scalar name="release">
1473         <description>The OS-release of the vserver</description>
1474       </scalar>
1475       <scalar name="version">
1476         <description>The OS-version of the vserver</description>
1477       </scalar>
1478       <scalar name="machine">
1479         <description>The machine-type of the vserver</description>
1480       </scalar>
1481       <scalar name="domainname">
1482         <description>The NIS domainname of the vserver</description>
1483       </scalar>
1484     </collection>
1485
1486     <collection name="dlimits" since="0.30.210">
1487       <description>
1488 Note that all entries are required for the disk limit to be applied.
1489       </description>
1490       <collection name="x" type="symbolic">
1491         <description>'x' is an arbitrary name, replace it with e.g. integers</description>
1492         <scalar name="directory">
1493           <description>The directory to which the limit should be applied</description>
1494         </scalar>
1495         <scalar name="inodes_total">
1496           <description>The amount of inodes this vserver should be limited to</description>
1497         </scalar>
1498         <scalar name="space_total">
1499           <description>The amount of space this vserver should be limited to (measured in blocks of 1024 bytes)</description>
1500         </scalar>
1501         <scalar name="reserved">
1502           <description>How much space (percentage-wise) should be reserved for the root user</description>
1503         </scalar>
1504       </collection>
1505     </collection>
1506
1507     <collection name="sysctl" since="0.30.213">
1508       <collection name="x" type="symbolic">
1509         <description>'x' is an arbitrary name, replace it with e.g. integers</description>
1510         <scalar name="setting">
1511           <description>The sysctl setting</description>
1512         </scalar>
1513         <scalar name="value">
1514           <description>The value</description>
1515         </scalar>
1516       </collection>
1517     </collection>
1518
1519     <collection name="cpuset" since="0.30.211">
1520       <description>
1521 Puts the guest in a cpuset. Required entries are name, cpus and mems.
1522       </description>
1523       <scalar name="name">
1524         <description>The name of the cpuset for this vserver</description>
1525       </scalar>
1526       <scalar name="cpus">
1527         <description>The list of CPUs in this cpuset</description>
1528       </scalar>
1529       <scalar name="mems">
1530         <description>The list of Memory Nodes in this cpuset</description>
1531       </scalar>
1532       <scalar name="cpu_exclusive">
1533         <description>Is the CPU assignment exclusive?</description>
1534       </scalar>
1535       <scalar name="mems_exclusive">
1536         <description>Is the memory node assignment exclusive?</description>
1537       </scalar>
1538       <scalar name="nocreate">
1539         <description>When this file exists, the cpuset will be assumed to exist already</description>
1540       </scalar>
1541     </collection>
1542
1543     <collection id="sched" name="sched" since="0.30.212">
1544       <scalar id="global-tokens" name="tokens">
1545         <description>The initial amount of tokens to put in the bucket</description>
1546       </scalar>
1547       <scalar id="global-tokens-min" name="tokens-min">
1548         <description>The minimum amount of tokens required to unhold the context</description>
1549       </scalar>
1550       <scalar id="global-tokens-max" name="tokens-max">
1551         <description>The bucket's size</description>
1552       </scalar>
1553       <scalar id="global-fill-rate" name="fill-rate">
1554         <description>Amount of tokens to add each <optionref ref="global-interval">interval</optionref></description>
1555       </scalar>
1556       <scalar id="global-interval" name="interval">
1557         <description>The interval between refills of the bucket</description>
1558       </scalar>
1559       <scalar id="global-priority-bias" name="priority-bias">
1560         <description>Bias added to priorities calculated within the guest (result is clamped to -20/+19)</description>
1561       </scalar>
1562       <scalar id="global-fill-rate2" name="fill-rate2">
1563         <description>Amount of tokens to add each <optionref ref="global-interval2">interval2</optionref> when advancing idle time</description>
1564       </scalar>
1565       <scalar id="global-interval2" name="interval2">
1566         <description>The interval between refills of the bucket when advancing idle time</description>
1567       </scalar>
1568       <boolean id="global-idle-time" name="idle-time">
1569         <description>When this file exists, advancing idle time is activated</description>
1570       </boolean>
1571       <collection name="cpu-id" type="symbolic">
1572         <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>
1573         <scalar name="tokens">
1574           <description>The initial amount of tokens to put in the bucket</description>
1575         </scalar>
1576         <scalar name="tokens-min">
1577           <description>The minimum amount of tokens required to unhold the context</description>
1578         </scalar>
1579         <scalar name="tokens-max">
1580           <description>The bucket's size</description>
1581         </scalar>
1582         <scalar name="fill-rate">
1583           <description>Amount of tokens to add each <optionref ref="local-interval">interval</optionref></description>
1584         </scalar>
1585         <scalar id="local-interval" name="interval">
1586           <description>The interval between refills of the bucket</description>
1587         </scalar>
1588         <scalar name="priority-bias">
1589           <description>Bias added to priorities calculated within the guest (result is clamped to -20/+19)</description>
1590         </scalar>
1591         <scalar name="fill-rate2">
1592           <description>Amount of tokens to add each <optionref ref="local-interval2">interval2</optionref> when advancing idle time</description>
1593         </scalar>
1594         <scalar id="local-interval2" name="interval2">
1595           <description>The interval between refills of the bucket when advancing idle time</description>
1596         </scalar>
1597         <boolean name="idle-time">
1598           <description>When this file exists, advancing idle time is activated</description>
1599         </boolean>
1600         <scalar id="cpu-id" name="cpu-id">
1601           <description>The CPU to apply these settings to</description>
1602         </scalar>
1603         <scalar name="bucket-id">
1604           <description>The bucket to apply these settings to</description>
1605         </scalar>
1606       </collection>
1607     </collection>
1608
1609     <collection name="spaces" since="0.30.215">
1610       <boolean name="pid">
1611         <description>Enables pid virtualization for this guest</description>
1612       </boolean>
1613       <boolean name="net">
1614         <description>Enable network virtualization for this guest</description>
1615       </boolean>
1616       <scalar name="mask">
1617         <description>Contains a mask of spaces to clone/enter</description>
1618       </scalar>
1619     </collection>
1620
1621     <collection name="ionice" since="0.30.216">
1622       <scalar name="class">
1623         <description>The IO scheduling class to use for this guest (see ionice(1)).</description>
1624       </scalar>
1625       <scalar name="priority">
1626         <description>The IO scheduling priority to use for this guest (see ionice(1)).</description>
1627       </scalar>
1628     </collection>
1629
1630     <collection name="cgroup" use="optional" since="0.30.216" id="guest-cgroup">
1631       <description>
1632 This directory contains cgroup settings to be applied to this guest.
1633 See your kernel documentation for what settings are valid with your
1634 configuration.
1635       </description>
1636       <scalar name="name">
1637         <description>
1638 If this file exists, the guest will be put in a cgroup named after the
1639 contents of this file. The default is to name the cgroup the same thing as the
1640 guest, unless
1641 <optionref ref="global-cgroup-name">.defaults/cgroup/name</optionref> says
1642 otherwise.
1643         </description>
1644       </scalar>
1645     </collection>
1646     <scalar name="nocgroup" since="0.30.216">
1647       <description>
1648 If this file exists,
1649 <optionref ref="global-cgroup">.defaults/cgroup</optionref> will be ignored
1650 for this guest.
1651       </description>
1652     </scalar>
1653   </collection>
1654   </database>