2008-04-24 01:08:31 +08:00
|
|
|
<html>
|
|
|
|
|
<body>
|
|
|
|
|
<h1>Network XML format</h1>
|
|
|
|
|
|
2008-05-07 07:23:55 +08:00
|
|
|
<ul id="toc">
|
|
|
|
|
</ul>
|
|
|
|
|
|
2008-04-29 22:08:08 +08:00
|
|
|
<p>
|
|
|
|
|
This page provides an introduction to the network XML format. For background
|
|
|
|
|
information on the concepts referred to here, consult the <a href="archnetwork.html">network driver architecture</a>
|
|
|
|
|
page.
|
|
|
|
|
</p>
|
|
|
|
|
|
2008-05-07 07:23:55 +08:00
|
|
|
<h2><a name="elements">Element and attribute overview</a></h2>
|
2008-04-29 22:08:08 +08:00
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
The root element required for all virtual networks is
|
|
|
|
|
named <code>network</code> and has no attributes.
|
2008-05-07 07:23:55 +08:00
|
|
|
The network XML format is available <span class="since">since 0.3.0</span>
|
2008-04-29 22:08:08 +08:00
|
|
|
</p>
|
|
|
|
|
|
2008-05-07 07:23:55 +08:00
|
|
|
<h3><a name="elementsMetadata">General metadata</a></h3>
|
2008-04-29 22:08:08 +08:00
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
The first elements provide basic metadata about the virtual
|
|
|
|
|
network.
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<pre>
|
|
|
|
|
<network>
|
|
|
|
|
<name>default</name>
|
|
|
|
|
<uuid>3e3fce45-4f53-4fa7-bb32-11f34168b82b</uuid>
|
|
|
|
|
...</pre>
|
|
|
|
|
|
|
|
|
|
<dl>
|
|
|
|
|
<dt><code>name</code></dt>
|
|
|
|
|
<dd>The content of the <code>name</code> element provides
|
2009-11-06 23:04:19 +08:00
|
|
|
a short name for the virtual network. This name should
|
|
|
|
|
consist only of alpha-numeric characters and is required
|
|
|
|
|
to be unique within the scope of a single host. It is
|
|
|
|
|
used to form the filename for storing the persistent
|
|
|
|
|
configuration file. <span class="since">Since 0.3.0</span></dd>
|
2008-04-29 22:08:08 +08:00
|
|
|
<dt><code>uuid</code></dt>
|
|
|
|
|
<dd>The content of the <code>uuid</code> element provides
|
2009-11-06 23:04:19 +08:00
|
|
|
a globally unique identifier for the virtual network.
|
|
|
|
|
The format must be RFC 4122 compliant, eg <code>3e3fce45-4f53-4fa7-bb32-11f34168b82b</code>.
|
|
|
|
|
If omitted when defining/creating a new network, a random
|
|
|
|
|
UUID is generated. <span class="since">Since 0.3.0</span></dd>
|
2008-04-29 22:08:08 +08:00
|
|
|
</dl>
|
|
|
|
|
|
2008-05-07 07:23:55 +08:00
|
|
|
<h3><a name="elementsConnect">Connectivity</a></h3>
|
2008-04-29 22:08:08 +08:00
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
The next set of elements control how a virtual network is
|
|
|
|
|
provided connectivity to the physical LAN (if at all).
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<pre>
|
|
|
|
|
...
|
2010-02-23 05:26:44 +08:00
|
|
|
<bridge name="virbr0" stp="on" delay="5"/>
|
2010-02-23 05:39:55 +08:00
|
|
|
<domain name="example"/>
|
2009-11-06 23:04:19 +08:00
|
|
|
<forward mode="nat" dev="eth0"/>
|
|
|
|
|
...</pre>
|
2008-04-29 22:08:08 +08:00
|
|
|
|
|
|
|
|
<dl>
|
|
|
|
|
<dt><code>bridge</code></dt>
|
|
|
|
|
<dd>The <code>name</code> attribute on the <code>bridge</code> element
|
2009-11-06 23:04:19 +08:00
|
|
|
defines the name of a bridge device which will be used to construct
|
|
|
|
|
the virtual network. The virtual machines will be connected to this
|
|
|
|
|
bridge device allowing them to talk to each other. The bridge device
|
|
|
|
|
may also be connected to the LAN. It is recommended that bridge
|
|
|
|
|
device names started with the prefix <code>vir</code>, but the name
|
|
|
|
|
<code>virbr0</code> is reserved for the "default" virtual network.
|
|
|
|
|
This element should always be provided when defining a new network.
|
2010-02-23 05:26:44 +08:00
|
|
|
Attribute <code>stp</code> specifies if Spanning Tree Protocol is
|
|
|
|
|
'on' or 'off' (default is 'on'). Attribute <code>delay</code> sets
|
|
|
|
|
the bridge's forward delay value in seconds (default is 0).
|
2009-11-06 23:04:19 +08:00
|
|
|
<span class="since">Since 0.3.0</span>
|
2008-04-29 22:08:08 +08:00
|
|
|
</dd>
|
2010-02-23 05:39:55 +08:00
|
|
|
<dt><code>domain</code></dt>
|
|
|
|
|
<dd>
|
|
|
|
|
The <code>name</code> attribute on the <code>domain</code> element
|
|
|
|
|
defines the DNS domain of the DHCP server. This element is optional.
|
|
|
|
|
<span class="since">Since 0.4.5</span>
|
|
|
|
|
</dd>
|
2008-04-29 22:08:08 +08:00
|
|
|
<dt><code>forward</code></dt>
|
|
|
|
|
<dd>Inclusion of the <code>forward</code> element indicates that
|
2009-11-06 23:04:19 +08:00
|
|
|
the virtual network is to be connected to the physical LAN. If
|
|
|
|
|
no attributes are set, NAT forwarding will be used for connectivity.
|
|
|
|
|
Firewall rules will allow forwarding to any other network device whether
|
|
|
|
|
ethernet, wireless, dialup, or VPN. If the <code>dev</code> attribute
|
|
|
|
|
is set, the firewall rules will restrict forwarding to the named
|
|
|
|
|
device only. If the <code>mode</code> attribute is set to <code>route</code>
|
|
|
|
|
then the traffic will not have NAT applied. This presumes that the
|
|
|
|
|
local LAN router has suitable routing table entries to return traffic
|
|
|
|
|
to this host. <span class="since">Since 0.3.0; 'mode' attribute since
|
2008-05-07 07:23:55 +08:00
|
|
|
0.4.2</span></dd>
|
2008-04-29 22:08:08 +08:00
|
|
|
</dl>
|
|
|
|
|
|
2008-05-07 07:23:55 +08:00
|
|
|
<h3><a name="elementsAddress">Addressing</a></h3>
|
2008-04-29 22:08:08 +08:00
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
The final set of elements define the IPv4 address range available,
|
|
|
|
|
and optionally enable DHCP sevices.
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<pre>
|
|
|
|
|
...
|
2009-11-06 23:04:19 +08:00
|
|
|
<ip address="192.168.122.1" netmask="255.255.255.0">
|
|
|
|
|
<dhcp>
|
|
|
|
|
<range start="192.168.122.100" end="192.168.122.254" />
|
|
|
|
|
<host mac="00:16:3e:77:e2:ed" name="foo.example.com" ip="192.168.122.10" />
|
|
|
|
|
<host mac="00:16:3e:3e:a9:1a" name="bar.example.com" ip="192.168.122.11" />
|
|
|
|
|
</dhcp>
|
|
|
|
|
</ip>
|
2008-04-29 22:08:08 +08:00
|
|
|
</network></pre>
|
|
|
|
|
|
|
|
|
|
<dl>
|
|
|
|
|
<dt><code>ip</code></dt>
|
|
|
|
|
<dd>The <code>address</code> attribute defines an IPv4 address in
|
2009-11-06 23:04:19 +08:00
|
|
|
dotted-decimal format, that will be configured on the bridge
|
|
|
|
|
device associated with the virtual network. To the guests this
|
|
|
|
|
address will be their default route. The <code>netmask</code>
|
|
|
|
|
attribute defines the significant bits of the network address,
|
|
|
|
|
again specified in dotted-decimal format. <span class="since">Since 0.3.0</span>
|
2009-09-22 04:50:25 +08:00
|
|
|
</dd><dt><code>tftp</code></dt><dd>Immediately within
|
2009-11-06 23:04:19 +08:00
|
|
|
the <code>ip</code> element there is an optional <code>tftp</code>
|
|
|
|
|
element. The presence of this element and of its attribute
|
|
|
|
|
<code>root</code> enables TFTP services. The attribute specifies
|
|
|
|
|
the path to the root directory served via TFTP.
|
|
|
|
|
<span class="since">Since 0.7.1</span>
|
2009-09-22 04:50:25 +08:00
|
|
|
</dd><dt><code>dhcp</code></dt><dd>Also within the <code>ip</code> element there is an
|
2009-11-06 23:04:19 +08:00
|
|
|
optional <code>dhcp</code> element. The presence of this element
|
|
|
|
|
enables DHCP services on the virtual network. It will further
|
|
|
|
|
contain one or more <code>range</code> elements.
|
|
|
|
|
<span class="since">Since 0.3.0</span>
|
2008-04-29 22:08:08 +08:00
|
|
|
</dd>
|
|
|
|
|
<dt><code>range</code></dt>
|
|
|
|
|
<dd>The <code>start</code> and <code>end</code> attributes on the
|
2009-11-06 23:04:19 +08:00
|
|
|
<code>range</code> element specify the boundaries of a pool of
|
|
|
|
|
IPv4 addresses to be provided to DHCP clients. These two addresses
|
|
|
|
|
must lie within the scope of the network defined on the parent
|
|
|
|
|
<code>ip</code> element. <span class="since">Since 0.3.0</span>
|
2008-04-29 22:08:08 +08:00
|
|
|
</dd>
|
2009-02-26 04:02:14 +08:00
|
|
|
<dt><code>host</code></dt>
|
|
|
|
|
<dd>Within the <code>dhcp</code> element there may be zero or more
|
2009-11-06 23:04:19 +08:00
|
|
|
<code>host</code> elements; these specify hosts which will be given
|
2009-02-26 04:02:14 +08:00
|
|
|
names and predefined IP addresses by the built-in DHCP server. Any
|
|
|
|
|
such element must specify the MAC address of the host to be assigned
|
2009-11-06 23:04:19 +08:00
|
|
|
a given name (via the <code>mac</code> attribute), the IP to be
|
2009-02-26 04:02:14 +08:00
|
|
|
assigned to that host (via the <code>ip</code> attribute), and the
|
2009-11-06 23:04:19 +08:00
|
|
|
name to be given that host by the DHCP server (via the
|
2009-02-26 04:02:14 +08:00
|
|
|
<code>name</code> attribute). <span class="since">Since 0.4.5</span>
|
2009-09-22 04:50:25 +08:00
|
|
|
</dd><dt><code>bootp</code></dt><dd>The optional <code>bootp</code>
|
2009-10-28 22:57:49 +08:00
|
|
|
element specifies BOOTP options to be provided by the DHCP server.
|
|
|
|
|
Two attributes are supported: <code>file</code> is mandatory and
|
|
|
|
|
gives the file to be used for the boot image; <code>server</code> is
|
|
|
|
|
optional and gives the address of the TFTP server from which the boot
|
|
|
|
|
image will be fetched. <code>server</code> defaults to the same host
|
|
|
|
|
that runs the DHCP server, as is the case when the <code>tftp</code>
|
|
|
|
|
element is used. The BOOTP options currently have to be the same
|
|
|
|
|
for all address ranges and statically assigned addresses.<span
|
|
|
|
|
class="since">Since 0.7.1 (<code>server</code> since 0.7.3).</span>
|
|
|
|
|
</dd>
|
2008-04-29 22:08:08 +08:00
|
|
|
</dl>
|
2008-04-24 01:08:31 +08:00
|
|
|
|
2008-05-07 07:23:55 +08:00
|
|
|
<h2><a name="examples">Example configuration</a></h2>
|
2008-04-24 01:08:31 +08:00
|
|
|
|
2008-05-07 07:23:55 +08:00
|
|
|
<h3><a name="examplesNAT">NAT based network</a></h3>
|
2008-04-24 01:08:31 +08:00
|
|
|
|
2008-04-29 22:08:08 +08:00
|
|
|
<p>
|
|
|
|
|
This example is the so called "default" virtual network. It is
|
|
|
|
|
provided and enabled out-of-the-box for all libvirt installations.
|
|
|
|
|
This is a configuration that allows guest OS to get outbound
|
|
|
|
|
connectivity regardless of whether the host uses ethernet, wireless,
|
|
|
|
|
dialup, or VPN networking without requiring any specific admin
|
|
|
|
|
configuration. In the absence of host networking, it at least allows
|
|
|
|
|
guests to talk directly to each other.
|
|
|
|
|
</p>
|
|
|
|
|
|
2008-04-24 01:08:31 +08:00
|
|
|
<pre>
|
|
|
|
|
<network>
|
2009-11-06 23:04:19 +08:00
|
|
|
<name>default</name>
|
|
|
|
|
<bridge name="virbr0" />
|
|
|
|
|
<forward mode="nat"/>
|
|
|
|
|
<ip address="192.168.122.1" netmask="255.255.255.0">
|
|
|
|
|
<dhcp>
|
|
|
|
|
<range start="192.168.122.2" end="192.168.122.254" />
|
|
|
|
|
</dhcp>
|
|
|
|
|
</ip>
|
2008-04-24 01:08:31 +08:00
|
|
|
</network></pre>
|
|
|
|
|
|
2008-05-07 07:23:55 +08:00
|
|
|
<h3><a name="examplesRoute">Routed network config</a></h3>
|
2008-04-24 01:08:31 +08:00
|
|
|
|
2008-04-29 22:08:08 +08:00
|
|
|
<p>
|
|
|
|
|
This is a variant on the default network which routes traffic
|
|
|
|
|
from the virtual network to the LAN without applying any NAT.
|
|
|
|
|
It requires that the IP address range be pre-configured in the
|
|
|
|
|
routing tables of the router on the host network. This example
|
|
|
|
|
further specifies that guest traffic may only go out via the
|
|
|
|
|
<code>eth1</code> host network device.
|
|
|
|
|
</p>
|
|
|
|
|
|
2008-04-24 01:08:31 +08:00
|
|
|
<pre>
|
|
|
|
|
<network>
|
2009-11-06 23:04:19 +08:00
|
|
|
<name>local</name>
|
|
|
|
|
<bridge name="virbr1" />
|
|
|
|
|
<forward mode="route" dev="eth1"/>
|
|
|
|
|
<ip address="192.168.122.1" netmask="255.255.255.0">
|
|
|
|
|
<dhcp>
|
|
|
|
|
<range start="192.168.122.2" end="192.168.122.254" />
|
|
|
|
|
</dhcp>
|
|
|
|
|
</ip>
|
2008-04-24 01:08:31 +08:00
|
|
|
</network></pre>
|
|
|
|
|
|
2008-05-07 07:23:55 +08:00
|
|
|
<h3><a name="examplesPrivate">Isolated network config</a></h3>
|
2008-04-24 01:08:31 +08:00
|
|
|
|
2008-04-29 22:08:08 +08:00
|
|
|
<p>
|
|
|
|
|
This variant provides a completely isolated private network
|
|
|
|
|
for guests. The guests can talk to each other, and the host
|
|
|
|
|
OS, but cannot reach any other machines on the LAN, due to
|
|
|
|
|
the omission of the <code>forward</code> element in the XML
|
|
|
|
|
description.
|
|
|
|
|
</p>
|
|
|
|
|
|
2008-04-24 01:08:31 +08:00
|
|
|
<pre>
|
|
|
|
|
<network>
|
2009-11-06 23:04:19 +08:00
|
|
|
<name>private</name>
|
|
|
|
|
<bridge name="virbr2" />
|
|
|
|
|
<ip address="192.168.152.1" netmask="255.255.255.0">
|
|
|
|
|
<dhcp>
|
|
|
|
|
<range start="192.168.152.2" end="192.168.152.254" />
|
|
|
|
|
</dhcp>
|
|
|
|
|
</ip>
|
2008-04-24 01:08:31 +08:00
|
|
|
</network></pre>
|
|
|
|
|
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
