openkylin
/
libvirt
mirror of https://gitee.com/openkylin/libvirt.git
9
0
Fork 0
Code Issues Projects Releases Wiki Activity
libvirt/docs/formatnetwork.html.in

310 lines
14 KiB
HTML
Raw Normal View History

Split website out into one file per page. APply new layout and styling
2008-04-24 01:08:31 +08:00
<html>
<body>
<h1>Network XML format</h1>
Added autogenerated TOC for network and storage XML reference docs
2008-05-07 07:23:55 +08:00
<ul id="toc">
</ul>
Added network XML docs
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>
Added autogenerated TOC for network and storage XML reference docs
2008-05-07 07:23:55 +08:00
<h2><a name="elements">Element and attribute overview</a></h2>
Added network XML docs
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.
Added autogenerated TOC for network and storage XML reference docs
2008-05-07 07:23:55 +08:00
The network XML format is available <span class="since">since 0.3.0</span>
Added network XML docs
2008-04-29 22:08:08 +08:00
</p>
Added autogenerated TOC for network and storage XML reference docs
2008-05-07 07:23:55 +08:00
<h3><a name="elementsMetadata">General metadata</a></h3>
Added network XML docs
2008-04-29 22:08:08 +08:00
<p>
The first elements provide basic metadata about the virtual
network.
</p>
<pre>
&lt;network&gt;
&lt;name&gt;default&lt;/name&gt;
&lt;uuid&gt;3e3fce45-4f53-4fa7-bb32-11f34168b82b&lt;/uuid&gt;
...</pre>
<dl>
<dt><code>name</code></dt>
<dd>The content of the <code>name</code> element provides
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
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>
Added network XML docs
2008-04-29 22:08:08 +08:00
<dt><code>uuid</code></dt>
<dd>The content of the <code>uuid</code> element provides
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
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>
Added network XML docs
2008-04-29 22:08:08 +08:00
</dl>
Added autogenerated TOC for network and storage XML reference docs
2008-05-07 07:23:55 +08:00
<h3><a name="elementsConnect">Connectivity</a></h3>
Added network XML docs
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>
...
docs: network: Document STP and delay attributes
2010-02-23 05:26:44 +08:00
&lt;bridge name="virbr0" stp="on" delay="5"/&gt;
docs: network: Document <domain> element
2010-02-23 05:39:55 +08:00
&lt;domain name="example"/&gt;
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 23:04:19 +08:00
&lt;forward mode="nat" dev="eth0"/&gt;
...</pre>
Added network XML docs
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
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
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.
docs: network: Document STP and delay attributes
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).
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 23:04:19 +08:00
<span class="since">Since 0.3.0</span>
Added network XML docs
2008-04-29 22:08:08 +08:00
</dd>
docs: network: Document <domain> element
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>
Added network XML docs
2008-04-29 22:08:08 +08:00
<dt><code>forward</code></dt>
<dd>Inclusion of the <code>forward</code> element indicates that
Turn on IPv6 support in the bridge_driver.c virtual network driver At this point everything is already in place to make IPv6 happen, we just need to add a few rules, remove some checks for IPv4-only, and document the changes to the XML on the website.
2010-12-17 04:50:01 +08:00
the virtual network is to be connected to the physical
LAN. the <code>mode</code> attribute determines the method of
forwarding; possible selections are 'nat' and 'route'. If mode
is not specified, NAT forwarding will be used for
connectivity. If a network has any IPv6 addresses defined,
even if <code>mode</code> is given as 'nat', the IPv6 traffic
will be forwarded using routing, since IPv6 has no concept of NAT.
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 23:04:19 +08:00
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
Added autogenerated TOC for network and storage XML reference docs
2008-05-07 07:23:55 +08:00
0.4.2</span></dd>
Added network XML docs
2008-04-29 22:08:08 +08:00
</dl>
Added autogenerated TOC for network and storage XML reference docs
2008-05-07 07:23:55 +08:00
<h3><a name="elementsAddress">Addressing</a></h3>
Added network XML docs
2008-04-29 22:08:08 +08:00
<p>
Give each virtual network bridge its own fixed MAC address This fixes https://bugzilla.redhat.com/show_bug.cgi?id=609463 The problem was that, since a bridge always acquires the MAC address of the connected interface with the numerically lowest MAC, as guests are started and stopped, it was possible for the MAC address to change over time, and this change in the network was being detected by Windows 7 (it sees the MAC of the default route change), so on each reboot it would bring up a dialog box asking about this "new network". The solution is to create a dummy tap interface with a MAC guaranteed to be lower than any guest interface's MAC, and attach that tap to the bridge as soon as it's created. Since all guest MAC addresses start with 0xFE, we can just generate a MAC with the standard "0x52, 0x54, 0" prefix, and it's guaranteed to always win (physical interfaces are never connected to these bridges, so we don't need to worry about competing numerically with them). Note that the dummy tap is never set to IFF_UP state - that's not necessary in order for the bridge to take its MAC, and not setting it to UP eliminates the clutter of having an (eg) "virbr0-nic" displayed in the output of the ifconfig command. I chose to not auto-generate the MAC address in the network XML parser, as there are likely to be consumers of that API that don't need or want to have a MAC address associated with the bridge. Instead, in bridge_driver.c when the network is being defined, if there is no MAC, one is generated. To account for virtual network configs that already exist when upgrading from an older version of libvirt, I've added a %post script to the specfile that searches for all network definitions in both the config directory (/etc/libvirt/qemu/networks) and the state directory (/var/lib/libvirt/network) that are missing a mac address, generates a random address, and adds it to the config (and a matching address to the state file, if there is one). docs/formatnetwork.html.in: document <mac address.../> docs/schemas/network.rng: add nac address to schema libvirt.spec.in: %post script to update existing networks src/conf/network_conf.[ch]: parse and format <mac address.../> src/libvirt_private.syms: export a couple private symbols we need src/network/bridge_driver.c: auto-generate mac address when needed, create dummy interface if mac address is present. tests/networkxml2xmlin/isolated-network.xml tests/networkxml2xmlin/routed-network.xml tests/networkxml2xmlout/isolated-network.xml tests/networkxml2xmlout/routed-network.xml: add mac address to some tests
2011-02-09 16:28:12 +08:00
The final set of elements define the addresses (IPv4 and/or
IPv6, as well as MAC) to be assigned to the bridge device
associated with the virtual network, and optionally enable DHCP
services.
Added network XML docs
2008-04-29 22:08:08 +08:00
</p>
<pre>
...
Give each virtual network bridge its own fixed MAC address This fixes https://bugzilla.redhat.com/show_bug.cgi?id=609463 The problem was that, since a bridge always acquires the MAC address of the connected interface with the numerically lowest MAC, as guests are started and stopped, it was possible for the MAC address to change over time, and this change in the network was being detected by Windows 7 (it sees the MAC of the default route change), so on each reboot it would bring up a dialog box asking about this "new network". The solution is to create a dummy tap interface with a MAC guaranteed to be lower than any guest interface's MAC, and attach that tap to the bridge as soon as it's created. Since all guest MAC addresses start with 0xFE, we can just generate a MAC with the standard "0x52, 0x54, 0" prefix, and it's guaranteed to always win (physical interfaces are never connected to these bridges, so we don't need to worry about competing numerically with them). Note that the dummy tap is never set to IFF_UP state - that's not necessary in order for the bridge to take its MAC, and not setting it to UP eliminates the clutter of having an (eg) "virbr0-nic" displayed in the output of the ifconfig command. I chose to not auto-generate the MAC address in the network XML parser, as there are likely to be consumers of that API that don't need or want to have a MAC address associated with the bridge. Instead, in bridge_driver.c when the network is being defined, if there is no MAC, one is generated. To account for virtual network configs that already exist when upgrading from an older version of libvirt, I've added a %post script to the specfile that searches for all network definitions in both the config directory (/etc/libvirt/qemu/networks) and the state directory (/var/lib/libvirt/network) that are missing a mac address, generates a random address, and adds it to the config (and a matching address to the state file, if there is one). docs/formatnetwork.html.in: document <mac address.../> docs/schemas/network.rng: add nac address to schema libvirt.spec.in: %post script to update existing networks src/conf/network_conf.[ch]: parse and format <mac address.../> src/libvirt_private.syms: export a couple private symbols we need src/network/bridge_driver.c: auto-generate mac address when needed, create dummy interface if mac address is present. tests/networkxml2xmlin/isolated-network.xml tests/networkxml2xmlin/routed-network.xml tests/networkxml2xmlout/isolated-network.xml tests/networkxml2xmlout/routed-network.xml: add mac address to some tests
2011-02-09 16:28:12 +08:00
&lt;mac address='00:16:3E:5D:C7:9E'/&gt;
Add TXT record support for virtual DNS service This commit introduces the <dns> element and <txt> record for the virtual DNS network. The DNS TXT record can be defined using following syntax in the network XML file: <dns> <txt name="example" value="example value" /> </dns> Also, the Relax-NG scheme has been altered to allow the texts without spaces only for the name element and some nitpicks about memory free'ing have been fixed by Laine so therefore I'm adding Laine to the SOB clause ;-) Signed-off-by: Michal Novotny <minovotn@redhat.com> Signed-off-by: Laine Stump <laine@laine.org>
2011-06-24 18:04:36 +08:00
&lt;dns&gt;
&lt;txt name="example" value="example value" /&gt;
&lt;/dns&gt;
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 23:04:19 +08:00
&lt;ip address="192.168.122.1" netmask="255.255.255.0"&gt;
&lt;dhcp&gt;
&lt;range start="192.168.122.100" end="192.168.122.254" /&gt;
&lt;host mac="00:16:3e:77:e2:ed" name="foo.example.com" ip="192.168.122.10" /&gt;
&lt;host mac="00:16:3e:3e:a9:1a" name="bar.example.com" ip="192.168.122.11" /&gt;
&lt;/dhcp&gt;
&lt;/ip&gt;
docs: add an IPv6 address to network XML examples It was just pointed out that, although I added documentation for the IPv6 additions to the network XML, I neglected to use those additions in the examples. This patch adds an IPv6 address to each of the examples except for the "default" network, since that is a faithful reproduction of the default network config that's automatically installed, which doesn't include any IPv6 address (for good reason - because there is no such thing as IPv6 NAT, there is no one IPv6 address that would work for all installations).
2011-04-07 22:50:43 +08:00
&lt;ip family="ipv6" address="2001:8794:ca2:2::1" prefix="64" /&gt;
Added network XML docs
2008-04-29 22:08:08 +08:00
&lt;/network&gt;</pre>
<dl>
Give each virtual network bridge its own fixed MAC address This fixes https://bugzilla.redhat.com/show_bug.cgi?id=609463 The problem was that, since a bridge always acquires the MAC address of the connected interface with the numerically lowest MAC, as guests are started and stopped, it was possible for the MAC address to change over time, and this change in the network was being detected by Windows 7 (it sees the MAC of the default route change), so on each reboot it would bring up a dialog box asking about this "new network". The solution is to create a dummy tap interface with a MAC guaranteed to be lower than any guest interface's MAC, and attach that tap to the bridge as soon as it's created. Since all guest MAC addresses start with 0xFE, we can just generate a MAC with the standard "0x52, 0x54, 0" prefix, and it's guaranteed to always win (physical interfaces are never connected to these bridges, so we don't need to worry about competing numerically with them). Note that the dummy tap is never set to IFF_UP state - that's not necessary in order for the bridge to take its MAC, and not setting it to UP eliminates the clutter of having an (eg) "virbr0-nic" displayed in the output of the ifconfig command. I chose to not auto-generate the MAC address in the network XML parser, as there are likely to be consumers of that API that don't need or want to have a MAC address associated with the bridge. Instead, in bridge_driver.c when the network is being defined, if there is no MAC, one is generated. To account for virtual network configs that already exist when upgrading from an older version of libvirt, I've added a %post script to the specfile that searches for all network definitions in both the config directory (/etc/libvirt/qemu/networks) and the state directory (/var/lib/libvirt/network) that are missing a mac address, generates a random address, and adds it to the config (and a matching address to the state file, if there is one). docs/formatnetwork.html.in: document <mac address.../> docs/schemas/network.rng: add nac address to schema libvirt.spec.in: %post script to update existing networks src/conf/network_conf.[ch]: parse and format <mac address.../> src/libvirt_private.syms: export a couple private symbols we need src/network/bridge_driver.c: auto-generate mac address when needed, create dummy interface if mac address is present. tests/networkxml2xmlin/isolated-network.xml tests/networkxml2xmlin/routed-network.xml tests/networkxml2xmlout/isolated-network.xml tests/networkxml2xmlout/routed-network.xml: add mac address to some tests
2011-02-09 16:28:12 +08:00
<dt><code>mac</code></dt>
<dd>The <code>address</code> attribute defines a MAC
(hardware) address formatted as 6 groups of 2-digit
hexadecimal numbers, the groups separated by colons
(eg, <code>"52:54:00:1C:DA:2F"</code>). This MAC address is
assigned to the bridge device when it is created. Generally
it is best to not specify a MAC address when creating a
network - in this case, if a defined MAC address is needed for
proper operation, libvirt will automatically generate a random
MAC address and save it in the config. Allowing libvirt to
generate the MAC address will assure that it is compatible
with the idiosyncrasies of the platform where libvirt is
running. <span class="since">Since 0.8.8</span>
</dd>
Added network XML docs
2008-04-29 22:08:08 +08:00
<dt><code>ip</code></dt>
<dd>The <code>address</code> attribute defines an IPv4 address in
Turn on IPv6 support in the bridge_driver.c virtual network driver At this point everything is already in place to make IPv6 happen, we just need to add a few rules, remove some checks for IPv4-only, and document the changes to the XML on the website.
2010-12-17 04:50:01 +08:00
dotted-decimal format, or an IPv6 address in standard
colon-separated hexadecimal format, that will be configured on
the bridge
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 23:04:19 +08:00
device associated with the virtual network. To the guests this
Turn on IPv6 support in the bridge_driver.c virtual network driver At this point everything is already in place to make IPv6 happen, we just need to add a few rules, remove some checks for IPv4-only, and document the changes to the XML on the website.
2010-12-17 04:50:01 +08:00
address will be their default route. For IPv4 addresses, the <code>netmask</code>
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 23:04:19 +08:00
attribute defines the significant bits of the network address,
Turn on IPv6 support in the bridge_driver.c virtual network driver At this point everything is already in place to make IPv6 happen, we just need to add a few rules, remove some checks for IPv4-only, and document the changes to the XML on the website.
2010-12-17 04:50:01 +08:00
again specified in dotted-decimal format. For IPv6 addresses,
and as an alternate method for IPv4 addresses, you can specify
the significant bits of the network address with the <code>prefix</code>
attribute, which is an integer (for example, <code>netmask='255.255.255.0'</code>
could also be given as <code>prefix='24'</code>. The <code>family</code>
attribute is used to specify the type of address - 'ipv4' or 'ipv6'; if no
<code>family</code> is given, 'ipv4' is assumed. A network can have more than
one of each family of address defined, but only a single address can have a
<code>dhcp</code> or <code>tftp</code> element. <span class="since">Since 0.3.0;
IPv6, multiple addresses on a single network, <code>family</code>, and
<code>prefix</code> since 0.8.7</span>
network: add 'bootp' and 'tftp' config Currently, libvirtd will start a dnsmasq process for the virtual network, but (aside from killing the dnsmasq process and replacing it), there's no way to define tftp boot options. This change introduces the appropriate tags to the dhcp configuration: <network> <name>default</name> <bridge name="virbr%d" /> <forward/> <ip address="192.168.122.1" netmask="255.255.255.0"> <tftp root="/var/lib/tftproot" /> <dhcp> <range start="192.168.122.2" end="192.168.122.254" /> <bootp file="pxeboot.img"/> </dhcp> </ip> </network> When the attributes are present, these are passed to the arguments to dnsmasq: dnsmasq [...] --enable-tftp --tftp-root /srv/tftp --dhcp-boot pxeboot.img ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^ from <tftp /> from <bootp /> At present, only local tftp servers are supported (ie, dnsmasq runs as the tftp server), but we could improve this in future by adding a server= attribute. Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com> 2009-09-21 Paolo Bonzini <pbonzini@redhat.com> Jeremy Kerr <jk@ozlabs.org> * docs/formatnetwork.html.in: Document new tags. * docs/formatnetwork.html: Regenerate. * docs/schemas/network.rng: Update. * src/network_conf.c (virNetworkDefFree): Free new fields. (virNetworkDHCPRangeDefParseXML): Parse <bootp>. (virNetworkIPParseXML): New, parsing <dhcp> and <tftp>. (virNetworkDefParseXML): Use virNetworkIPParseXML instead of virNetworkDHCPRangeDefParseXML. (virNetworkDefFormat): Pretty print new fields. * src/network_conf.h (struct _virNetworkDef): Add netboot fields. * src/network_driver.c (networkBuildDnsmasqArgv): Add TFTP and BOOTP arguments. * tests/Makefile.am (EXTRA_DIST): Add networkschemadata. * tests/networkschematest: Look in networkschemadata. * tests/networkschemadata/netboot-network.xml: New.
2009-09-22 04:50:25 +08:00
</dd><dt><code>tftp</code></dt><dd>Immediately within
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
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
Turn on IPv6 support in the bridge_driver.c virtual network driver At this point everything is already in place to make IPv6 happen, we just need to add a few rules, remove some checks for IPv4-only, and document the changes to the XML on the website.
2010-12-17 04:50:01 +08:00
the path to the root directory served via TFTP. <code>tftp</code> is not
supported for IPv6 addresses, can only be specified on a single IPv4 address
per network.
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 23:04:19 +08:00
<span class="since">Since 0.7.1</span>
Add TXT record support for virtual DNS service This commit introduces the <dns> element and <txt> record for the virtual DNS network. The DNS TXT record can be defined using following syntax in the network XML file: <dns> <txt name="example" value="example value" /> </dns> Also, the Relax-NG scheme has been altered to allow the texts without spaces only for the name element and some nitpicks about memory free'ing have been fixed by Laine so therefore I'm adding Laine to the SOB clause ;-) Signed-off-by: Michal Novotny <minovotn@redhat.com> Signed-off-by: Laine Stump <laine@laine.org>
2011-06-24 18:04:36 +08:00
</dd>
<dt><code>dns</code></dt><dd>
The dns element of a network contains configuration information for the
virtual network's DNS server. <span class="since">Since 0.9.3</span>
Currently supported elements are:
<dl>
<dt><code>txt</code></dt>
<dd>A <code>dns</code> element can have 0 or more <code>txt</code> elements.
Each txt element defines a DNS TXT record and has two attributes, both
required: a name that can be queried via dns, and a value that will be
returned when that name is queried. names cannot contain embedded spaces
or commas. value is a single string that can contain multiple values
separated by commas. <span class="since">Since 0.9.3</span>
</dd>
Network: Add support for DNS hosts definition to the network XML This commit introduces names definition for the DNS hosts file using the following syntax: <dns> <host ip="192.168.1.1"> <name>alias1</name> <name>alias2</name> </host> </dns> Some of the improvements and fixes were done by Laine Stump so I'm putting him into the SOB clause again ;-) Signed-off-by: Michal Novotny <minovotn@redhat.com> Signed-off-by: Laine Stump <laine@laine.org>
2011-06-24 18:04:40 +08:00
<dt><code>host</code></dt>
<dd>The <code>host</code> element within <code>dns</code> is the
definition of DNS hosts to be passed to the DNS service. The IP
address is identified by the <code>ip</code> attribute and the names
for that IP address are identified in the <code>hostname</code>
sub-elements of the <code>host</code> element.
<span class="since">Since 0.9.3</span>
</dd>
Add TXT record support for virtual DNS service This commit introduces the <dns> element and <txt> record for the virtual DNS network. The DNS TXT record can be defined using following syntax in the network XML file: <dns> <txt name="example" value="example value" /> </dns> Also, the Relax-NG scheme has been altered to allow the texts without spaces only for the name element and some nitpicks about memory free'ing have been fixed by Laine so therefore I'm adding Laine to the SOB clause ;-) Signed-off-by: Michal Novotny <minovotn@redhat.com> Signed-off-by: Laine Stump <laine@laine.org>
2011-06-24 18:04:36 +08:00
</dl>
</dd>
<dt><code>dhcp</code></dt>
<dd>Also within the <code>ip</code> element there is an
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
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
Turn on IPv6 support in the bridge_driver.c virtual network driver At this point everything is already in place to make IPv6 happen, we just need to add a few rules, remove some checks for IPv4-only, and document the changes to the XML on the website.
2010-12-17 04:50:01 +08:00
contain one or more <code>range</code> elements. The
<code>dhcp</code> element is not supported for IPv6, and
is only supported on a single IP address per network for IPv4.
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 23:04:19 +08:00
<span class="since">Since 0.3.0</span>
Added network XML docs
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
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
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>
Added network XML docs
2008-04-29 22:08:08 +08:00
</dd>
documenting static host IP assignments * docs/formatnetwork.html docs/formatnetwork.html.in: patch from Charles Duffy documenting static host IP assignments. daniel
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
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 23:04:19 +08:00
<code>host</code> elements; these specify hosts which will be given
documenting static host IP assignments * docs/formatnetwork.html docs/formatnetwork.html.in: patch from Charles Duffy documenting static host IP assignments. daniel
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
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 23:04:19 +08:00
a given name (via the <code>mac</code> attribute), the IP to be
documenting static host IP assignments * docs/formatnetwork.html docs/formatnetwork.html.in: patch from Charles Duffy documenting static host IP assignments. daniel
2009-02-26 04:02:14 +08:00
assigned to that host (via the <code>ip</code> attribute), and the
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 23:04:19 +08:00
name to be given that host by the DHCP server (via the
documenting static host IP assignments * docs/formatnetwork.html docs/formatnetwork.html.in: patch from Charles Duffy documenting static host IP assignments. daniel
2009-02-26 04:02:14 +08:00
<code>name</code> attribute). <span class="since">Since 0.4.5</span>
network: add 'bootp' and 'tftp' config Currently, libvirtd will start a dnsmasq process for the virtual network, but (aside from killing the dnsmasq process and replacing it), there's no way to define tftp boot options. This change introduces the appropriate tags to the dhcp configuration: <network> <name>default</name> <bridge name="virbr%d" /> <forward/> <ip address="192.168.122.1" netmask="255.255.255.0"> <tftp root="/var/lib/tftproot" /> <dhcp> <range start="192.168.122.2" end="192.168.122.254" /> <bootp file="pxeboot.img"/> </dhcp> </ip> </network> When the attributes are present, these are passed to the arguments to dnsmasq: dnsmasq [...] --enable-tftp --tftp-root /srv/tftp --dhcp-boot pxeboot.img ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^ from <tftp /> from <bootp /> At present, only local tftp servers are supported (ie, dnsmasq runs as the tftp server), but we could improve this in future by adding a server= attribute. Signed-off-by: Jeremy Kerr <jk@ozlabs.org> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com> 2009-09-21 Paolo Bonzini <pbonzini@redhat.com> Jeremy Kerr <jk@ozlabs.org> * docs/formatnetwork.html.in: Document new tags. * docs/formatnetwork.html: Regenerate. * docs/schemas/network.rng: Update. * src/network_conf.c (virNetworkDefFree): Free new fields. (virNetworkDHCPRangeDefParseXML): Parse <bootp>. (virNetworkIPParseXML): New, parsing <dhcp> and <tftp>. (virNetworkDefParseXML): Use virNetworkIPParseXML instead of virNetworkDHCPRangeDefParseXML. (virNetworkDefFormat): Pretty print new fields. * src/network_conf.h (struct _virNetworkDef): Add netboot fields. * src/network_driver.c (networkBuildDnsmasqArgv): Add TFTP and BOOTP arguments. * tests/Makefile.am (EXTRA_DIST): Add networkschemadata. * tests/networkschematest: Look in networkschemadata. * tests/networkschemadata/netboot-network.xml: New.
2009-09-22 04:50:25 +08:00
</dd><dt><code>bootp</code></dt><dd>The optional <code>bootp</code>
Add support for an external TFTP boot server This patch adds an optional attribute to the <bootp> tag, that allows to specify a TFTP server address other than the address of the DHCP server itself. This can be used to forward the BOOTP settings of the host down to the guest. This is something that configurations such as Xen's default network achieve naturally, but must be done manually for NAT. * docs/formatnetwork.html.in: Document new attribute. * docs/schemas/network.rng: Add it to schema. * src/conf/network_conf.h: Add it to struct. * src/conf/network_conf.c: Add it to parser and pretty printer. * src/network/bridge_driver.c: Put it in the dnsmasq command line. * tests/networkxml2xmlin/netboot-proxy-network.xml tests/networkxml2xmlout/netboot-proxy-network.xml tests/networkxml2xmltest.c: add new tests
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>
Added network XML docs
2008-04-29 22:08:08 +08:00
</dl>
Split website out into one file per page. APply new layout and styling
2008-04-24 01:08:31 +08:00
Added autogenerated TOC for network and storage XML reference docs
2008-05-07 07:23:55 +08:00
<h2><a name="examples">Example configuration</a></h2>
Split website out into one file per page. APply new layout and styling
2008-04-24 01:08:31 +08:00
Added autogenerated TOC for network and storage XML reference docs
2008-05-07 07:23:55 +08:00
<h3><a name="examplesNAT">NAT based network</a></h3>
Split website out into one file per page. APply new layout and styling
2008-04-24 01:08:31 +08:00
Added network XML docs
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>
Split website out into one file per page. APply new layout and styling
2008-04-24 01:08:31 +08:00
<pre>
&lt;network&gt;
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 23:04:19 +08:00
&lt;name&gt;default&lt;/name&gt;
&lt;bridge name="virbr0" /&gt;
&lt;forward mode="nat"/&gt;
&lt;ip address="192.168.122.1" netmask="255.255.255.0"&gt;
&lt;dhcp&gt;
&lt;range start="192.168.122.2" end="192.168.122.254" /&gt;
&lt;/dhcp&gt;
&lt;/ip&gt;
docs: add an IPv6 address to network XML examples It was just pointed out that, although I added documentation for the IPv6 additions to the network XML, I neglected to use those additions in the examples. This patch adds an IPv6 address to each of the examples except for the "default" network, since that is a faithful reproduction of the default network config that's automatically installed, which doesn't include any IPv6 address (for good reason - because there is no such thing as IPv6 NAT, there is no one IPv6 address that would work for all installations).
2011-04-07 22:50:43 +08:00
&lt;ip family="ipv6" address="2001:8794:ca2:2::1" prefix="64" /&gt;
Split website out into one file per page. APply new layout and styling
2008-04-24 01:08:31 +08:00
&lt;/network&gt;</pre>
Added autogenerated TOC for network and storage XML reference docs
2008-05-07 07:23:55 +08:00
<h3><a name="examplesRoute">Routed network config</a></h3>
Split website out into one file per page. APply new layout and styling
2008-04-24 01:08:31 +08:00
Added network XML docs
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>
Split website out into one file per page. APply new layout and styling
2008-04-24 01:08:31 +08:00
<pre>
&lt;network&gt;
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 23:04:19 +08:00
&lt;name&gt;local&lt;/name&gt;
&lt;bridge name="virbr1" /&gt;
&lt;forward mode="route" dev="eth1"/&gt;
&lt;ip address="192.168.122.1" netmask="255.255.255.0"&gt;
&lt;dhcp&gt;
&lt;range start="192.168.122.2" end="192.168.122.254" /&gt;
&lt;/dhcp&gt;
&lt;/ip&gt;
docs: add an IPv6 address to network XML examples It was just pointed out that, although I added documentation for the IPv6 additions to the network XML, I neglected to use those additions in the examples. This patch adds an IPv6 address to each of the examples except for the "default" network, since that is a faithful reproduction of the default network config that's automatically installed, which doesn't include any IPv6 address (for good reason - because there is no such thing as IPv6 NAT, there is no one IPv6 address that would work for all installations).
2011-04-07 22:50:43 +08:00
&lt;ip family="ipv6" address="2001:8794:ca2:2::1" prefix="64" /&gt;
Split website out into one file per page. APply new layout and styling
2008-04-24 01:08:31 +08:00
&lt;/network&gt;</pre>
Added autogenerated TOC for network and storage XML reference docs
2008-05-07 07:23:55 +08:00
<h3><a name="examplesPrivate">Isolated network config</a></h3>
Split website out into one file per page. APply new layout and styling
2008-04-24 01:08:31 +08:00
Added network XML docs
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>
Split website out into one file per page. APply new layout and styling
2008-04-24 01:08:31 +08:00
<pre>
&lt;network&gt;
Cleanup whitespace in docs This patch is the result of running the following command in the docs directory: sed -i 's/\t/ /g; s/\s*$//' *.html.in * docs/*.html.in:convert tabs into 8 spaces and remove trailing whitespace
2009-11-06 23:04:19 +08:00
&lt;name&gt;private&lt;/name&gt;
&lt;bridge name="virbr2" /&gt;
&lt;ip address="192.168.152.1" netmask="255.255.255.0"&gt;
&lt;dhcp&gt;
&lt;range start="192.168.152.2" end="192.168.152.254" /&gt;
&lt;/dhcp&gt;
&lt;/ip&gt;
docs: add an IPv6 address to network XML examples It was just pointed out that, although I added documentation for the IPv6 additions to the network XML, I neglected to use those additions in the examples. This patch adds an IPv6 address to each of the examples except for the "default" network, since that is a faithful reproduction of the default network config that's automatically installed, which doesn't include any IPv6 address (for good reason - because there is no such thing as IPv6 NAT, there is no one IPv6 address that would work for all installations).
2011-04-07 22:50:43 +08:00
&lt;ip family="ipv6" address="2001:8794:ca2:3::1" prefix="64" /&gt;
Split website out into one file per page. APply new layout and styling
2008-04-24 01:08:31 +08:00
&lt;/network&gt;</pre>
</body>
</html>