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-namespace-cleanup" name="namespace-cleanup">
  41       <description>
  42 Enable namespace cleanup globally. It can be overridden for a single vserver
  43 by setting the <optionref ref="global-nonamespace-cleanup">nonamespace-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     <collection name="apps">
  67       <collection name="pkgmgmt">
  68         <link name="base">
  69           <default>/vservers/.pkg</default>
  70         </link>
  71         <data name="apt.conf">
  72           <description>The default apt.conf which is going to be used. It is overridden by
  73 distribution specific configuration file.
  74           </description>
  75         </data>
  76       </collection>
  77
  78       <collection name="debootstrap">
  79         <scalar name="mirror">
  80           <description>
  81 The Debian mirror to use with the <tool>debootstrap</tool> program
  82           </description>
  83         </scalar>
  84         <scalar name="uri">
  85           <description>
  86 When the <tool>debootstrap</tool> package is not installed; fetch it
  87 from this uri and install it at a temporary place.
  88           </description>
  89         </scalar>
  90       </collection>
  91
  92       <collection name="vshelper">
  93         <link name="logfile">
  94           <description>
  95 The file where output will be logged to when <tool>vshelper</tool>
  96 is invoked from the kernel. This should point somewhere e.g. into
  97 <directory>/var/log</directory>.
  98           </description>
  99         </link>
 100
 101         <collection name="vshelper-methods">
 102           <program name="handler" type="symbolic">
 103             <description>
 104 See vshelper/action.
 105             </description>
 106           </program>
 107         </collection>
 108
 109         <boolean name="disabled">
 110           <description>
 111 When existing, the vshelper functionality will be disabled for all
 112 vservers.
 113           </description>
 114         </boolean>
 115
 116         <boolean name="debug">
 117           <description>
 118 When existing, the vshelper execution will be traced.
 119           </description>
 120         </boolean>
 121
 122         <boolean name="warning-disabled">
 123           <description>
 124 When existing, sanity checks for the vshelper functionality will be
 125 skipped.
 126           </description>
 127         </boolean>
 128
 129       </collection>
 130
 131       <collection name="vprocunhide">
 132         <list name="files">
 133           <description>
 134 A list of files which will be made visible by vprocunhide. Wildcards are
 135 allowed and anything ending in '/' will be processed recursively. When this file exists,
 136 it overrides the defaults in SYSDEFAULTDIR/vprocunhide-files. The entries there must be
 137 absolute filenames inclusive the leading '/proc'.
 138           </description>
 139         </list>
 140       </collection>
 141
 142       <collection name="init">
 143         <link name="tty">
 144           <description>
 145 A symlink to the TTY device where input/output will be redirected from/to
 146 at startup via initscript.
 147           </description>
 148         </link>
 149
 150         <hash id="global-environment" name="environment" since="0.30.211">
 151           <description>
 152 The environment to set when starting guests. Contains one VAR=VAL
 153 pair per line.
 154           </description>
 155         </hash>
 156       </collection>
 157
 158       <collection name="vunify">
 159         <list name="exclude">
 160           <description>Static list of excluded files.</description>
 161         </list>
 162
 163         <collection name="hash" since="0.30.205">
 164           <description>
 165 A directory which will be used as the storage place for the
 166 <tool>vhashify</tool> command.
 167           </description>
 168           <link name="id" type="symbolic">
 169             <description>
 170 Points to a directory within the filesystems which are used for the
 171 vservers. There must be not more than one of such a directory per
 172 filesystem.
 173             </description>
 174           </link>
 175
 176           <scalar name="method" since="0.30.299">
 177             <default>SHA1</default>
 178             <description>The used hash method.</description>
 179           </scalar>
 180         </collection>
 181
 182         <boolean name="pkgmgmt-ignore" default="off" since="0.30.205">
 183           <description>
 184 When existing, information from packagemanagement will not be used to
 185 create dynamic exclude-lists.
 186           </description>
 187         </boolean>
 188
 189         <boolean name="pgkmgmt-force" default="off" since="0.30.205">
 190           <description>
 191 When existing, information from packagemanagement will be used to
 192 create dynamic exclude-lists. This option requires that (a known)
 193 packagemanagement is configured for the vserver; else the requested
 194 operation will fail. Most tools assume 'on' as the default value.
 195           </description>
 196         </boolean>
 197
 198       </collection>
 199
 200       <collection name="vlogin">
 201         <boolean id="vlogin-disable" name="disable" since="0.30.212">
 202           <description>
 203 When this file exists, vlogin isn't used on vserver &lt;guest&gt; enter.
 204           </description>
 205         </boolean>
 206       </collection>
 207     </collection>
 208
 209     <collection name="interfaces" use="optional">
 210       <boolean id="global-vlandev" name="vlandev" since="0.30.211">
 211         <description>
 212 When this file exists, the steps which setup and destroy a VLAN
 213 interface will be executed.
 214         </description>
 215       </boolean>
 216     </collection>
 217   </collection>
 218
 219   <collection name=".distributions" use="optional">
 220     <collection name="dist" type="symbolic">
 221       <scalar name="dev">
 222         <description></description>
 223       </scalar>
 224       <collection name="yum">
 225         <description>
 226 The default, yum-related content of the <directory>/etc</directory>
 227 directory.
 228         </description>
 229         <scalar name="yum.conf">
 230           <description>
 231 The master yum configuration file. It supports the @YUMETCDIR@,
 232 @YUMCACHEDIR@ and @YUMLOGDIR@ placeholder which will be replaced at
 233 <command>vserver ... build</command> time.
 234           </description>
 235         </scalar>
 236       </collection>
 237       <collection name="yum.repos.d">
 238         <description>A directory with yum repositories.</description>
 239       </collection>
 240       <data name="apt.conf">
 241         <description>
 242 The default apt.conf which is going to be used. It overrides the
 243 apt.conf from CONFDIR/.defaults/apps/pkgmgmt.
 244         </description>
 245       </data>
 246       <program name="initpre">
 247         <description>
 248 Script which will be executed before packages will be installed.
 249           </description>
 250         <parameterList>
 251           <parameter name="confdir">
 252             <description>
 253 The configuration directory of the vserver which is going to be set up.
 254             </description>
 255           </parameter>
 256           <parameter name="util-vserver-vars">
 257             <description>
 258 The pathname of the util-vserver-vars file.
 259             </description>
 260           </parameter>
 261         </parameterList>
 262       </program>
 263       <program name="initpost">
 264         <description>
 265 Script which will be executed after packages are installed.
 266           </description>
 267         <parameterList>
 268           <parameter name="confdir">
 269             <description>
 270 The configuration directory of the vserver which is going to be set up.
 271             </description>
 272           </parameter>
 273           <parameter name="vserver">
 274             <description>
 275 The pathname of the util-vserver-vars file.
 276             </description>
 277           </parameter>
 278         </parameterList>
 279       </program>
 280
 281       <collection name="pkgs">
 282         <description>
 283 Contains files with packagenames.
 284         </description>
 285         <list name="list">
 286           <description>
 287 File which contains the name of packages. On top of file the special
 288 keywords '--reinstall' and '--can-fail' are possible.
 289           </description>
 290         </list>
 291       </collection>
 292
 293       <collection name="pubkeys">
 294         <description>
 295 Directory with GPG pubkeys which are used to sign the packages of this
 296 distribution.
 297         </description>
 298       </collection>
 299
 300       <collection name="apt">
 301         <description>
 302 Default content of the <directory>/etc/apt/</directory> directory.
 303         </description>
 304       </collection>
 305
 306       <collection name="rpm">
 307         <description>
 308 Default content of the <directory>/etc/rpm</directory> directory.
 309         </description>
 310       </collection>
 311
 312       <link name="rpmlib">
 313         <description>
 314 Directory which overrides <directory>/usr/lib/rpm</directory>.
 315         </description>
 316       </link>
 317       <link name="execdir">
 318         <description>
 319 Directory with all executables and libraries which are required for
 320 this distribution.
 321         </description>
 322       </link>
 323     </collection>
 324   </collection>
 325
 326   <!-- Vserver configuration -->
 327   <collection name="vserver-name" type="symbolic">
 328     <description>
 329 The configuration directory for the vserver vserver-name.
 330     </description>
 331
 332     <link name="cache">
 333       <default>../.defaults/cachebase/VSERVERNAME</default>
 334       <description>
 335 Path of the storage area for cached information about this vserver.
 336       </description>
 337     </link>
 338
 339     <link name="vdir">
 340       <default>../.defaults/vdirbase/VSERVERNAME</default>
 341       <description>
 342 Path of the vserver root directory.
 343       </description>
 344     </link>
 345
 346     <link name="run">
 347       <description>
 348 Points to a file which will contain the XID of the running vserver. When
 349 the vserver is stopped, this can be a dangling symlink.
 350       </description>
 351     </link>
 352
 353     <list id="bcapabilities" name="bcapabilities">
 354       <description>
 355 Contains the system capabilities. See
 356 <ulink url="http://svn.linux-vserver.org/svn/util-vserver/trunk/lib/bcaps-v13.c">lib/bcaps-v13.c</ulink>
 357 for possible values.
 358       </description>
 359     </list>
 360     <list name="ccapabilities">
 361       <description>
 362 Contains the context capabilities. See <ulink
 363 url="http://svn.linux-vserver.org/svn/util-vserver/trunk/lib/ccaps-v13.c">lib/ccaps-v13.c</ulink>
 364 for possible values.
 365       </description>
 366     </list>
 367
 368     <boolean id="global-namespace" name="namespace">
 369       <description>
 370 Overrides the global <optionref ref="global-nonamespace">nonamespace</optionref> flag and enables
 371 namespace usage for the current vserver.
 372       </description>
 373     </boolean>
 374
 375     <boolean name="nonamespace">
 376       <description>
 377 Disables namespace usage for the current vserver.
 378
 379 In this mode the <directory>/vservers</directory> directory must have
 380 the 'barrier' attribute. Else, common chroot(2) exploits are possible.
 381       </description>
 382     </boolean>
 383
 384     <boolean id="global-nonamespace-cleanup" name="nonamespace-cleanup">
 385       <description>
 386 Overrides the global <optionref ref="global-namespace-cleanup">namespace-cleanup</optionref> flag and disables
 387 namespace cleanup for the current vserver.
 388       </description>
 389     </boolean>
 390
 391     <boolean name="namespace-cleanup">
 392       <description>
 393 Enable namespace cleanup for the current vserver.
 394       </description>
 395     </boolean>
 396
 397     <list name="namespace-cleanup-skip">
 398       <description>
 399 List of paths to skip during namespace cleanup. This overrides the
 400 <optionref ref="global-namespace-cleanup-skip">global namespace-cleanup-skip</optionref>
 401 file.
 402       </description>
 403     </list>
 404
 405     <hash name="schedule">
 406       <description>
 407 [experimental; name is subject of possible change] Contains the
 408 scheduler parameters, one per line.
 409
 410 The Hard CPU limit uses a mechanism called a Token Bucket.  the
 411 concept is simple: you have a bucket of a certain size which is
 412 filled with a specified amount R of tokens each interval T until the
 413 maximum is reached (excess tokens are spilled). At each timer tick,
 414 a running process consumes one token from the bucket, unless the
 415 bucket is empty. If the bucket is empty the process is put in the
 416 hold queue. When the bucket has been refilled to at least M tokens,
 417 all on hold processes are rescheduled.
 418
 419 See the <ulink url="http://linux-vserver.org/Scheduler+Parameters">Linux
 420 VServer Wiki</ulink> for more information about this file.
 421       </description>
 422       <keys>
 423         <key id="fill_rate" name="fill-rate">
 424           <description>
 425 Amount of tokens append to the bucket each interval.
 426             </description>
 427         </key>
 428         <key name="interval">
 429           <description>
 430 The intervall between refills of amount <optionref>fill_rate</optionref>. This
 431 value is express in ticks.
 432           </description>
 433         </key>
 434         <key name="tokens">
 435           <description>
 436 Initial bucket contents.
 437           </description>
 438         </key>
 439         <key name="tokens-min">
 440           <description>
 441 The minimum amount of tokens required to unhold processes
 442           </description>
 443         </key>
 444         <key name="tokens-max">
 445           <description>
 446 The bucket size.
 447           </description>
 448         </key>
 449         <key name="priority-bias">
 450           <description>
 451 ???
 452           </description>
 453         </key>
 454       </keys>
 455     </hash>
 456     <scalar name="name">
 457       <description>
 458 Contains the name of the vserver. When not given, the basename of the directory
 459 will be assumed as this name.
 460       </description>
 461     </scalar>
 462     <scalar name="nice">
 463       <description>
 464 The nice-level on which the vserver will be started.
 465       </description>
 466     </scalar>
 467     <list name="capabilities">
 468       <description>
 469 Contains per line a capability. This file is used for the 2.4 kernel
 470 only; for 2.6 use <optionref>bcapabilities</optionref>.
 471       </description>
 472     </list>
 473     <scalar name="shell">
 474       <description>
 475 Contains the pathname of the shell which will be used by the "vserver
 476 ... enter" command.
 477       </description>
 478     </scalar>
 479     <list name="personality">
 480       <description>
 481 Used to set the personality of the vserver. First line in the file
 482 is the personality-type followed by flags (one item per line). See
 483 <filename>/usr/include/linux/personality.h</filename> for possible
 484 values.
 485       </description>
 486     </list>
 487     <list name="flags">
 488       <description>
 489 Contains per line a flag. See <ulink
 490 url="http://svn.linux-vserver.org/svn/util-vserver/trunk/lib/cflags-v13.c">lib/cflags-v13.c</ulink>
 491 for possible values.
 492       </description>
 493       <!--
 494       <elements>
 495         <element name="fakeinit">
 496           <description>
 497 The new process will believe it is process number 1. Useful to run a
 498 real /sbin/init in a vserver. Warning: this flag should not be used
 499 unless you know what you are doing. Often, it is better to use the
 500 'plain' initstyle.
 501           </description>
 502         </element>
 503         <element name="lock">
 504           <description>
 505 The new process is trapped and can't use chcontext anymore.
 506           </description>
 507         </element>
 508         <element name="sched">
 509           <description>
 510 The new process and its children will share a common
 511           </description>
 512         </element>
 513         <element name="nproc">
 514           <description>
 515 Limit the number of process in the vserver according to
 516 ulimit setting. Normally, ulimit is a per user thing.
 517 With this flag, it becomes a per vserver thing.
 518           </description>
 519         </element>
 520         <element name="private">
 521           <description>
 522 No one can join this security context once created.
 523           </description>
 524         </element>
 525         <element name="ulimit">
 526           <description>
 527 Apply the current ulimit to the whole context
 528           </description>
 529         </element>
 530       </elements>
 531       -->
 532     </list>
 533     <scalar name="context">
 534       <description>
 535 Contains the context which shall be used for the vserver.
 536         </description>
 537     </scalar>
 538     <data id="fstab" name="fstab">
 539       <description>
 540 The fstab file for the vserver. Entries in this file will be mounted
 541 within the network context of the host. Use the
 542 <optionref>fstab.remote</optionref> file when you want that the
 543 mounting happens in the network context of the vserver. In most cases
 544 the 'fstab' file should be used.
 545       </description>
 546     </data>
 547     <data id="fstab.remote" name="fstab.remote">
 548       <description>
 549 The fstab file for the vserver. Entries in this file will be mounted
 550 within the network context of the host; this means that mount will be
 551 called as <command>chbind &lt;options&gt; mount ...</command>. See
 552 <optionref>fstab</optionref> also.
 553       </description>
 554     </data>
 555
 556     <collection name="apps">
 557       <collection name="init">
 558         <data name="mtab">
 559           <description>
 560 The initial-mtab which will be used for the vserver.
 561           </description>
 562         </data>
 563
 564         <scalar name="style">
 565           <description>
 566 Contains the init-style.
 567           </description>
 568           <restriction>
 569             <enumeration value="sysv"/>
 570             <enumeration value="plain"/>
 571             <enumeration value="minit"/>
 572           </restriction>
 573         </scalar>
 574
 575         <scalar name="runlevel">
 576           <description>The start runlevel.</description>
 577         </scalar>
 578
 579         <scalar name="runlevel.start">
 580           <description>The start runlevel.</description>
 581         </scalar>
 582
 583         <scalar name="runlevel.stop">
 584           <description>The stop runlevel.</description>
 585         </scalar>
 586
 587         <scalar name="killseq">
 588           <description>
 589 Contains the 'signal [wait signal]*' sequence which is used to stop
 590 the vserver.
 591           </description>
 592         </scalar>
 593
 594         <list name="cmd.start">
 595           <description>
 596 The command which is used to start the vserver. Each option must be on
 597 a separate line.
 598           </description>
 599         </list>
 600
 601         <list name="cmd.start-sync">
 602           <description>
 603 The command which is used to wait on the vserver after it has been
 604 started. Each option must be on a separate line. This file will be
 605 ignored when the <optionref>sync</optionref> flag does not exist and the
 606 '--sync' option was not used.
 607           </description>
 608         </list>
 609
 610         <list name="cmd.stop">
 611           <description>
 612 The command which is used to stop the vserver. Each option must be on
 613 a separate line.
 614           </description>
 615         </list>
 616
 617         <list name="cmd.stop-sync">
 618           <description>
 619 The command which is used to wait on the vserver after it has been
 620 stopped. Each option must be on a separate line. This file will be
 621 ignored when the <optionref>sync</optionref> flag does not exist and the
 622 '--sync' option was not used.
 623           </description>
 624         </list>
 625
 626         <list name="cmd.prepare">
 627           <description>
 628 The command which is used to setup the init-system (e.g. to set the
 629 runlevel in the utmp-file). Each option must be on a separate line.
 630           </description>
 631         </list>
 632
 633         <boolean id="sync" name="sync">
 634           <description>
 635 If this file is not present, all 'cmd.*-sync files will be ignored.
 636             </description>
 637         </boolean>
 638
 639         <link name="tty">
 640           <description>
 641 A symlink to the TTY device where input/output will be redirected
 642 from/to at startup via initscript.
 643           </description>
 644         </link>
 645
 646         <scalar name="mark">
 647           <description>
 648 This file is used to mark group of vservers which shall be started/stopped
 649 together by the initscript. Content is a simple string like 'default'.
 650           </description>
 651         </scalar>
 652
 653         <list name="depends">
 654           <description>
 655 This file is used to configure vservers which must be running before
 656 the current vserver can be started. At shutdown, the current vserver
 657 will be stopped before its dependencies. Content of this file are
 658 vserver ids (one name per line).
 659           </description>
 660         </list>
 661
 662         <hash name="environment" since="0.30.211">
 663           <description>
 664 The environment to set when starting the guest. Contains one VAR=VAL
 665 pair per line.
 666           </description>
 667         </hash>
 668       </collection>
 669
 670       <collection name="vshelper">
 671         <scalar name="sync-timeout">
 672           <default>30</default>
 673           <description>
 674 The timeout in seconds which is used when synchronising vserver
 675 startup/shutdown with the vshelper. When not set, 30 seconds will be
 676 assumed.
 677           </description>
 678         </scalar>
 679
 680         <scalar name="action">
 681           <default>restart</default>
 682           <description>
 683 The action which is going to be executed when a vshelper event
 684 occurs. The default value is 'restart', but there can be defined own
 685 methods by placing scripts into the
 686 <optionref>vshelper-methods</optionref> directories. These scripts are
 687 fed with the same arguments as the <tool>vshelper</tool> script.
 688           </description>
 689         </scalar>
 690
 691         <program name="event" type="symbolic">
 692           <description>
 693 When existing, these scripts will be executed *instead* of the default
 694 handler defined in 'action'. Their name must match the event which caused
 695 the execution of <tool>vshelper</tool>; e.g. 'restart' or 'poweroff'. See
 696 the vs_reboot() function in the kernel for more details.
 697           </description>
 698           <parameterList>
 699             <parameter name="xid">
 700               <description>
 701 The xid of the context calling the vshelper
 702               </description>
 703             </parameter>
 704             <parameter name="event">
 705               <description>
 706 The reboot-event.
 707               </description>
 708             </parameter>
 709           </parameterList>
 710         </program>
 711
 712         <boolean name="disabled">
 713           <description>
 714 When existing, the vshelper functionality will be disabled for this
 715 vserver.
 716           </description>
 717         </boolean>
 718
 719         <boolean name="debug">
 720           <description>
 721 When existing, the vshelper execution will be traced for this vserver.
 722           </description>
 723         </boolean>
 724
 725         <boolean name="warning-disabled">
 726           <description>
 727 When existing, sanity checks for the vshelper functionality will be
 728 skipped.
 729           </description>
 730         </boolean>
 731
 732       </collection>
 733
 734       <collection id="vshelper-methods" name="vshelper-methods">
 735         <program name="handler" type="symbolic">
 736           <description>
 737 See vshelper/action.
 738           </description>
 739         </program>
 740       </collection>
 741
 742       <collection name="vunify">
 743         <description>
 744 This directory contains configuration data required for vserver
 745 unification.
 746         </description>
 747
 748         <list name="exclude">
 749           <description>
 750 <p>Static list of files which are excluded for unification. This list
 751 supports an rsync-like syntax: when a file is prefixed by '+', it is a
 752 candidate for unification; when there is no prefix or a '-' or a '~' it
 753 will be excluded. Shell-wildcards are allowed for the filenames.</p>
 754 <p>When used with <tool>vcopy</tool>, the '~' prefix prevents copying
 755 of the file entirely (e.g. for keyfiles). With this tool, the file will
 756 be copied instead of hardlinked when the '-' prefix is used.</p>
 757           </description>
 758         </list>
 759
 760         <link name="refserver.X" type="symbolic">
 761           <description>
 762 These are symlinks to the configuration directory
 763 (e.g. CONFDIR/vservers/&lt;id&gt;) of a refserver. There may be
 764 multiple such symlinks but they must be prefixed by 'refserver.' and
 765 will be processed in alphanumerical order.
 766           </description>
 767         </link>
 768
 769         <collection name="hash" since="0.30.205">
 770           <description>
 771 A directory which will be used as the storage place for the
 772 <tool>vhashify</tool> command.
 773           </description>
 774           <link name="id" type="symbolic">
 775             <description>
 776 Points to a directory within the filesystems which are used for the
 777 vservers. There must be not more than one of such a directory per
 778 filesystem.
 779             </description>
 780           </link>
 781
 782           <scalar name="method"  since="0.30.299">
 783             <default>SHA1</default>
 784             <description>The used hash method.</description>
 785           </scalar>
 786         </collection>
 787
 788         <boolean name="pkgmgmt-ignore" default="off" since="0.30.205">
 789           <description>
 790 When existing, information from packagemanagement will not be used to
 791 create dynamic exclude-lists.
 792           </description>
 793         </boolean>
 794
 795         <boolean name="pgkmgmt-force" default="off" since="0.30.205">
 796           <description>
 797 When existing, information from packagemanagement will be used to
 798 create dynamic exclude-lists. This option requires that (a known)
 799 packagemanagement is configured for the vserver; else the requested
 800 operation will fail. Most tools assume 'on' as the default value.
 801           </description>
 802         </boolean>
 803
 804       </collection>
 805     </collection>
 806
 807     <collection name="scripts">
 808       <description>
 809 A directory for scripts. By default, when one of these scripts will be
 810 executed, the execution of defaultscripts (within .../.defaults/scripts)
 811 will be skipped. To execute them nevertheless, the $DONT_SKIP_DEFAULTS
 812 environment variable must be set by one of the in-shellcontext scripts
 813 (the non-executable ones).
 814       </description>
 815
 816       <program name="initialize" since="0.30.211">
 817         <description>
 818 The scriptlet which will be executed before the root filesystem is mounted and
 819 the configuration has been loaded. Before executing the script, the
 820 configuration directory will be made the working directory.
 821         </description>
 822         <parameterList>
 823           <parameter name="action">
 824             <description>
 825 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
 826             </description>
 827           </parameter>
 828           <parameter name="vserver-name">
 829             <description>
 830 The name of the current vserver.
 831             </description>
 832           </parameter>
 833         </parameterList>
 834       </program>
 835       <collection name="initialize.d" since="0.30.211">
 836         <description>
 837 Repository of initialize like scripts.  Before executing the script,
 838 the configuration directory will be made the working directory.
 839         </description>
 840         <program name="script" type="symbolic">
 841           <description>See initialize.</description>
 842           <parameterList>
 843             <parameter name="action">
 844               <description>
 845 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
 846               </description>
 847             </parameter>
 848             <parameter name="vserver-name">
 849               <description>
 850 The name of the current vserver.
 851               </description>
 852             </parameter>
 853           </parameterList>
 854         </program>
 855       </collection>
 856
 857       <program name="prepre-start">
 858         <description>
 859 The scriptlet which will be executed before the network-interfaces are
 860 enabled and the directories are mounted. Before executing the script,
 861 the configuration directory will be made the working directory.
 862         </description>
 863         <parameterList>
 864           <parameter name="action">
 865             <description>
 866 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
 867             </description>
 868           </parameter>
 869           <parameter name="vserver-name">
 870             <description>
 871 The name of the current vserver.
 872             </description>
 873           </parameter>
 874         </parameterList>
 875       </program>
 876       <collection name="prepre-start.d">
 877         <description>
 878 Repository of prepre-start like scripts.  Before executing the script,
 879 the configuration directory will be made the working directory.
 880         </description>
 881         <program name="script" type="symbolic">
 882           <description>See prepre-start.</description>
 883           <parameterList>
 884             <parameter name="action">
 885               <description>
 886 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
 887               </description>
 888             </parameter>
 889             <parameter name="vserver-name">
 890               <description>
 891 The name of the current vserver.
 892               </description>
 893             </parameter>
 894           </parameterList>
 895         </program>
 896       </collection>
 897
 898       <program name="pre-start">
 899         <description>
 900 The scriptlet which will be executed after network-interfaces were
 901 enabled and the directories mounted, but before the vserver itself has
 902 been started.  Before executing the script, the vserver root directory
 903 will be made the working directory.
 904         </description>
 905         <parameterList>
 906           <parameter name="action">
 907             <description>
 908 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
 909             </description>
 910           </parameter>
 911           <parameter name="vserver-name">
 912             <description>
 913 The name of the current vserver.
 914             </description>
 915           </parameter>
 916         </parameterList>
 917       </program>
 918       <collection name="pre-start.d">
 919         <description>
 920 Repository of pre-start like scripts. Before executing these scripts,
 921 the vserver root directory will be made the working directory.
 922         </description>
 923         <program name="script" type="symbolic">
 924           <description>See pre-start.</description>
 925           <parameterList>
 926             <parameter name="action">
 927               <description>
 928 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
 929               </description>
 930             </parameter>
 931             <parameter name="vserver-name">
 932               <description>
 933 The name of the current vserver.
 934               </description>
 935             </parameter>
 936           </parameterList>
 937         </program>
 938       </collection>
 939
 940
 941       <program name="post-start">
 942         <description>
 943 The scriptlet which will be executed after the vserver has been
 944 started. Before executing the script, the vserver root directory
 945 will be made the working directory.
 946         </description>
 947         <parameterList>
 948           <parameter name="action">
 949             <description>
 950 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
 951             </description>
 952           </parameter>
 953           <parameter name="vserver-name">
 954             <description>
 955 The name of the current vserver.
 956             </description>
 957           </parameter>
 958         </parameterList>
 959       </program>
 960       <collection name="post-start.d">
 961         <description>
 962 Repository of post-start like scripts. Before executing these scripts,
 963 the vserver root directory will be made the working directory.
 964         </description>
 965         <program name="script" type="symbolic">
 966           <description>See post-start.</description>
 967           <parameterList>
 968             <parameter name="action">
 969               <description>
 970 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
 971               </description>
 972             </parameter>
 973             <parameter name="vserver-name">
 974               <description>
 975 The name of the current vserver.
 976               </description>
 977             </parameter>
 978           </parameterList>
 979         </program>
 980       </collection>
 981
 982
 983       <program name="pre-stop">
 984         <description>
 985 The scriptlet which will be executed before the vserver will be
 986 stopped. Before executing the script, the vserver root directory
 987 will be made the working directory.
 988         </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 name="pre-stop.d">
