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