xref: /xen/tools/examples/

Xen Control Tools - Examples
===================================

This directory contains example scripts and configurations for Xen.
For many operations you will either be able to use these scripts directly, or
incorporate code from them into your own scripts.

If you write a useful script and would like to share it, please do
send it (preferably with a little summary to go in this file) to
<xen-devel@lists.xenproject.org> so we can add it to this directory.

block               - called by xen-backend.agent to bind/unbind dev
block-common.sh     - sourced by block, block-*
block-enbd          - binds/unbinds network block devices
block-nbd           - binds/unbinds network block devices
cpupool             - example configuration script for 'xl cpupool-create'
external-device-migrate - called by xend for migrating external devices
locking.sh          - locking functions to prevent concurrent access to
                      critical sections inside script files
logging.sh          - logging function to log output using syslog
vif-bridge          - virtual network start/stop script in bridged mode
vif-common.sh       - sourced by vif-bridge
vif-nat             - xen virtual network start/stop script in NAT mode
vif-route           - xen virtual network start/stop script in routed mode
xen-hotplug-common.sh - sourced by vif-common.sh
xen-network-common.sh - sourced by vif-common.sh
xen-script-common.sh  - sourced by xen-hotplug-common.sh
oxenstored.conf     - configuration file for oxenstored
xl.conf             - configuration file for xl
xlexample.hvm       - a configuration script for creating a hvm domain with
                      'xl create'
xlexample.pvlinux   - a configuration script for creating a pv domain with
                      'xl create'

Command Incompatibilities
=========================

Known incompatibilities with various commands on various distributions, and
the workarounds we use.


brctl
-----

brctl show <bridge> fails on SLES9 SP2.  Workaround is to use brctl show
without arguments, and grep, though this would be difficult were you to need
to check for a specific bridge-interface pair, since brctl does not show the
bridge name on every line.


ifup / ifdown
-------------

SuSE requires an extra parameter to ifup, which is created by calling getcfg
appropriately.  See xen-network-common.sh for details.

Gentoo doesn't have ifup/ifdown; appropriate alternatives are defined in
xen-network-common.sh.


ip
--

Newer ip commands (from iproute2) do not accept the abbreviated syntax "ip r a
..." etc.  "ip route add ..." must be used instead.


sed
---

\s is not supported in regexps on Debian etch (sed 4.1.2), Ubuntu 4.10.  We
hand-craft character classes instead.

Last Index update Sat Jun 03 09:59:21 CST 2023