1003         <description>
1004 Repository of pre-stop like scripts. Before executing the script, the
1005 vserver root directory will be made the working directory.
1006         </description>
1007         <program name="script" type="symbolic">
1008           <description>See pre-stop.</description>
1009           <parameterList>
1010             <parameter name="action">
1011               <description>
1012 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1013               </description>
1014             </parameter>
1015             <parameter name="vserver-name">
1016               <description>
1017 The name of the current vserver.
1018               </description>
1019             </parameter>
1020           </parameterList>
1021         </program>
1022       </collection>
1023
1024       <program name="post-stop">
1025         <description>
1026 The scriptlet which will be executed after the vserver has been
1027 stopped, but before the directories will be umounted and the the
1028 interfaces disabled. Before executing the script, the vserver root
1029 directory will be made the working directory.
1030         </description>
1031         <parameterList>
1032           <parameter name="action">
1033             <description>
1034 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1035             </description>
1036           </parameter>
1037           <parameter name="vserver-name">
1038             <description>
1039 The name of the current vserver.
1040             </description>
1041           </parameter>
1042         </parameterList>
1043       </program>
1044       <collection name="post-stop.d">
1045         <description>
1046 Repository of post-stop like scripts. Before executing the script, the
1047 vserver root directory will be made the working directory.
1048         </description>
1049         <program name="script" type="symbolic">
1050           <description>See post-stop.</description>
1051           <parameterList>
1052             <parameter name="action">
1053               <description>
1054 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1055               </description>
1056             </parameter>
1057             <parameter name="vserver-name">
1058               <description>
1059 The name of the current vserver.
1060               </description>
1061             </parameter>
1062           </parameterList>
1063         </program>
1064       </collection>
1065
1066       <program name="postpost-stop">
1067         <description>
1068 The scriptlet which will be executed after the vserver has been stopped
1069 completely. Before executing the script, the vserver root directory
1070 will be made the working directory.
1071         </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 name="postpost-stop.d">
1086         <description>
1087 Repository of postpost-stop like scripts. Before executing the script,
1088 the vserver root directory will be made the working directory.
1089         </description>
1090         <program name="script" type="symbolic">
1091           <description>See postpost-stop.</description>
1092           <parameterList>
1093             <parameter name="action">
1094               <description>
1095 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1096               </description>
1097             </parameter>
1098             <parameter name="vserver-name">
1099               <description>
1100 The name of the current vserver.
1101               </description>
1102             </parameter>
1103           </parameterList>
1104         </program>
1105       </collection>
1106     </collection>
1107
1108     <collection name="interfaces">
1109       <scalar name="bcast">
1110         <description>The default broadcast address.</description>
1111       </scalar>
1112       <scalar name="dev">
1113         <description>The default network device.</description>
1114       </scalar>
1115       <scalar name="prefix">
1116         <description>The default network prefix-length.</description>
1117       </scalar>
1118       <scalar name="mask">
1119         <description>The default network mask.</description>
1120       </scalar>
1121       <scalar name="scope">
1122         <description>The default scope of the network interfaces.</description>
1123       </scalar>
1124       <boolean id="local-vlandev" name="vlandev" since="0.30.211">
1125         <description>
1126 When this file exists, the steps which setup and destroy a VLAN
1127 interface will be executed for all interfaces of this vserver.
1128         </description>
1129       </boolean>
1130       <boolean id="local-novlandev" name="novlandev">
1131         <description>
1132 When this file exists, the steps which setup and destroy a VLAN
1133 interface will be skipped. This overrides the global
1134 <optionref ref="global-vlandev">vlandev</optionref> setting for
1135 this vserver.
1136         </description>
1137       </boolean>
1138
1139       <collection name="iface" type="symbolic">
1140         <description>
1141 'iface' is an arbitrary name for the interface; the value itself is
1142 not important but may be interesting regarding interface-creation and
1143 usage with <tool>chbind</tool>. Both happens in alphabetical order and
1144 numbers like '00' are good names for these directories.
1145         </description>
1146
1147         <boolean name="disabled">
1148           <description>When this file exists, this interface will be ignored.</description>
1149         </boolean>
1150
1151         <scalar name="ip">
1152           <description>The ip which will be assigned to this interface.</description>
1153         </scalar>
1154         <scalar name="bcast">
1155           <description>The broadcast address.</description>
1156         </scalar>
1157         <scalar name="dev">
1158           <description>The network device.</description>
1159         </scalar>
1160         <scalar name="prefix">
1161           <description>The network prefix-length.</description>
1162         </scalar>
1163         <scalar name="mask">
1164           <description>The network mask.</description>
1165         </scalar>
1166         <scalar name="scope">
1167           <description>The scope of the network interface.</description>
1168         </scalar>
1169         <scalar name="name">
1170           <description>
1171 When this file exists, the interface will be named with the text in
1172 this file. Without such an entry, the IP will not be shown by
1173 <tool>ifconfig</tool> but by <command>ip addr ls</command> only.  Such
1174 a labeled interface is known as an "alias" also (e.g. 'eth0:foo').
1175           </description>
1176         </scalar>
1177         <boolean name="nodev">
1178           <description>
1179 When this file exists, the interface will be assumed to exist
1180 already. This can be used to assign primary interfaces which are
1181 created by the host or another vserver.
1182           </description>
1183         </boolean>
1184         <boolean name="novlandev">
1185           <description>
1186 When this file exists, the steps which setup and destroy a VLAN
1187 interface will be skipped. This will override the global
1188 <optionref ref="global-vlandev">vlandev</optionref> and the per-guest
1189 <optionref ref="local-vlandev">vlandev</optionref>.
1190           </description>
1191         </boolean>
1192         <boolean name="vlandev" since="0.30.211">
1193           <description>
1194 When this file exists, the steps which setup and destroy a VLAN
1195 interface will be executed.
1196           </description>
1197         </boolean>
1198       </collection>
1199     </collection>
1200
1201     <collection name="ulimits">
1202       <description>
1203 A directory with ulimits. Possible resources are cpu, data, fsize,
1204 locks, memlock, nofile, nproc, rss and/or stack.
1205       </description>
1206       <scalar name="resource" type="symbolic">
1207         <description>
1208 A file which contains the hard- and soft-limit of the given resource
1209 in the first line. The special keyword 'inf' is recognized.
1210         </description>
1211       </scalar>
1212       <scalar name="resource.hard" type="symbolic">
1213         <description>
1214 A file which contains the hard- of the given resource in the first
1215 line. The special keyword 'inf' is recognized.
1216         </description>
1217       </scalar>
1218       <scalar name="resource.soft" type="symbolic">
1219         <description>
1220 A file which contains the soft- of the given resource in the first
1221 line. The special keyword 'inf' is recognized.
1222         </description>
1223       </scalar>
1224     </collection>
1225
1226     <collection name="rlimits">
1227       <description>
1228 A directory with resource limits. Possible resources are cpu, fsize,
1229 data, stack, core, rss, nproc, nofile, memlock, as and locks. This
1230 configuration will be honored for kernel 2.6 only.
1231       </description>
1232       <scalar name="resource" type="symbolic">
1233         <description>
1234 A file which contains the hard- and soft-limit of the given resource
1235 in the first line. The special keyword 'inf' is recognized.
1236         </description>
1237       </scalar>
1238       <scalar name="resource.hard" type="symbolic">
1239         <description>
1240 A file which contains the hard- of the given resource in the first
1241 line. The special keyword 'inf' is recognized.
1242         </description>
1243       </scalar>
1244       <scalar name="resource.soft" type="symbolic">
1245         <description>
1246 A file which contains the soft- of the given resource in the first
1247 line. The special keyword 'inf' is recognized.
1248         </description>
1249       </scalar>
1250       <scalar name="resource.min" type="symbolic">
1251         <description>
1252 A file which contains the guaranted minimum of the given resource in
1253 the first line. The special keyword 'inf' is recognized.
1254         </description>
1255       </scalar>
1256     </collection>
1257
1258     <collection name="uts">
1259       <scalar name="context">
1260         <description>
1261 The context-name of the vserver. This file is listed for completeness
1262 only; the 'context' name is used and set internally by the util-vserver
1263 tools and can *not* be modified.
1264         </description>
1265       </scalar>
1266       <scalar name="sysname">
1267         <description>The sysname of the vserver</description>
1268       </scalar>
1269       <scalar name="nodename">
1270         <description>The node-/hostname of the vserver</description>
1271       </scalar>
1272       <scalar name="release">
1273         <description>The OS-release of the vserver</description>
1274       </scalar>
1275       <scalar name="version">
1276         <description>The OS-version of the vserver</description>
1277       </scalar>
1278       <scalar name="machine">
1279         <description>The machine-type of the vserver</description>
1280       </scalar>
1281       <scalar name="domainname">
1282         <description>The NIS domainname of the vserver</description>
1283       </scalar>
1284     </collection>
1285
1286     <collection name="dlimits" since="0.30.210">
1287       <collection name="dlimit" type="symbolic">
1288         <scalar name="directory">
1289           <description>The directory to which the limit should be applied</description>
1290         </scalar>
1291         <scalar name="inodes_total">
1292           <description>The amount of inodes this vserver should be limited to</description>
1293         </scalar>
1294         <scalar name="space_total">
1295           <description>The amount of space this vserver should be limited to (measured in blocks of 1024 bytes)</description>
1296         </scalar>
1297         <scalar name="reserved">
1298           <description>How much space (percentage-wise) should be reserved for the root user</description>
1299         </scalar>
1300       </collection>
1301     </collection>
1302
1303     <collection name="cpuset" since="0.30.211">
1304       <scalar name="name">
1305         <description>The name of the cpuset for this vserver</description>
1306       </scalar>
1307       <scalar name="cpus">
1308         <description>The list of CPUs in this cpuset</description>
1309       </scalar>
1310       <scalar name="mems">
1311         <description>The list of Memory Nodes in this cpuset</description>
1312       </scalar>
1313       <scalar name="cpu_exclusive">
1314         <description>Is the CPU assignment exclusive?</description>
1315       </scalar>
1316       <scalar name="mems_exclusive">
1317         <description>Is the memory node assignment exclusive?</description>
1318       </scalar>
1319       <scalar name="nocreate">
1320         <description>When this file exists, the cpuset will be assumed to exist already</description>
1321       </scalar>
1322     </collection>
1323
1324     <collection name="sched" since="0.30.212">
1325       <scalar id="global-tokens" name="tokens">
1326         <description>The initial amount of tokens to put in the bucket</description>
1327       </scalar>
1328       <scalar id="global-tokens-min" name="tokens-min">
1329         <description>The minimum amount of tokens required to unhold the context</description>
1330       </scalar>
1331       <scalar id="global-tokens-max" name="tokens-max">
1332         <description>The bucket's size</description>
1333       </scalar>
1334       <scalar id="global-fill-rate" name="fill-rate">
1335         <description>Amount of tokens to add each <optionref ref="global-interval">interval</optionref></description>
1336       </scalar>
1337       <scalar id="global-interval" name="interval">
1338         <description>The interval between refills of the bucket</description>
1339       </scalar>
1340       <scalar id="global-priority-bias" name="priority-bias">
1341         <description>Bias added to priorities calculated within the guest (result is clamped to -20/+19)</description>
1342       </scalar>
1343       <scalar id="global-fill-rate2" name="fill-rate2">
1344         <description>Amount of tokens to add each <optionref ref="global-interval2">interval2</optionref> when advancing idle time</description>
1345       </scalar>
1346       <scalar id="global-interval2" name="interval2">
1347         <description>The interval between refills of the bucket when advancing idle time</description>
1348       </scalar>
1349       <boolean id="global-idle-time" name="idle-time">
1350         <description>When this file exists, advancing idle time is activated</description>
1351       </boolean>
1352       <collection name="cpu-id" type="symbolic">
1353         <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>
1354         <scalar name="tokens">
1355           <description>The initial amount of tokens to put in the bucket</description>
1356         </scalar>
1357         <scalar name="tokens-min">
1358           <description>The minimum amount of tokens required to unhold the context</description>
1359         </scalar>
1360         <scalar name="tokens-max">
1361           <description>The bucket's size</description>
1362         </scalar>
1363         <scalar name="fill-rate">
1364           <description>Amount of tokens to add each <optionref ref="interval">interval</optionref></description>
1365         </scalar>
1366         <scalar name="interval">
1367           <description>The interval between refills of the bucket</description>
1368         </scalar>
1369         <scalar name="priority-bias">
1370           <description>Bias added to priorities calculated within the guest (result is clamped to -20/+19)</description>
1371         </scalar>
1372         <scalar name="fill-rate2">
1373           <description>Amount of tokens to add each <optionref ref="interval2">interval2</optionref> when advancing idle time</description>
1374         </scalar>
1375         <scalar name="interval2">
1376           <description>The interval between refills of the bucket when advancing idle time</description>
1377         </scalar>
1378         <boolean name="idle-time">
1379           <description>When this file exists, advancing idle time is activated</description>
1380         </boolean>
1381         <scalar name="cpu-id">
1382           <description>The CPU to apply these settings to</description>
1383         </scalar>
1384         <scalar name="bucket-id">
1385           <description>The bucket to apply these settings to</description>
1386         </scalar>
1387       </collection>
1388     </collection>
1389   </collection>
1390   </database>