ia64/xen-unstable

changeset 7960:1e3042a93904

First stab at a xend-config.sxp man page.
author dan@localhost.localdomain
date Sun Nov 20 15:01:15 2005 +0100 (2005-11-20)
parents 5c954929bb0d
children 83bc047bb346
files docs/man/xend-config.sxp.pod.5
line diff
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/docs/man/xend-config.sxp.pod.5	Sun Nov 20 15:01:15 2005 +0100
     1.3 @@ -0,0 +1,142 @@
     1.4 +=head1 NAME
     1.5 +
     1.6 +xend-config.sxp - Xen daemon configuration file
     1.7 +
     1.8 +=head1 SYNOPSIS
     1.9 +
    1.10 +/etc/xen/xend-config.sxp
    1.11 +
    1.12 +=head1 DESCRIPTION
    1.13 +
    1.14 +The xend(1) program requires xend-config.sxp to specify operating
    1.15 +parameters which determine the behavior of the daemon at runtime.
    1.16 +
    1.17 +The parameters are specified in S-expression format.  See the example
    1.18 +configuration file in I</etc/xen/xend-config.sxp> for details.
    1.19 +
    1.20 +=head1 OPTIONS
    1.21 +
    1.22 +The following lists the daemon configuration parameters:
    1.23 +
    1.24 +=over 4
    1.25 +
    1.26 +=item I<logfile>
    1.27 +
    1.28 +The location of the file to record runtime log messages.  Defaults to
    1.29 +I</var/log/xend.log>.
    1.30 +
    1.31 +=item I<loglevel>
    1.32 +
    1.33 +Filters out messages below the specified level.  Possible values are
    1.34 +DEBUG, INFO, WARNING, ERROR, CRITICAL.  Defaults to I<DEBUG>.
    1.35 +
    1.36 +=item I<xend-http-server>
    1.37 +
    1.38 +A boolean value that tells xend whether or not to start the http
    1.39 +stream socket management server.  Defaults to I<no>.
    1.40 +
    1.41 +=item I<xend-unix-server>
    1.42 +
    1.43 +A boolean value that tells xend whether or not to start the unix
    1.44 +domain socket management server.  This is required for the CLI tools
    1.45 +to operate.  Defaults to I<yes>.
    1.46 +
    1.47 +=item I<xend-relocation-server>
    1.48 +
    1.49 +A boolean value that tells xend whether or not to start the relocation
    1.50 +server.  This is required for cross-machine migrations.  Defaults to
    1.51 +I<no>.
    1.52 +
    1.53 +=item I<xend-unix-path>
    1.54 +
    1.55 +The location of the unix domain socket the xend-unix-server will use
    1.56 +to communicate with the management tools.  Defaults to
    1.57 +I</var/lib/xend/xend-socket>.
    1.58 +
    1.59 +=item I<xend-port>
    1.60 +
    1.61 +The port that will be used by the http management server.  Defaults to
    1.62 +I<8000>.
    1.63 +
    1.64 +=item I<xend-relocation-port>
    1.65 +
    1.66 +The port that will be used by the relocation server.  Defaults to
    1.67 +I<8002>.
    1.68 +
    1.69 +=item I<xend-address> 
    1.70 +
    1.71 +The address to which the http management server will bind.  Defaults
    1.72 +to I<''> which means "all interfaces".
    1.73 +
    1.74 +=item I<xend-relocation-address>
    1.75 +
    1.76 +The address to which the relocation server will bind.  Defaults to
    1.77 +I<''> which means "all interfaces".
    1.78 +
    1.79 +=item I<console-limit>
    1.80 +
    1.81 +The kilobyte buffer limit that will be enforced by the console server.
    1.82 +This limit is set per-domain, and is needed to prevent a single domain
    1.83 +from overwhelming the console server with massive amounts of data.
    1.84 +Defaults to I<1024>.
    1.85 +
    1.86 +=item I<network-script>
    1.87 +
    1.88 +The name of the script in I</etc/xen/scripts> that will be run to
    1.89 +setup the networking environment.  This can be any name, but in
    1.90 +general is either I<network-bridge> or I<network-route>.
    1.91 +
    1.92 +=item I<vif-script>
    1.93 +
    1.94 +The name of the script in I</etc/xen/scripts> that will be run to
    1.95 +setup a virtual interface when it is created or destroyed.  This needs
    1.96 +to (in general) work in unison with the I<network-script>.
    1.97 +
    1.98 +=item I<dom0-min-mem>
    1.99 +
   1.100 +This specifies the minimum number of megabytes that will be reserved
   1.101 +for Domain0.  If this value is positive, Domain0 will be automatically
   1.102 +ballooned down to this limit to make space for new domains.  If this
   1.103 +is set to 0, Domain0 will not be automatically ballooned.
   1.104 +
   1.105 +=item I<dom0-cpus>
   1.106 +
   1.107 +This specifies the number of CPUs that Domain0 will be allowed to use.
   1.108 +If the value is 0, all available CPUs will be used by Domain0.
   1.109 +
   1.110 +=item I<enable-dump>
   1.111 +
   1.112 +A boolean value that tells xend whether or not core dumps of guest
   1.113 +domains should be saved when a crash occurrs.  Defaults to I<no>.
   1.114 +
   1.115 +=back
   1.116 +
   1.117 +=head1 EXAMPLES
   1.118 +
   1.119 +An example configuration with relocation enabled for the local network:
   1.120 +
   1.121 +=over 4
   1.122 +
   1.123 + (xend-relocation-server yes)
   1.124 + (xend-relocation-address 192.168.1.1)
   1.125 + (network-script network-bridge)
   1.126 + (vif-script vif-bridge)
   1.127 + (dom0-min-mem 0)
   1.128 + (dom0-cpus 0)
   1.129 +
   1.130 +=back
   1.131 +
   1.132 +=head1 CAVEATS
   1.133 +
   1.134 +Note that relocation is currently unsecured and is very dangerous if
   1.135 +left enabled.  No authentication is performed, and very little sanity
   1.136 +checking takes place.  Enable at your own risk.
   1.137 +
   1.138 +=head1 SEE ALSO
   1.139 +
   1.140 +B<xend>(1)
   1.141 +
   1.142 +=head1 AUTHOR
   1.143 +
   1.144 +Dan Smith <danms@us.ibm.com>
   1.145 +