doc/configuration.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE database SYSTEM "configuration.dtd" []>
   3 <!-- $Id$ -->
   4
   5 <database xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   6           xsi:noNamespaceSchemaLocation="file:configuration.xsd">
   7
   8   <!-- Global configuration -->
   9   <collection name=".defaults" use="optional">
  10     <collection name="init" type="fixed">
  11       <data name="mtab">
  12         <description>Default mtab file</description>
  13       </data>
  14     </collection>
  15
  16     <link name="vdirbase">
  17       <default>/vservers</default>
  18       <description>A link to the default vserver rootdirectory.</description>
  19     </link>
  20
  21     <link name="cachebase">
  22       <default>/var/cache/vservers</default>
  23       <description>
  24 A link to the directory which will hold cached information about
  25 vservers.
  26       </description>
  27     </link>
  28
  29     <boolean id="global-nonamespace" name="nonamespace">
  30       <description>
  31 Disable namespace usage globally. It can be overridden for a single vserver
  32 by setting the <optionref ref="global-namespace">namespace</optionref> flag
  33 there.
  34
  35 In this mode the <directory>/vservers</directory> directory must have
  36 the 'barrier' attribute. Else, common chroot(2) exploits are possible.
  37       </description>
  38     </boolean>
  39
  40     <boolean id="global-nonamespace-cleanup" name="nonamespace-cleanup">
  41       <description>
  42 Disable namespace cleanup globally. It can be overridden for a single vserver
  43 by setting the <optionref ref="namespace-cleanup">namespace-cleanup</optionref> flag
  44 there.
  45       </description>
  46     </boolean>
  47
  48     <list id="global-namespace-cleanup-skip" name="namespace-cleanup-skip">
  49       <description>
  50 List of paths to skip during namespace cleanup.
  51       </description>
  52     </list>
  53
  54     <link name="run.rev">
  55       <description>
  56 Path of the vserver run reverse directory. This directory contains
  57 symlinks named with XID numbers which point back to the configuration
  58 directory of vservers. Under kernel 2.4 this is required for the XID
  59 to VSERVER mapping; Under kernel 2.6 it is unused.
  60
  61 NOTE: this link exists in 0.30.202+ only; in previous versions it was
  62 a vserver specific setting.
  63       </description>
  64     </link>
  65
  66     <scalar name="shell">
  67       <description>
  68 Contains the pathname of the shell which will be used by the "vserver
  69 ... enter" command. Can be overridden by the
  70 <optionref ref="shell">per-guest shell</optionref>.
  71       </description>
  72     </scalar>
  73
  74     <data name="fstab">
  75       <description>
  76 The default fstab file to put in newly built guests.
  77       </description>
  78     </data>
  79
  80     <boolean name="context.dynamic">
  81       <description>
  82 If this file exists, kernel-side dynamic contexts will be used by the "vserver
  83 ... build" command. Otherwise a context will be generated, based on the
  84 contents of <optionref>context.next</optionref>.
  85       </description>
  86     </boolean>
  87
  88     <scalar id="context.next" name="context.next">
  89       <description>
  90 The context id to use for the next guest created by "vserver ... build".
  91       </description>
  92     </scalar>
  93
  94     <collection name="apps">
  95       <collection name="pkgmgmt">
  96         <link name="base">
  97           <default>/vservers/.pkg</default>
  98         </link>
  99         <data name="apt.conf">
 100           <description>The default apt.conf which is going to be used. It is overridden by
 101 distribution specific configuration file.
 102           </description>
 103         </data>
 104       </collection>
 105
 106       <collection name="debootstrap">
 107         <scalar name="mirror">
 108           <description>
 109 The Debian mirror to use with the <tool>debootstrap</tool> program
 110           </description>
 111         </scalar>
 112         <scalar name="uri">
 113           <description>
 114 When the <tool>debootstrap</tool> package is not installed; fetch it
 115 from this uri and install it at a temporary place.
 116           </description>
 117         </scalar>
 118       </collection>
 119
 120       <collection name="vdevmap">
 121         <collection name="x" type="sybmolic">
 122           <description>'x' is an arbitrary name, replace it with e.g. device names</description>
 123           <boolean name="open">
 124             <description>When this file exists, the device can be opened</description>
 125           </boolean>
 126           <boolean name="create">
 127             <description>When this file exists, the device can be created (if the guest has <optionref ref="bcapabilities">CAP_MKNOD</optionref>)</description>
 128           </boolean>
 129           <boolean id="vdevmap-remap" name="remap">
 130             <description>
 131 When this file exists, <optionref ref="vdevmap-target">target</optionref> will
 132 have to exist as well and opening the device will in fact open the target device
 133             </description>
 134           </boolean>
 135           <scalar name="flags">
 136             <description>This file will let you specify unimplemented flags manually</description>
 137           </scalar>
 138           <scalar name="device">
 139             <description>Contains the name of a device node</description>
 140           </scalar>
 141           <scalar id="vdevmap-target" name="target">
 142             <description>Contains the device node of the target node to open instead of the device when <optionref ref="vdevmap-remap">remap</optionref> is set</description>
 143           </scalar>
 144         </collection>
 145       </collection>
 146
 147       <collection name="vshelper">
 148         <link name="logfile">
 149           <description>
 150 The file where output will be logged to when <tool>vshelper</tool>
 151 is invoked from the kernel. This should point somewhere e.g. into
 152 <directory>/var/log</directory>.
 153           </description>
 154         </link>
 155
 156         <collection name="vshelper-methods">
 157           <program name="handler" type="symbolic">
 158             <description>
 159 See <optionref ref="vshelper-action">vshelper/action</optionref>.
 160             </description>
 161           </program>
 162         </collection>
 163
 164         <boolean name="disabled">
 165           <description>
 166 When existing, the vshelper functionality will be disabled for all
 167 vservers.
 168           </description>
 169         </boolean>
 170
 171         <boolean name="debug">
 172           <description>
 173 When existing, the vshelper execution will be traced.
 174           </description>
 175         </boolean>
 176
 177         <boolean name="warning-disabled">
 178           <description>
 179 When existing, sanity checks for the vshelper functionality will be
 180 skipped.
 181           </description>
 182         </boolean>
 183
 184       </collection>
 185
 186       <collection name="vprocunhide">
 187         <list name="files">
 188           <description>
 189 A list of files which will be made visible by vprocunhide. Wildcards are
 190 allowed and anything ending in '/' will be processed recursively. When this file exists,
 191 it overrides the defaults in SYSDEFAULTDIR/vprocunhide-files. The entries there must be
 192 absolute filenames inclusive the leading '/proc'.
 193           </description>
 194         </list>
 195       </collection>
 196
 197       <collection name="init">
 198         <link name="tty">
 199           <description>
 200 A symlink to the TTY device where input/output will be redirected from/to
 201 at startup via initscript.
 202           </description>
 203         </link>
 204
 205         <hash id="global-environment" name="environment" since="0.30.211">
 206           <description>
 207 The environment to set when starting guests. Contains one VAR=VAL
 208 pair per line.
 209           </description>
 210         </hash>
 211       </collection>
 212
 213       <collection name="vunify">
 214         <list name="exclude">
 215           <description>Static list of excluded files.</description>
 216         </list>
 217
 218         <collection name="hash" since="0.30.205">
 219           <description>
 220 A directory which will be used as the storage place for the
 221 <tool>vhashify</tool> command.
 222           </description>
 223           <link name="id" type="symbolic">
 224             <description>
 225 Points to a directory within the filesystems which are used for the
 226 vservers. There must be not more than one of such a directory per
 227 filesystem.
 228             </description>
 229           </link>
 230
 231           <scalar name="method" since="0.30.299">
 232             <default>SHA1</default>
 233             <description>The used hash method.</description>
 234           </scalar>
 235         </collection>
 236
 237         <boolean name="pkgmgmt-ignore" default="off" since="0.30.205">
 238           <description>
 239 When existing, information from packagemanagement will not be used to
 240 create dynamic exclude-lists.
 241           </description>
 242         </boolean>
 243
 244         <boolean name="pgkmgmt-force" default="off" since="0.30.205">
 245           <description>
 246 When existing, information from packagemanagement will be used to
 247 create dynamic exclude-lists. This option requires that (a known)
 248 packagemanagement is configured for the vserver; else the requested
 249 operation will fail. Most tools assume 'on' as the default value.
 250           </description>
 251         </boolean>
 252
 253       </collection>
 254
 255       <collection name="vlogin">
 256         <boolean id="vlogin-disable" name="disable" since="0.30.212">
 257           <description>
 258 When this file exists, vlogin isn't used on vserver &lt;guest&gt; enter.
 259           </description>
 260         </boolean>
 261       </collection>
 262
 263       <collection name="build">
 264         <list name="options">
 265           <description>
 266 A list of default options to supply to vserver ... build, one option per line.
 267           </description>
 268         </list>
 269       </collection>
 270     </collection>
 271
 272     <collection name="interfaces" use="optional">
 273       <boolean id="global-vlandev" name="vlandev" since="0.30.211">
 274         <description>
 275 When this file exists, the steps which setup and destroy a VLAN
 276 interface will be executed.
 277         </description>
 278       </boolean>
 279     </collection>
 280
 281     <collection name="files">
 282       <description>This directory contains some files which will be copied to the guests during build.</description>
 283       <data name="hosts">
 284         <description>The default /etc/hosts file.</description>
 285       </data>
 286       <data name="nsswitch.conf">
 287         <description>The default /etc/nsswitch.conf file.</description>
 288       </data>
 289       <data name="krb5.conf">
 290         <description>The default /etc/krb5.conf file.</description>
 291       </data>
 292       <data name="krb.conf">
 293         <description>The default /etc/krb.conf file.</description>
 294       </data>
 295       <data name="krb.realms">
 296         <description>The default /etc/krb.realms file.</description>
 297       </data>
 298       <data name="ldap.conf">
 299         <description>The default /etc/ldap.conf file.</description>
 300       </data>
 301       <data name="localtime">
 302         <description>The default /etc/localtime file.</description>
 303       </data>
 304       <data name="resolv.conf">
 305         <description>The default /etc/resolv.conf file.</description>
 306       </data>
 307     </collection>
 308
 309     <collection name="cgroup" use="optional" since="0.30.216" id="global-cgroup">
 310       <description>
 311 This directory contains cgroup settings which should be applied to all guests.
 312 See your kernel documentation for what settings are valid with your
 313 configuration.
 314       </description>
 315       <scalar name="mnt">
 316         <description>
 317 The directory to mount the cgroup hierarchy at. The default is /dev/cgroup.
 318         </description>
 319       </scalar>
 320       <scalar name="subsys">
 321         <description>
 322 Comma-separated list of subsystems to enable on the cgroup mount point.
 323 The default is "all".
 324         </description>
 325       </scalar>
 326       <list name="inherit">
 327         <description>
 328 Some subsystems start out with clean slates, making it impossible to use the
 329 cgroup before certain things have been set. This is true for e.g. the cpuset
 330 subsystem. This file contains a list of filenames which should be explicitly
 331 inherited from the parent (root) cgroup, if not overridden elsewhere.
 332 The default is cpuset.cpus and cpuset.mems.
 333         </description>
 334       </list>
 335       <scalar name="name" id="global-cgroup-name">
 336         <description>
 337 If this file exists, all guests will be put in one cgroup named after the
 338 contents of this file. The default is to put each guest in a cgroup named the
 339 same thing as the guest.
 340         </description>
 341       </scalar>
 342     </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="flags">
 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       <!--
 626       <elements>
 627         <element name="fakeinit">
 628           <description>
 629 The new process will believe it is process number 1. Useful to run a
 630 real /sbin/init in a vserver. Warning: this flag should not be used
 631 unless you know what you are doing. Often, it is better to use the
 632 'plain' initstyle.
 633           </description>
 634         </element>
 635         <element name="lock">
 636           <description>
 637 The new process is trapped and can't use chcontext anymore.
 638           </description>
 639         </element>
 640         <element name="sched">
 641           <description>
 642 The new process and its children will share a common
 643           </description>
 644         </element>
 645         <element name="nproc">
 646           <description>
 647 Limit the number of process in the vserver according to
 648 ulimit setting. Normally, ulimit is a per user thing.
 649 With this flag, it becomes a per vserver thing.
 650           </description>
 651         </element>
 652         <element name="private">
 653           <description>
 654 No one can join this security context once created.
 655           </description>
 656         </element>
 657         <element name="ulimit">
 658           <description>
 659 Apply the current ulimit to the whole context
 660           </description>
 661         </element>
 662       </elements>
 663       -->
 664     </list>
 665     <list name="nflags" since="0.30.212">
 666       <description>
 667 Contains a network flag per line. See <ulink
 668 url="http://svn.linux-vserver.org/svn/util-vserver/trunk/lib/nflags-net.c">lib/nflags-net.c</ulink>
 669 for possible values.
 670       </description>
 671     </list>
 672     <scalar name="context">
 673       <description>
 674 Contains the context id which shall be used for the vserver. Valid range is 2 through 49151.
 675         </description>
 676     </scalar>
 677     <scalar name="ncontext">
 678       <description>
 679 Contains the network context id which shall be used for the vserver. Valid range is 2 through 49151.
 680       </description>
 681     </scalar>
 682     <scalar name="tag">
 683       <description>
 684 Contains the filesystem tag which shall be used for the vserver. Valid range is 2 through 49151.
 685       </description>
 686     </scalar>
 687     <data id="fstab" name="fstab">
 688       <description>
 689 The fstab file for the vserver. Entries in this file will be mounted
 690 within the network context of the host. Use the
 691 <optionref>fstab.remote</optionref> file when you want that the
 692 mounting happens in the network context of the vserver. In most cases
 693 the 'fstab' file should be used.
 694       </description>
 695     </data>
 696     <data id="fstab.remote" name="fstab.remote">
 697       <description>
 698 The fstab file for the vserver. Entries in this file will be mounted
 699 within the network context of the guest; this means that mount will be
 700 called as <command>chbind &lt;options&gt; mount ...</command>. See
 701 <optionref>fstab</optionref> also.
 702       </description>
 703     </data>
 704     <scalar name="badness">
 705       <description>
 706 Contains the bias to be applied to processes in this guest when the OOM-killer strikes.
 707       </description>
 708     </scalar>
 709
 710     <collection name="apps">
 711       <collection name="init">
 712         <data name="mtab">
 713           <description>
 714 The initial-mtab which will be used for the vserver.
 715           </description>
 716         </data>
 717
 718         <scalar name="style">
 719           <description>
 720 Contains the init-style.
 721           </description>
 722           <restriction>
 723             <enumeration value="sysv"/>
 724             <enumeration value="plain"/>
 725             <enumeration value="minit"/>
 726           </restriction>
 727         </scalar>
 728
 729         <scalar name="runlevel">
 730           <description>The start runlevel.</description>
 731         </scalar>
 732
 733         <scalar name="runlevel.start">
 734           <description>The start runlevel.</description>
 735         </scalar>
 736
 737         <scalar name="runlevel.stop">
 738           <description>The stop runlevel.</description>
 739         </scalar>
 740
 741         <scalar name="killseq">
 742           <description>
 743 Contains the 'signal [wait signal]*' sequence which is used to stop
 744 the vserver.
 745           </description>
 746         </scalar>
 747
 748         <list name="cmd.start">
 749           <description>
 750 The command which is used to start the vserver. Each option must be on
 751 a separate line.
 752           </description>
 753         </list>
 754
 755         <list name="cmd.start-sync">
 756           <description>
 757 The command which is used to wait on the vserver after it has been
 758 started. Each option must be on a separate line. This file will be
 759 ignored when the <optionref>sync</optionref> flag does not exist and the
 760 '--sync' option was not used.
 761           </description>
 762         </list>
 763
 764         <list name="cmd.stop">
 765           <description>
 766 The command which is used to stop the vserver. Each option must be on
 767 a separate line.
 768           </description>
 769         </list>
 770
 771         <list name="cmd.stop-sync">
 772           <description>
 773 The command which is used to wait on the vserver after it has been
 774 stopped. Each option must be on a separate line. This file will be
 775 ignored when the <optionref>sync</optionref> flag does not exist and the
 776 '--sync' option was not used.
 777           </description>
 778         </list>
 779
 780         <list name="cmd.prepare">
 781           <description>
 782 The command which is used to setup the init-system (e.g. to set the
 783 runlevel in the utmp-file). Each option must be on a separate line.
 784           </description>
 785         </list>
 786
 787         <boolean id="sync" name="sync">
 788           <description>
 789 If this file is not present, all 'cmd.*-sync files will be ignored.
 790             </description>
 791         </boolean>
 792
 793         <link name="tty">
 794           <description>
 795 A symlink to the TTY device where input/output will be redirected
 796 from/to at startup via initscript.
 797           </description>
 798         </link>
 799
 800         <scalar name="mark">
 801           <description>
 802 This file is used to mark group of vservers which shall be started/stopped
 803 together by the initscript. Content is a simple string like 'default'.
 804           </description>
 805         </scalar>
 806
 807         <list name="depends">
 808           <description>
 809 This file is used to configure vservers which must be running before
 810 the current vserver can be started. At shutdown, the current vserver
 811 will be stopped before its dependencies. Content of this file are
 812 vserver ids (one name per line).
 813           </description>
 814         </list>
 815
 816         <hash name="environment" since="0.30.211">
 817           <description>
 818 The environment to set when starting the guest. Contains one VAR=VAL
 819 pair per line.
 820           </description>
 821         </hash>
 822       </collection>
 823
 824       <collection name="vdevmap">
 825         <collection name="x" type="sybmolic">
 826           <description>'x' is an arbitrary name, replace it with e.g. device names</description>
 827           <boolean name="open">
 828             <description>When this file exists, the device can be opened</description>
 829           </boolean>
 830           <boolean name="create">
 831             <description>When this file exists, the device can be created (if the guest has <optionref ref="bcapabilities">CAP_MKNOD</optionref>)</description>
 832           </boolean>
 833           <boolean id="guest-vdevmap-remap" name="remap">
 834             <description>
 835 When this file exists, <optionref ref="guest-vdevmap-target">target</optionref> will
 836 have to exist as well and opening the device will in fact open the target device
 837             </description>
 838           </boolean>
 839           <scalar name="flags">
 840             <description>This file will let you specify unimplemented flags manually</description>
 841           </scalar>
 842           <scalar name="device">
 843             <description>Contains the name of a device node</description>
 844           </scalar>
 845           <scalar id="guest-vdevmap-target" name="target">
 846             <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>
 847           </scalar>
 848         </collection>
 849       </collection>
 850
 851       <collection name="vshelper">
 852         <scalar name="sync-timeout">
 853           <default>30</default>
 854           <description>
 855 The timeout in seconds which is used when synchronising vserver
 856 startup/shutdown with the vshelper. When not set, 30 seconds will be
 857 assumed.
 858           </description>
 859         </scalar>
 860
 861         <scalar id="vshelper-action" name="action">
 862           <default>restart</default>
 863           <description>
 864 The action which is going to be executed when a vshelper event
 865 occurs. The default value is 'restart', but there can be defined own
 866 methods by placing scripts into the
 867 <optionref>vshelper-methods</optionref> directories. These scripts are
 868 fed with the same arguments as the <tool>vshelper</tool> script.
 869           </description>
 870         </scalar>
 871
 872         <program name="event" type="symbolic">
 873           <description>
 874 When existing, these scripts will be executed *instead* of the default
 875 handler defined in 'action'. Their name must match the event which caused
 876 the execution of <tool>vshelper</tool>; e.g. 'restart' or 'poweroff'. See
 877 the vs_reboot() function in the kernel for more details.
 878           </description>
 879           <parameterList>
 880             <parameter name="xid">
 881               <description>
 882 The xid of the context calling the vshelper
 883               </description>
 884             </parameter>
 885             <parameter name="event">
 886               <description>
 887 The reboot-event.
 888               </description>
 889             </parameter>
 890           </parameterList>
 891         </program>
 892
 893         <boolean name="disabled">
 894           <description>
 895 When existing, the vshelper functionality will be disabled for this
 896 vserver.
 897           </description>
 898         </boolean>
 899
 900         <boolean name="debug">
 901           <description>
 902 When existing, the vshelper execution will be traced for this vserver.
 903           </description>
 904         </boolean>
 905
 906         <boolean name="warning-disabled">
 907           <description>
 908 When existing, sanity checks for the vshelper functionality will be
 909 skipped.
 910           </description>
 911         </boolean>
 912
 913       </collection>
 914
 915       <collection id="vshelper-methods" name="vshelper-methods">
 916         <program name="handler" type="symbolic">
 917           <description>
 918 See <optionref ref="vshelper-action">vshelper/action</optionref>.
 919           </description>
 920         </program>
 921       </collection>
 922
 923       <collection name="vunify">
 924         <description>
 925 This directory contains configuration data required for vserver
 926 unification.
 927         </description>
 928
 929         <list name="exclude">
 930           <description>
 931 <p>Static list of files which are excluded for unification. This list
 932 supports an rsync-like syntax: when a file is prefixed by '+', it is a
 933 candidate for unification; when there is no prefix or a '-' or a '~' it
 934 will be excluded. Shell-wildcards are allowed for the filenames.</p>
 935 <p>When used with <tool>vcopy</tool>, the '~' prefix prevents copying
 936 of the file entirely (e.g. for keyfiles). With this tool, the file will
 937 be copied instead of hardlinked when the '-' prefix is used.</p>
 938           </description>
 939         </list>
 940
 941         <link name="refserver.X" type="symbolic">
 942           <description>
 943 These are symlinks to the configuration directory
 944 (e.g. CONFDIR/vservers/&lt;id&gt;) of a refserver. There may be
 945 multiple such symlinks but they must be prefixed by 'refserver.' and
 946 will be processed in alphanumerical order.
 947           </description>
 948         </link>
 949
 950         <collection name="hash" since="0.30.205">
 951           <description>
 952 A directory which will be used as the storage place for the
 953 <tool>vhashify</tool> command.
 954           </description>
 955           <link name="id" type="symbolic">
 956             <description>
 957 Points to a directory within the filesystems which are used for the
 958 vservers. There must be not more than one of such a directory per
 959 filesystem.
 960             </description>
 961           </link>
 962
 963           <scalar name="method"  since="0.30.299">
 964             <default>SHA1</default>
 965             <description>The used hash method.</description>
 966           </scalar>
 967         </collection>
 968
 969         <boolean name="pkgmgmt-ignore" default="off" since="0.30.205">
 970           <description>
 971 When existing, information from packagemanagement will not be used to
 972 create dynamic exclude-lists.
 973           </description>
 974         </boolean>
 975
 976         <boolean name="pgkmgmt-force" default="off" since="0.30.205">
 977           <description>
 978 When existing, information from packagemanagement will be used to
 979 create dynamic exclude-lists. This option requires that (a known)
 980 packagemanagement is configured for the vserver; else the requested
 981 operation will fail. Most tools assume 'on' as the default value.
 982           </description>
 983         </boolean>
 984
 985       </collection>
 986     </collection>
 987
 988     <collection name="scripts">
 989       <description>
 990 A directory for scripts. By default, when one of these scripts will be
 991 executed, the execution of defaultscripts (within .../.defaults/scripts)
 992 will be skipped. To execute them nevertheless, the $DONT_SKIP_DEFAULTS
 993 environment variable must be set by one of the in-shellcontext scripts
 994 (the non-executable ones).
 995       </description>
 996
 997       <program name="initialize" since="0.30.211">
 998         <description>
 999 The scriptlet which will be executed before the root filesystem is mounted and
