doc/configuration.xml

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