README
1Xen Control Tools - Examples
2===================================
3
4This directory contains example scripts and configurations for Xen.
5For many operations you will either be able to use these scripts directly, or
6incorporate code from them into your own scripts.
7
8If you write a useful script and would like to share it, please do
9send it (preferably with a little summary to go in this file) to
10<xen-devel@lists.sourceforge.net> so we can add it to this directory.
11
12block - called by xen-backend.agent to bind/unbind dev
13block-common.sh - sourced by block, block-*
14block-enbd - binds/unbinds network block devices
15block-nbd - binds/unbinds network block devices
16cpupool - example configuration script for 'xm cpupool-create'
17external-device-migrate - called by xend for migrating external devices
18locking.sh - locking functions to prevent concurrent access to
19 critical sections inside script files
20logging.sh - logging function to log output using syslog
21vif-bridge - virtual network start/stop script in bridged mode
22vif-common.sh - sourced by vif-bridge
23vif-nat - xen virtual network start/stop script in NAT mode
24vif-route - xen virtual network start/stop script in routed mode
25xen-backend.agent - calls block, vif-* scripts to add, remove, hotplug
26 devices
27xen-hotplug-common.sh - sourced by vif-common.sh
28xen-network-common.sh - sourced by vif-common.sh
29xen-script-common.sh - sourced by xen-hotplug-common.sh
30xmexample1 - example configuration script for 'xm create'
31xmexample2 - a more complex configuration script for 'xm create'
32xmexample3 - an advanced configuration script for 'xm create'
33 that utilizes the vmid
34xmexample.nbd - configuration script that uses NBD filesystems
35xmexample.hvm - a configuration script for creating a hvm domain with
36 'xm create'
37xmexample.hvm-stubdom - a configuration script for creating a hvm domain with
38 'xm create' that utilizes a stubdomain for device model
39xmexample.pv-grub - a configuration script for creating a domain with 'xm create'
40 which boots PV-GRUB.
41xmexample.vti - a configuration script for creating a domain on vti
42
README.incompatibilities
1Command Incompatibilities
2=========================
3
4Known incompatibilities with various commands on various distributions, and
5the workarounds we use.
6
7
8brctl
9-----
10
11brctl show <bridge> fails on SLES9 SP2. Workaround is to use brctl show
12without arguments, and grep, though this would be difficult were you to need
13to check for a specific bridge-interface pair, since brctl does not show the
14bridge name on every line.
15
16
17ifup / ifdown
18-------------
19
20SuSE requires an extra parameter to ifup, which is created by calling getcfg
21appropriately. See xen-network-common.sh for details.
22
23Gentoo doesn't have ifup/ifdown; appropriate alternatives are defined in
24xen-network-common.sh.
25
26
27ip
28--
29
30Newer ip commands (from iproute2) do not accept the abbreviated syntax "ip r a
31..." etc. "ip route add ..." must be used instead.
32
33
34sed
35---
36
37\s is not supported in regexps on Debian etch (sed 4.1.2), Ubuntu 4.10. We
38hand-craft character classes instead.
39