Files
xen/docs/man/xend-config.sxp.pod.5
T
Keir Fraser aac518b954 tools/docs: Fix example and default IP addresses.
In various places in documentation and code, IP addresses are provided
as examples, defaults, or dummy configuration.  In general the
specific IP addresses used in Xen are not always appropriate.  (For
example, 1.2.3.4 is used in a few places!)

The following addresses should be used:
 * For examples and documentation, 192.0.2.0/24.  (See RFC3330.)
 * For defaults for private networks, a random network from RFC1918.
   I have randomly selected 172.30.206.0/24 for this purpose and
   documented this in at the only registry I know of,
   www.ucam.org/cam-grin.  This network should henceforth be used for
   default configurations of local bridges, test networks, etc. in
   Xen tools.

The following addresses should NOT be used:
 * 10.0.*.*, 10.1.*.*, 192.168.0.*, 192.168.1.*, etc.  Using these
   addresses gives greatly increased likelihood of collision, as
   ignorant network administrators and reckless middlebox vendors
   often pick networks from the bottom of 10/8 and 192.168/16.
 * 169.254.*.*.  These are reserved for zeroconf (ad-hoc networking)
   and should not be used for Xen private networks, bridges, etc.,
   etc.  Use of these addresses by Xen scripts causes trouble on hosts
   (eg laptops) which find themselves in ad-hoc networking
   environments.  I think this is not hypothetical (!) since at least
   one Linux distribution have specific code to detect this case and
   cause Xen startup to fail iff the host already has an external
   zeroconf address.
 * 1.2.3.4.  WTF !?

I have also used 127.0.255.255 in one place where apparently a dummy
address is needed (some Linux kernels won't accept a lack of an NFS
server address).  If 127.0.255.255 is mistakenly used it is unlikely
to do any damage to real traffic even if it does escape into the
network at large.

Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com>
2008-01-17 15:13:40 +00:00

149 lines
3.9 KiB
Plaintext

=head1 NAME
xend-config.sxp - Xen daemon configuration file
=head1 SYNOPSIS
/etc/xen/xend-config.sxp
=head1 DESCRIPTION
The xend(1) program requires xend-config.sxp to specify operating
parameters which determine the behavior of the daemon at runtime.
The parameters are specified in S-expression format. See the example
configuration file in I</etc/xen/xend-config.sxp> for details.
=head1 OPTIONS
The following lists the daemon configuration parameters:
=over 4
=item I<logfile>
The location of the file to record runtime log messages. Defaults to
I</var/log/xen/xend.log>.
=item I<loglevel>
Filters out messages below the specified level. Possible values are
DEBUG, INFO, WARNING, ERROR, CRITICAL. Defaults to I<DEBUG>.
=item I<xend-http-server>
A boolean value that tells xend whether or not to start the http
stream socket management server. Defaults to I<no>.
=item I<xend-unix-server>
A boolean value that tells xend whether or not to start the unix
domain socket management server. This is required for the CLI tools
to operate. Defaults to I<yes>.
=item I<xend-relocation-server>
A boolean value that tells xend whether or not to start the relocation
server. This is required for cross-machine migrations. Defaults to
I<no>.
=item I<xend-unix-path>
The location of the unix domain socket the xend-unix-server will use
to communicate with the management tools. Defaults to
I</var/lib/xend/xend-socket>.
=item I<xend-port>
The port that will be used by the http management server. Defaults to
I<8000>.
=item I<xend-relocation-port>
The port that will be used by the relocation server. Defaults to
I<8002>.
=item I<xend-address>
The address to which the http management server will bind. Defaults
to I<''> which means "all interfaces".
=item I<xend-relocation-address>
The address to which the relocation server will bind. Defaults to
I<''> which means "all interfaces".
=item I<console-limit>
The kilobyte buffer limit that will be enforced by the console server.
This limit is set per-domain, and is needed to prevent a single domain
from overwhelming the console server with massive amounts of data.
Defaults to I<1024>.
=item I<network-script>
The name of the script in I</etc/xen/scripts> that will be run to
setup the networking environment. This can be any name, but in
general is either I<network-bridge> or I<network-route>.
=item I<vif-script>
The name of the script in I</etc/xen/scripts> that will be run to
setup a virtual interface when it is created or destroyed. This needs
to (in general) work in unison with the I<network-script>.
=item I<dom0-min-mem>
This specifies the minimum number of megabytes that will be reserved
for Domain0. If this value is positive, Domain0 will be automatically
ballooned down to this limit to make space for new domains. If this
is set to 0, Domain0 will not be automatically ballooned.
=item I<dom0-cpus>
This specifies the number of CPUs that Domain0 will be allowed to use.
If the value is 0, all available CPUs will be used by Domain0.
=item I<enable-dump>
A boolean value that tells xend whether or not core dumps of guest
domains should be saved when a crash occurs. Defaults to I<no>.
=item I<external-migration-tool>
The name of an application or script that can handle external device
migration, such as for example virtual TPM migration. An example
script is I</etc/xen/scripts/external-device-migrate>.
=back
=head1 EXAMPLES
An example configuration with relocation enabled for the local network:
=over 4
(xend-relocation-server yes)
(xend-relocation-address 192.0.2.192)
(network-script network-bridge)
(vif-script vif-bridge)
(dom0-min-mem 0)
(dom0-cpus 0)
=back
=head1 CAVEATS
Note that relocation is currently unsecured and is very dangerous if
left enabled. No authentication is performed, and very little sanity
checking takes place. Enable at your own risk.
=head1 SEE ALSO
B<xend>(1)
=head1 AUTHOR
Dan Smith <danms@us.ibm.com>