1000 the configuration has been loaded. Before executing the script, the
1001 configuration directory will be made the working directory.
1002         </description>
1003         <parameterList>
1004           <parameter name="action">
1005             <description>
1006 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1007             </description>
1008           </parameter>
1009           <parameter name="vserver-name">
1010             <description>
1011 The name of the current vserver.
1012             </description>
1013           </parameter>
1014         </parameterList>
1015       </program>
1016       <collection name="initialize.d" since="0.30.211">
1017         <description>
1018 Repository of initialize like scripts.  Before executing the script,
1019 the configuration directory will be made the working directory.
1020         </description>
1021         <program name="script" type="symbolic">
1022           <description>See initialize.</description>
1023           <parameterList>
1024             <parameter name="action">
1025               <description>
1026 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1027               </description>
1028             </parameter>
1029             <parameter name="vserver-name">
1030               <description>
1031 The name of the current vserver.
1032               </description>
1033             </parameter>
1034           </parameterList>
1035         </program>
1036       </collection>
1037
1038       <program name="prepre-start">
1039         <description>
1040 The scriptlet which will be executed before the network-interfaces are
1041 enabled and the directories are mounted. Before executing the script,
1042 the configuration directory will be made the working directory.
1043         </description>
1044         <parameterList>
1045           <parameter name="action">
1046             <description>
1047 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1048             </description>
1049           </parameter>
1050           <parameter name="vserver-name">
1051             <description>
1052 The name of the current vserver.
1053             </description>
1054           </parameter>
1055         </parameterList>
1056       </program>
1057       <collection name="prepre-start.d">
1058         <description>
1059 Repository of prepre-start like scripts.  Before executing the script,
1060 the configuration directory will be made the working directory.
1061         </description>
1062         <program name="script" type="symbolic">
1063           <description>See prepre-start.</description>
1064           <parameterList>
1065             <parameter name="action">
1066               <description>
1067 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1068               </description>
1069             </parameter>
1070             <parameter name="vserver-name">
1071               <description>
1072 The name of the current vserver.
1073               </description>
1074             </parameter>
1075           </parameterList>
1076         </program>
1077       </collection>
1078
1079       <program name="pre-start">
1080         <description>
1081 The scriptlet which will be executed after network-interfaces were
1082 enabled and the directories mounted, but before the vserver itself has
1083 been started.  Before executing the script, the vserver root directory
1084 will be made the working directory.
1085         </description>
1086         <parameterList>
1087           <parameter name="action">
1088             <description>
1089 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1090             </description>
1091           </parameter>
1092           <parameter name="vserver-name">
1093             <description>
1094 The name of the current vserver.
1095             </description>
1096           </parameter>
1097         </parameterList>
1098       </program>
1099       <collection name="pre-start.d">
1100         <description>
1101 Repository of pre-start like scripts. Before executing these scripts,
1102 the vserver root directory will be made the working directory.
1103         </description>
1104         <program name="script" type="symbolic">
1105           <description>See pre-start.</description>
1106           <parameterList>
1107             <parameter name="action">
1108               <description>
1109 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1110               </description>
1111             </parameter>
1112             <parameter name="vserver-name">
1113               <description>
1114 The name of the current vserver.
1115               </description>
1116             </parameter>
1117           </parameterList>
1118         </program>
1119       </collection>
1120
1121
1122       <program name="post-start">
1123         <description>
1124 The scriptlet which will be executed after the vserver has been
1125 started. Before executing the script, the vserver root directory
1126 will be made the working directory.
1127         </description>
1128         <parameterList>
1129           <parameter name="action">
1130             <description>
1131 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1132             </description>
1133           </parameter>
1134           <parameter name="vserver-name">
1135             <description>
1136 The name of the current vserver.
1137             </description>
1138           </parameter>
1139         </parameterList>
1140       </program>
1141       <collection name="post-start.d">
1142         <description>
1143 Repository of post-start like scripts. Before executing these scripts,
1144 the vserver root directory will be made the working directory.
1145         </description>
1146         <program name="script" type="symbolic">
1147           <description>See post-start.</description>
1148           <parameterList>
1149             <parameter name="action">
1150               <description>
1151 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1152               </description>
1153             </parameter>
1154             <parameter name="vserver-name">
1155               <description>
1156 The name of the current vserver.
1157               </description>
1158             </parameter>
1159           </parameterList>
1160         </program>
1161       </collection>
1162
1163
1164       <program name="pre-stop">
1165         <description>
1166 The scriptlet which will be executed before the vserver will be
1167 stopped. Before executing the script, the vserver root directory
1168 will be made the working directory.
1169         </description>
1170         <parameterList>
1171           <parameter name="action">
1172             <description>
1173 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1174             </description>
1175           </parameter>
1176           <parameter name="vserver-name">
1177             <description>
1178 The name of the current vserver.
1179             </description>
1180           </parameter>
1181         </parameterList>
1182       </program>
1183       <collection name="pre-stop.d">
1184         <description>
1185 Repository of pre-stop like scripts. Before executing the script, the
1186 vserver root directory will be made the working directory.
1187         </description>
1188         <program name="script" type="symbolic">
1189           <description>See pre-stop.</description>
1190           <parameterList>
1191             <parameter name="action">
1192               <description>
1193 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1194               </description>
1195             </parameter>
1196             <parameter name="vserver-name">
1197               <description>
1198 The name of the current vserver.
1199               </description>
1200             </parameter>
1201           </parameterList>
1202         </program>
1203       </collection>
1204
1205       <program name="post-stop">
1206         <description>
1207 The scriptlet which will be executed after the vserver has been
1208 stopped, but before the directories will be umounted and the the
1209 interfaces disabled. Before executing the script, the vserver root
1210 directory will be made the working directory.
1211         </description>
1212         <parameterList>
1213           <parameter name="action">
1214             <description>
1215 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1216             </description>
1217           </parameter>
1218           <parameter name="vserver-name">
1219             <description>
1220 The name of the current vserver.
1221             </description>
1222           </parameter>
1223         </parameterList>
1224       </program>
1225       <collection name="post-stop.d">
1226         <description>
1227 Repository of post-stop like scripts. Before executing the script, the
1228 vserver root directory will be made the working directory.
1229         </description>
1230         <program name="script" type="symbolic">
1231           <description>See post-stop.</description>
1232           <parameterList>
1233             <parameter name="action">
1234               <description>
1235 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1236               </description>
1237             </parameter>
1238             <parameter name="vserver-name">
1239               <description>
1240 The name of the current vserver.
1241               </description>
1242             </parameter>
1243           </parameterList>
1244         </program>
1245       </collection>
1246
1247       <program name="postpost-stop">
1248         <description>
1249 The scriptlet which will be executed after the vserver has been stopped
1250 completely. Before executing the script, the vserver root directory
1251 will be made the working directory.
1252         </description>
1253         <parameterList>
1254           <parameter name="action">
1255             <description>
1256 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1257             </description>
1258           </parameter>
1259           <parameter name="vserver-name">
1260             <description>
1261 The name of the current vserver.
1262             </description>
1263           </parameter>
1264         </parameterList>
1265       </program>
1266       <collection name="postpost-stop.d">
1267         <description>
1268 Repository of postpost-stop like scripts. Before executing the script,
1269 the vserver root directory will be made the working directory.
1270         </description>
1271         <program name="script" type="symbolic">
1272           <description>See postpost-stop.</description>
1273           <parameterList>
1274             <parameter name="action">
1275               <description>
1276 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1277               </description>
1278             </parameter>
1279             <parameter name="vserver-name">
1280               <description>
1281 The name of the current vserver.
1282               </description>
1283             </parameter>
1284           </parameterList>
1285         </program>
1286       </collection>
1287     </collection>
1288
1289     <collection name="interfaces">
1290       <scalar name="bcast">
1291         <description>The guest's broadcast address.</description>
1292       </scalar>
1293       <scalar name="lback">
1294         <description>The guest's loopback address.</description>
1295       </scalar>
1296       <scalar name="dev">
1297         <description>The default network device. See <optionref ref="per-if-dev">iface/dev</optionref> for more information.</description>
1298       </scalar>
1299       <scalar name="prefix">
1300         <description>The default network prefix-length.</description>
1301       </scalar>
1302       <scalar name="mask">
1303         <description>The default network mask.</description>
1304       </scalar>
1305       <scalar name="scope">
1306         <description>The default scope of the network interfaces.</description>
1307       </scalar>
1308       <boolean id="local-vlandev" name="vlandev" since="0.30.211">
1309         <description>
1310 When this file exists, the steps which setup and destroy a VLAN
1311 interface will be executed for all interfaces of this vserver.
1312         </description>
1313       </boolean>
1314       <boolean id="local-novlandev" name="novlandev">
1315         <description>
1316 When this file exists, the steps which setup and destroy a VLAN
1317 interface will be skipped. This overrides the global
1318 <optionref ref="global-vlandev">vlandev</optionref> setting for
1319 this vserver.
1320         </description>
1321       </boolean>
1322
1323       <collection name="iface" type="symbolic">
1324         <description>
1325 'iface' is an arbitrary name for the interface; the value itself is
1326 not important but may be interesting regarding interface-creation and
1327 usage with <tool>chbind</tool>. Both happens in alphabetical order and
1328 numbers like '00' are good names for these directories.
1329         </description>
1330
1331         <boolean name="disabled">
1332           <description>When this file exists, this interface will be ignored.</description>
1333         </boolean>
1334
1335         <scalar name="ip">
1336           <description>The IP address which will be assigned to this interface.</description>
1337         </scalar>
1338         <scalar name="dev" id="per-if-dev">
1339           <description>The network device. When this is specified, the IP address will be assigned and removed when starting and stopping the guest.</description>
1340         </scalar>
1341         <scalar name="prefix">
1342           <description>The network prefix-length.</description>
1343         </scalar>
1344         <scalar name="mask">
1345           <description>The network mask.</description>
1346         </scalar>
1347         <scalar name="scope">
1348           <description>The scope of the network interface.</description>
1349         </scalar>
1350         <scalar name="name">
1351           <description>
1352 When this file exists, the interface will be named with the text in
1353 this file. Without such an entry, the IP will not be shown by
1354 <tool>ifconfig</tool> but by <command>ip addr ls</command> only.  Such
1355 a labeled interface is known as an "alias" also (e.g. 'eth0:foo').
1356           </description>
1357         </scalar>
1358         <boolean name="nodev">
1359           <description>
1360 When this file exists, the interface will be assumed to exist
1361 already. This can be used to assign primary interfaces which are
1362 created by the host or another vserver.
1363           </description>
1364         </boolean>
1365         <boolean name="novlandev">
1366           <description>
1367 When this file exists, the steps which setup and destroy a VLAN
1368 interface will be skipped. This will override the global
1369 <optionref ref="global-vlandev">vlandev</optionref> and the per-guest
1370 <optionref ref="local-vlandev">vlandev</optionref>.
1371           </description>
1372         </boolean>
1373         <boolean name="vlandev" since="0.30.211">
1374           <description>
1375 When this file exists, the steps which setup and destroy a VLAN
1376 interface will be executed.
1377           </description>
1378         </boolean>
1379         <boolean name="tun" since="0.30.215">
1380           <description>
1381 When this file exists, a tun interface will be created when the guest
1382 starts, and removed when the guest stops.
1383           </description>
1384         </boolean>
1385         <boolean name="tap" since="0.30.215">
1386           <description>
1387 When this file exists, a tap interface will be created when the guest
1388 starts, and removed when the guest stops.
1389           </description>
1390         </boolean>
1391         <boolean name="nocsum" since="0.30.215">
1392           <description>
1393 If a tun or tap interface is created, the presence of this file will
1394 disable checksumming on it.
1395           </description>
1396         </boolean>
1397         <boolean name="shared" since="0.30.215">
1398           <description>
1399 When this file exists, the tun/tap interface created will not be
1400 owned by this particular guest.
1401           </description>
1402         </boolean>
1403         <scalar name="uid" since="0.30.215">
1404           <description>
1405 Sets the ownership of tun/tap interfaces. Requires a user id, not a
1406 username.
1407           </description>
1408         </scalar>
1409         <scalar name="gid" since="0.30.215">
1410           <description>
1411 Sets the group ownership of tun/tap interfaces. Requires a group id,
1412 not a group name.
1413           </description>
1414         </scalar>
1415         <scalar name="linktype" since="0.30.215">
1416           <description>
1417 Sets the link type of tun/tap interfaces.
1418           </description>
1419         </scalar>
1420         <scalar name="peer" since="0.30.216">
1421           <description>
1422 Sets the peer for a point-to-point link, such as a tun interface.
1423           </description>
1424         </scalar>
1425       </collection>
1426     </collection>
1427
1428     <collection name="ulimits">
1429       <description>
1430 A directory with ulimits. Possible resources are cpu, data, fsize,
1431 locks, memlock, nofile, nproc, rss and/or stack.
1432       </description>
1433       <scalar name="resource" type="symbolic">
1434         <description>
1435 A file which contains the hard- and soft-limit of the given resource
1436 in the first line. The special keyword 'inf' is recognized.
1437         </description>
1438       </scalar>
1439       <scalar name="resource.hard" type="symbolic">
1440         <description>
1441 A file which contains the hard-limit of the given resource in the first
1442 line. The special keyword 'inf' is recognized.
1443         </description>
1444       </scalar>
1445       <scalar name="resource.soft" type="symbolic">
1446         <description>
1447 A file which contains the soft-limit of the given resource in the first
1448 line. The special keyword 'inf' is recognized.
1449         </description>
1450       </scalar>
1451     </collection>
1452
1453     <collection name="rlimits">
1454       <description>
1455 A directory with resource limits. Possible resources are cpu, fsize,
1456 data, stack, core, rss, nproc, nofile, memlock, as, locks, msgqueue,
1457 nsock, openfd, anon, shmem, semary, nsems and dentry. This
1458 configuration will be honored for kernel 2.6 only.
1459       </description>
1460       <scalar name="resource" type="symbolic">
1461         <description>
1462 A file which contains the hard- and soft-limit of the given resource
1463 in the first line. The special keyword 'inf' is recognized.
1464         </description>
1465       </scalar>
1466       <scalar name="resource.hard" type="symbolic">
1467         <description>
1468 A file which contains the hard-limit of the given resource in the first
1469 line. The special keyword 'inf' is recognized.
1470         </description>
1471       </scalar>
1472       <scalar name="resource.soft" type="symbolic">
1473         <description>
1474 A file which contains the soft-limit of the given resource in the first
1475 line. The special keyword 'inf' is recognized.
1476         </description>
1477       </scalar>
1478       <scalar name="resource.min" type="symbolic">
1479         <description>
1480 A file which contains the guaranteed minimum of the given resource in
1481 the first line. The special keyword 'inf' is recognized.
1482         </description>
1483       </scalar>
1484     </collection>
1485
1486     <collection name="uts">
1487       <scalar name="context">
1488         <description>
1489 The context-name of the vserver. This file is listed for completeness
1490 only; the 'context' name is used and set internally by the util-vserver
1491 tools and can *not* be modified.
1492         </description>
1493       </scalar>
1494       <scalar name="sysname">
1495         <description>The sysname of the vserver</description>
1496       </scalar>
1497       <scalar name="nodename">
1498         <description>The node-/hostname of the vserver</description>
1499       </scalar>
1500       <scalar name="release">
1501         <description>The OS-release of the vserver</description>
1502       </scalar>
1503       <scalar name="version">
1504         <description>The OS-version of the vserver</description>
1505       </scalar>
1506       <scalar name="machine">
1507         <description>The machine-type of the vserver</description>
1508       </scalar>
1509       <scalar name="domainname">
1510         <description>The NIS domainname of the vserver</description>
1511       </scalar>
1512     </collection>
1513
1514     <collection name="dlimits" since="0.30.210">
1515       <description>
1516 Note that all entries are required for the disk limit to be applied.
1517       </description>
1518       <collection name="x" type="symbolic">
1519         <description>'x' is an arbitrary name, replace it with e.g. integers</description>
1520         <scalar name="directory">
1521           <description>The directory to which the limit should be applied</description>
1522         </scalar>
1523         <scalar name="inodes_total">
1524           <description>The amount of inodes this vserver should be limited to</description>
1525         </scalar>
1526         <scalar name="space_total">
1527           <description>The amount of space this vserver should be limited to (measured in blocks of 1024 bytes)</description>
1528         </scalar>
1529         <scalar name="reserved">
1530           <description>How much space (percentage-wise) should be reserved for the root user</description>
1531         </scalar>
1532       </collection>
1533     </collection>
1534
1535     <collection name="sysctl" since="0.30.213">
1536       <collection name="x" type="symbolic">
1537         <description>'x' is an arbitrary name, replace it with e.g. integers</description>
1538         <scalar name="setting">
1539           <description>The sysctl setting</description>
1540         </scalar>
1541         <scalar name="value">
1542           <description>The value</description>
1543         </scalar>
1544       </collection>
1545     </collection>
1546
1547     <collection name="cpuset" since="0.30.211">
1548       <description>
1549 Puts the guest in a cpuset. Required entries are name, cpus and mems.
1550       </description>
1551       <scalar name="name">
1552         <description>The name of the cpuset for this vserver</description>
1553       </scalar>
1554       <scalar name="cpus">
1555         <description>The list of CPUs in this cpuset</description>
1556       </scalar>
1557       <scalar name="mems">
1558         <description>The list of Memory Nodes in this cpuset</description>
1559       </scalar>
1560       <scalar name="cpu_exclusive">
1561         <description>Is the CPU assignment exclusive?</description>
1562       </scalar>
1563       <scalar name="mems_exclusive">
1564         <description>Is the memory node assignment exclusive?</description>
1565       </scalar>
1566       <scalar name="nocreate">
1567         <description>When this file exists, the cpuset will be assumed to exist already</description>
1568       </scalar>
1569     </collection>
1570
1571     <collection id="sched" name="sched" since="0.30.212">
1572       <scalar id="global-tokens" name="tokens">
1573         <description>The initial amount of tokens to put in the bucket</description>
1574       </scalar>
1575       <scalar id="global-tokens-min" name="tokens-min">
1576         <description>The minimum amount of tokens required to unhold the context</description>
1577       </scalar>
1578       <scalar id="global-tokens-max" name="tokens-max">
1579         <description>The bucket's size</description>
1580       </scalar>
1581       <scalar id="global-fill-rate" name="fill-rate">
1582         <description>Amount of tokens to add each <optionref ref="global-interval">interval</optionref></description>
1583       </scalar>
1584       <scalar id="global-interval" name="interval">
1585         <description>The interval between refills of the bucket</description>
1586       </scalar>
1587       <scalar id="global-priority-bias" name="priority-bias">
1588         <description>Bias added to priorities calculated within the guest (result is clamped to -20/+19)</description>
1589       </scalar>
1590       <scalar id="global-fill-rate2" name="fill-rate2">
1591         <description>Amount of tokens to add each <optionref ref="global-interval2">interval2</optionref> when advancing idle time</description>
1592       </scalar>
1593       <scalar id="global-interval2" name="interval2">
1594         <description>The interval between refills of the bucket when advancing idle time</description>
1595       </scalar>
1596       <boolean id="global-idle-time" name="idle-time">
1597         <description>When this file exists, advancing idle time is activated</description>
1598       </boolean>
1599       <collection name="cpu-id" type="symbolic">
1600         <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>
1601         <scalar name="tokens">
1602           <description>The initial amount of tokens to put in the bucket</description>
1603         </scalar>
1604         <scalar name="tokens-min">
1605           <description>The minimum amount of tokens required to unhold the context</description>
1606         </scalar>
1607         <scalar name="tokens-max">
1608           <description>The bucket's size</description>
1609         </scalar>
1610         <scalar name="fill-rate">
1611           <description>Amount of tokens to add each <optionref ref="local-interval">interval</optionref></description>
1612         </scalar>
1613         <scalar id="local-interval" name="interval">
1614           <description>The interval between refills of the bucket</description>
1615         </scalar>
1616         <scalar name="priority-bias">
1617           <description>Bias added to priorities calculated within the guest (result is clamped to -20/+19)</description>
1618         </scalar>
1619         <scalar name="fill-rate2">
1620           <description>Amount of tokens to add each <optionref ref="local-interval2">interval2</optionref> when advancing idle time</description>
1621         </scalar>
1622         <scalar id="local-interval2" name="interval2">
1623           <description>The interval between refills of the bucket when advancing idle time</description>
1624         </scalar>
1625         <boolean name="idle-time">
1626           <description>When this file exists, advancing idle time is activated</description>
1627         </boolean>
1628         <scalar id="cpu-id" name="cpu-id">
1629           <description>The CPU to apply these settings to</description>
1630         </scalar>
1631         <scalar name="bucket-id">
1632           <description>The bucket to apply these settings to</description>
1633         </scalar>
1634       </collection>
1635     </collection>
1636
1637     <collection name="spaces" since="0.30.215">
1638       <boolean name="pid">
1639         <description>Enables pid virtualization for this guest</description>
1640       </boolean>
1641       <boolean name="net">
1642         <description>Enable network virtualization for this guest</description>
1643       </boolean>
1644       <scalar name="mask">
1645         <description>Contains a mask of spaces to clone/enter</description>
1646       </scalar>
1647     </collection>
1648
1649     <collection name="ionice" since="0.30.216">
1650       <scalar name="class">
1651         <description>The IO scheduling class to use for this guest (see ionice(1)).</description>
1652       </scalar>
1653       <scalar name="priority">
1654         <description>The IO scheduling priority to use for this guest (see ionice(1)).</description>
1655       </scalar>
1656     </collection>
1657
1658     <collection name="cgroup" use="optional" since="0.30.216" id="guest-cgroup">
1659       <description>
1660 This directory contains cgroup settings to be applied to this guest.
1661 See your kernel documentation for what settings are valid with your
1662 configuration.
1663       </description>
1664       <scalar name="name">
1665         <description>
1666 If this file exists, the guest will be put in a cgroup named after the
1667 contents of this file. The default is to name the cgroup the same thing as the
1668 guest, unless
1669 <optionref ref="global-cgroup-name">.defaults/cgroup/name</optionref> says
1670 otherwise.
1671         </description>
1672       </scalar>
1673     </collection>
1674     <scalar name="nocgroup" since="0.30.216">
1675       <description>
1676 If this file exists,
1677 <optionref ref="global-cgroup">.defaults/cgroup</optionref> will be ignored
1678 for this guest.
1679       </description>
1680     </scalar>
1681   </collection>
1682   </database>