2013-05-03 18:25:37 +04:00
<?xml version="1.0" encoding="UTF-8"?>
2017-07-26 20:01:25 +03:00
<!DOCTYPE html>
2013-05-03 18:25:37 +04:00
< html xmlns = "http://www.w3.org/1999/xhtml" >
2008-04-23 21:08:31 +04:00
< body >
< h1 > Network XML format< / h1 >
2008-05-07 03:23:55 +04:00
< ul id = "toc" >
< / ul >
2008-04-29 18:08:08 +04:00
< p >
2017-05-15 15:16:54 +03:00
This page provides an introduction to the network XML format. For
background information on the concepts referred to here, consult the
< a href = "https://wiki.libvirt.org/page/Networking" > relevant wiki page< / a > .
2008-04-29 18:08:08 +04:00
< / p >
2017-07-26 17:52:42 +03:00
< h2 > < a id = "elements" > Element and attribute overview< / a > < / h2 >
2008-04-29 18:08:08 +04:00
< p >
The root element required for all virtual networks is
2012-08-07 00:17:58 +04:00
named < code > network< / code > and has no configurable attributes
(although < span class = "since" > since 0.10.0< / span > there is one
optional read-only attribute - when examining the live
configuration of a network, the
attribute < code > connections< / code > , if present, specifies the
number of guest interfaces currently connected via this
network). The network XML format is
available < span class = "since" > since 0.3.0< / span >
2008-04-29 18:08:08 +04:00
< / p >
2017-07-26 17:52:42 +03:00
< h3 > < a id = "elementsMetadata" > General metadata< / a > < / h3 >
2008-04-29 18:08:08 +04:00
< p >
The first elements provide basic metadata about the virtual
network.
< / p >
< pre >
2016-11-12 01:40:27 +03:00
< network ipv6='yes' trustGuestRxFilters='no'>
< name> default< /name>
< uuid> 3e3fce45-4f53-4fa7-bb32-11f34168b82b< /uuid>
< metadata>
< app1:foo xmlns:app1="http://app1.org/app1/"> ..< /app1:foo>
< app2:bar xmlns:app2="http://app1.org/app2/"> ..< /app2:bar>
< /metadata>
...< / pre >
2008-04-29 18:08:08 +04:00
< dl >
< dt > < code > name< / code > < / dt >
< dd > The content of the < code > name< / code > element provides
2009-11-06 18:04:19 +03: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 18:08:08 +04:00
< dt > < code > uuid< / code > < / dt >
< dd > The content of the < code > uuid< / code > element provides
2009-11-06 18:04:19 +03: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 >
2016-06-23 01:05:50 +03:00
< dd > The < code > metadata< / code > node can be used by applications to
store custom metadata in the form of XML nodes/trees. Applications
must use custom namespaces on their XML nodes/trees, with only
one top-level element per namespace (if the application needs
structure, they should have sub-elements to their namespace
element). < span class = "since" > Since 2.1.0< / span > < / dd >
2016-04-22 14:51:50 +03:00
< dt > < code > ipv6< / code > < / dt >
< dd > When set to < code > yes< / code > , the optional parameter
< code > ipv6< / code > enables
2012-12-03 20:13:36 +04:00
a network definition with no IPv6 gateway addresses specified
to have guest-to-guest communications. For further information,
see the example below for the example with no gateway addresses.
< span class = "since" > Since 1.0.1< / span > < / dd >
2016-04-22 14:51:50 +03:00
< dt > < code > trustGuestRxFilters< / code > < / dt >
2014-09-23 22:19:08 +04:00
< dd > The optional parameter < code > trustGuestRxFilters< / code > can
be used to set that attribute of the same name for each domain
interface connected to this network (< span class = "since" > since
1.2.10< / span > ). See
2017-01-23 14:24:37 +03:00
the < a href = "formatdomain.html#elementsNICS" > Network
2014-09-23 22:19:08 +04:00
interfaces< / a > section of the domain XML documentation for
more details. Note that an explicit setting of this attribute
in a portgroup or the individual domain interface will
override the setting in the network.< / dd >
2008-04-29 18:08:08 +04:00
< / dl >
2017-07-26 17:52:42 +03:00
< h3 > < a id = "elementsConnect" > Connectivity< / a > < / h3 >
2008-04-29 18:08:08 +04:00
< p >
The next set of elements control how a virtual network is
provided connectivity to the physical LAN (if at all).
< / p >
< pre >
2016-11-12 01:40:27 +03:00
...
< bridge name="virbr0" stp="on" delay="5" macTableManager="libvirt"/>
2017-01-23 05:23:48 +03:00
< mtu size="9000"/>
2016-11-12 01:40:27 +03:00
< domain name="example.com" localOnly="no"/>
< forward mode="nat" dev="eth0"/>
...< / pre >
2008-04-29 18:08:08 +04:00
< dl >
< dt > < code > bridge< / code > < / dt >
< dd > The < code > name< / code > attribute on the < code > bridge< / code > element
2009-11-06 18:04:19 +03: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
conf: new network bridge device attribute macTableManager
The macTableManager attribute of a network's bridge subelement tells
libvirt how the bridge's MAC address table (used to determine the
egress port for packets) is managed. In the default mode, "kernel",
management is left to the kernel, which usually determines entries in
part by turning on promiscuous mode on all ports of the bridge,
flooding packets to all ports when the correct destination is unknown,
and adding/removing entries to the fdb as it sees incoming traffic
from particular MAC addresses. In "libvirt" mode, libvirt turns off
learning and flooding on all the bridge ports connected to guest
domain interfaces, and adds/removes entries according to the MAC
addresses in the domain interface configurations. A side effect of
turning off learning and unicast_flood on the ports of a bridge is
that (with Linux kernel 3.17 and newer), the kernel can automatically
turn off promiscuous mode on one or more of the bridge's ports
(usually only the one interface that is used to connect the bridge to
the physical network). The result is better performance (because
packets aren't being flooded to all ports, and can be dropped earlier
when they are of no interest) and slightly better security (a guest
can still send out packets with a spoofed source MAC address, but will
only receive traffic intended for the guest interface's configured MAC
address).
The attribute looks like this in the configuration:
<network>
<name>test</name>
<bridge name='br0' macTableManager='libvirt'/>
...
This patch only adds the config knob, documentation, and test
cases. The functionality behind this knob is added in later patches.
2014-11-20 20:40:33 +03:00
may also be connected to the LAN. When defining
2011-08-10 09:41:19 +04:00
a new network with a < code > < forward> < / code > mode of
conf: new network bridge device attribute macTableManager
The macTableManager attribute of a network's bridge subelement tells
libvirt how the bridge's MAC address table (used to determine the
egress port for packets) is managed. In the default mode, "kernel",
management is left to the kernel, which usually determines entries in
part by turning on promiscuous mode on all ports of the bridge,
flooding packets to all ports when the correct destination is unknown,
and adding/removing entries to the fdb as it sees incoming traffic
from particular MAC addresses. In "libvirt" mode, libvirt turns off
learning and flooding on all the bridge ports connected to guest
domain interfaces, and adds/removes entries according to the MAC
addresses in the domain interface configurations. A side effect of
turning off learning and unicast_flood on the ports of a bridge is
that (with Linux kernel 3.17 and newer), the kernel can automatically
turn off promiscuous mode on one or more of the bridge's ports
(usually only the one interface that is used to connect the bridge to
the physical network). The result is better performance (because
packets aren't being flooded to all ports, and can be dropped earlier
when they are of no interest) and slightly better security (a guest
can still send out packets with a spoofed source MAC address, but will
only receive traffic intended for the guest interface's configured MAC
address).
The attribute looks like this in the configuration:
<network>
<name>test</name>
<bridge name='br0' macTableManager='libvirt'/>
...
This patch only adds the config knob, documentation, and test
cases. The functionality behind this knob is added in later patches.
2014-11-20 20:40:33 +03:00
2019-01-10 02:45:49 +03:00
"nat", "route", or "open" (or an isolated network with
conf: new network bridge device attribute macTableManager
The macTableManager attribute of a network's bridge subelement tells
libvirt how the bridge's MAC address table (used to determine the
egress port for packets) is managed. In the default mode, "kernel",
management is left to the kernel, which usually determines entries in
part by turning on promiscuous mode on all ports of the bridge,
flooding packets to all ports when the correct destination is unknown,
and adding/removing entries to the fdb as it sees incoming traffic
from particular MAC addresses. In "libvirt" mode, libvirt turns off
learning and flooding on all the bridge ports connected to guest
domain interfaces, and adds/removes entries according to the MAC
addresses in the domain interface configurations. A side effect of
turning off learning and unicast_flood on the ports of a bridge is
that (with Linux kernel 3.17 and newer), the kernel can automatically
turn off promiscuous mode on one or more of the bridge's ports
(usually only the one interface that is used to connect the bridge to
the physical network). The result is better performance (because
packets aren't being flooded to all ports, and can be dropped earlier
when they are of no interest) and slightly better security (a guest
can still send out packets with a spoofed source MAC address, but will
only receive traffic intended for the guest interface's configured MAC
address).
The attribute looks like this in the configuration:
<network>
<name>test</name>
<bridge name='br0' macTableManager='libvirt'/>
...
This patch only adds the config knob, documentation, and test
cases. The functionality behind this knob is added in later patches.
2014-11-20 20:40:33 +03:00
no < code > < forward> < / code > element), libvirt will
automatically generate a unique name for the bridge device if
none is given, and this name will be permanently stored in the
network configuration so that that the same name will be used
every time the network is started. For these types of networks
2019-01-10 02:45:49 +03:00
(nat, route, open, and isolated), a bridge name beginning with the
conf: new network bridge device attribute macTableManager
The macTableManager attribute of a network's bridge subelement tells
libvirt how the bridge's MAC address table (used to determine the
egress port for packets) is managed. In the default mode, "kernel",
management is left to the kernel, which usually determines entries in
part by turning on promiscuous mode on all ports of the bridge,
flooding packets to all ports when the correct destination is unknown,
and adding/removing entries to the fdb as it sees incoming traffic
from particular MAC addresses. In "libvirt" mode, libvirt turns off
learning and flooding on all the bridge ports connected to guest
domain interfaces, and adds/removes entries according to the MAC
addresses in the domain interface configurations. A side effect of
turning off learning and unicast_flood on the ports of a bridge is
that (with Linux kernel 3.17 and newer), the kernel can automatically
turn off promiscuous mode on one or more of the bridge's ports
(usually only the one interface that is used to connect the bridge to
the physical network). The result is better performance (because
packets aren't being flooded to all ports, and can be dropped earlier
when they are of no interest) and slightly better security (a guest
can still send out packets with a spoofed source MAC address, but will
only receive traffic intended for the guest interface's configured MAC
address).
The attribute looks like this in the configuration:
<network>
<name>test</name>
<bridge name='br0' macTableManager='libvirt'/>
...
This patch only adds the config knob, documentation, and test
cases. The functionality behind this knob is added in later patches.
2014-11-20 20:40:33 +03:00
prefix "virbr" is recommended (and that is what is
auto-generated), but not enforced.
2011-08-10 09:41:19 +04: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 18:04:19 +03:00
< span class = "since" > Since 0.3.0< / span >
conf: new network bridge device attribute macTableManager
The macTableManager attribute of a network's bridge subelement tells
libvirt how the bridge's MAC address table (used to determine the
egress port for packets) is managed. In the default mode, "kernel",
management is left to the kernel, which usually determines entries in
part by turning on promiscuous mode on all ports of the bridge,
flooding packets to all ports when the correct destination is unknown,
and adding/removing entries to the fdb as it sees incoming traffic
from particular MAC addresses. In "libvirt" mode, libvirt turns off
learning and flooding on all the bridge ports connected to guest
domain interfaces, and adds/removes entries according to the MAC
addresses in the domain interface configurations. A side effect of
turning off learning and unicast_flood on the ports of a bridge is
that (with Linux kernel 3.17 and newer), the kernel can automatically
turn off promiscuous mode on one or more of the bridge's ports
(usually only the one interface that is used to connect the bridge to
the physical network). The result is better performance (because
packets aren't being flooded to all ports, and can be dropped earlier
when they are of no interest) and slightly better security (a guest
can still send out packets with a spoofed source MAC address, but will
only receive traffic intended for the guest interface's configured MAC
address).
The attribute looks like this in the configuration:
<network>
<name>test</name>
<bridge name='br0' macTableManager='libvirt'/>
...
This patch only adds the config knob, documentation, and test
cases. The functionality behind this knob is added in later patches.
2014-11-20 20:40:33 +03:00
< p >
The < code > macTableManager< / code > attribute of the bridge
element is used to tell libvirt how the bridge's MAC address
table (used to determine the correct egress port for packets
based on destination MAC address) will be managed. In the
default < code > kernel< / code > setting, the kernel
automatically adds and removes entries, typically using
learning, flooding, and promiscuous mode on the bridge's
ports in order to determine the proper egress port for
packets. When < code > macTableManager< / code > is set
to < code > libvirt< / code > , libvirt disables kernel management
of the MAC table (in the case of the Linux host bridge, this
means enabling vlan_filtering on the bridge, and disabling
learning and unicast_filter for all bridge ports), and
explicitly adds/removes entries to the table according to
the MAC addresses in the domain interface configurations.
Allowing libvirt to manage the MAC table can improve
performance - with a Linux host bridge, for example, turning
off learning and unicast_flood on ports has its own
performance advantage, and can also lead to an additional
boost by permitting the kernel to automatically turn off
promiscuous mode on some ports of the bridge (in particular,
the port attaching the bridge to the physical
network). However, it can also cause some networking setups
to stop working (e.g. vlan tagging, multicast,
guest-initiated changes to MAC address) and is not supported
by older kernels.
< span class = "since" > Since 1.2.11, requires kernel 3.17 or
newer< / span >
< / p >
2019-01-10 00:51:31 +03:00
< p >
The optional < code > zone< / code > attribute of
the < code > bridge< / code > element is used to specify
the < a href = "https://firewalld.org" > firewalld< / a >
zone for the bridge of a network with < code > forward< / code >
mode of "nat", "route", "open", or one with
no < code > forward< / code > specified. By default, the bridges
of all virtual networks with these forward modes are placed
in the firewalld zone named "libvirt", which permits
incoming DNS, DHCP, TFTP, and SSH to the host from guests on
the network. This behavior can be changed either by
modifying the libvirt zone (using firewalld management
tools), or by placing the network in a different zone (which
will also be managed using firewalld tools).
< span class = "since" > Since 5.1.0< / span >
< / p >
2017-01-23 05:23:48 +03:00
< / dd >
conf: new network bridge device attribute macTableManager
The macTableManager attribute of a network's bridge subelement tells
libvirt how the bridge's MAC address table (used to determine the
egress port for packets) is managed. In the default mode, "kernel",
management is left to the kernel, which usually determines entries in
part by turning on promiscuous mode on all ports of the bridge,
flooding packets to all ports when the correct destination is unknown,
and adding/removing entries to the fdb as it sees incoming traffic
from particular MAC addresses. In "libvirt" mode, libvirt turns off
learning and flooding on all the bridge ports connected to guest
domain interfaces, and adds/removes entries according to the MAC
addresses in the domain interface configurations. A side effect of
turning off learning and unicast_flood on the ports of a bridge is
that (with Linux kernel 3.17 and newer), the kernel can automatically
turn off promiscuous mode on one or more of the bridge's ports
(usually only the one interface that is used to connect the bridge to
the physical network). The result is better performance (because
packets aren't being flooded to all ports, and can be dropped earlier
when they are of no interest) and slightly better security (a guest
can still send out packets with a spoofed source MAC address, but will
only receive traffic intended for the guest interface's configured MAC
address).
The attribute looks like this in the configuration:
<network>
<name>test</name>
<bridge name='br0' macTableManager='libvirt'/>
...
This patch only adds the config knob, documentation, and test
cases. The functionality behind this knob is added in later patches.
2014-11-20 20:40:33 +03:00
2017-01-23 05:23:48 +03:00
< dt > < code > mtu< / code > < / dt >
< dd >
The < code > size< / code > attribute of the < code > mtu>< / code >
element specifies the Maximum Transmission Unit (MTU) for the
network. < span class = "since" > Since 3.1.0< / span > . In the case
of a libvirt-managed network (one with forward mode
of < code > nat< / code > , < code > route< / code > , < code > open< / code > , or
no < code > forward< / code > element (i.e. an isolated network),
this will be the MTU assigned to the bridge device when
libvirt creates it, and thereafter also assigned to all tap
devices created to connect guest interfaces. Network types not
specifically mentioned here don't support having an MTU set in
the libvirt network config. If mtu size is unspecified, the
default setting for the type of device being used is assumed
(usually 1500).
2008-04-29 18:08:08 +04:00
< / dd >
2017-01-23 05:23:48 +03:00
2010-02-23 00:39:55 +03:00
< dt > < code > domain< / code > < / dt >
< dd >
2011-08-10 09:41:19 +04:00
The < code > name< / code > attribute on the < code > domain< / code >
element defines the DNS domain of the DHCP server. This
element is optional, and is only used for those networks with
a < code > < forward> < / code > mode of "nat" or "route" (or an
isolated network with no < code > < forward> < / code >
element). < span class = "since" > Since 0.4.5< / span >
2014-12-04 03:01:33 +03:00
< p >
If the optional < code > localOnly< / code > attribute on the
< code > domain< / code > element is "yes", then DNS requests under
this domain will only be resolved by the virtual network's own
DNS server - they will not be forwarded to the host's upstream
DNS server. If < code > localOnly< / code > is "no", and by
default, unresolved requests < b > will< / b > be forwarded.
< span class = "since" > Since 1.2.12< / span >
< / p >
2010-02-23 00:39:55 +03:00
< / dd >
2008-04-29 18:08:08 +04:00
< dt > < code > forward< / code > < / dt >
< dd > Inclusion of the < code > forward< / code > element indicates that
2010-12-16 23:50:01 +03:00
the virtual network is to be connected to the physical
2011-08-10 09:41:19 +04:00
LAN.< span class = "since" > Since 0.3.0.< / span >
The < code > mode< / code > attribute determines the method of
forwarding. If there is no < code > forward< / code > element, the
network will be isolated from any other network (unless a
guest connected to that network is acting as a router, of
course). The following are valid settings
for < code > mode< / code > (if there is a < code > forward< / code >
element but mode is not specified, < code > mode='nat'< / code > is
assumed):
< dl >
< dt > < code > nat< / code > < / dt >
< dd >
All traffic between guests connected to this network and
the physical network will be forwarded to the physical
network via the host's IP routing stack, after the guest's
IP address is translated to appear as the host machine's
public IP address (a.k.a. Network Address Translation, or
"NAT"). This allows multiple guests, all having access to
the physical network, on a host that is only allowed a
single public IP address. If a network has any IPv6
addresses defined, the IPv6 traffic will be forwarded
using plain routing, since IPv6 has no concept of NAT.
Firewall rules will allow outbound connections 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. Inbound connections from other networks are
all prohibited; all connections between guests on the same
network, and to/from the host to the guests, are
unrestricted and not NATed.< span class = "since" > Since
0.4.2< / span >
2013-02-19 14:44:14 +04:00
< p > < span class = "since" > Since 1.0.3< / span > it is possible to
2013-02-19 14:44:15 +04:00
specify a public IPv4 address and port range to be used for
the NAT by using the < code > < nat> < / code > subelement.
2015-02-18 17:36:45 +03:00
Note that all addresses from the range are used, not just those
that are in use on the host.
2013-02-19 14:44:15 +04:00
The address range is set with the < code > < address> < / code >
subelements and < code > start< / code > and < code > stop< / code >
attributes:
2013-02-21 13:32:36 +04:00
< / p >
2013-02-19 14:44:14 +04:00
< pre >
...
< forward mode='nat'>
< nat>
< address start='1.2.3.4' end='1.2.3.10'/>
< /nat>
< /forward>
2013-02-21 13:32:36 +04:00
...< / pre >
< p >
2013-09-05 13:32:19 +04:00
A single IPv4 address can be set by setting
2013-02-19 14:44:14 +04:00
< code > start< / code > and < code > end< / code > attributes to
the same value.
< / p >
2013-02-19 14:44:15 +04:00
< p >
The port range to be used for the < code > < nat> < / code > can
be set via the subelement < code > < port> < / code > :
2013-02-21 13:32:36 +04:00
< / p >
2013-02-19 14:44:15 +04:00
< pre >
...
< forward mode='nat'>
< nat>
< port start='500' end='1000'/>
< /nat>
< /forward>
2013-02-21 13:32:36 +04:00
...< / pre >
2011-08-10 09:41:19 +04:00
< / dd >
< dt > < code > route< / code > < / dt >
< dd >
Guest network traffic will be forwarded to the physical
network via the host's IP routing stack, but without
having NAT applied. Again, if the < code > dev< / code >
attribute is set, firewall rules will restrict forwarding
to the named device only. This presumes that the local LAN
router has suitable routing table entries to return
2011-10-20 23:26:30 +04:00
traffic to this host. All incoming and outgoing sessions
to guest on these networks are unrestricted. (To restrict
incoming traffic to a guest on a routed network, you can
configure < a href = "formatnwfilter.html" > nwfilter rules< / a >
on the guest's interfaces.)
< span class = "since" > Since 0.4.2< / span >
2011-08-10 09:41:19 +04:00
< / dd >
2016-08-11 02:09:55 +03:00
< dt > < code > open< / code > < / dt >
< dd >
As with mode='route', guest network traffic will be
forwarded to the physical network via the host's IP
routing stack, but there will be no firewall rules added
to either enable or prevent any of this traffic. When
forward='open' is set, the < code > dev< / code > attribute
cannot be set (because the forward dev is enforced with
firewall rules, and the purpose of forward='open' is to
have a forwarding mode where libvirt doesn't add any
firewall rules). This mode presumes that the local LAN
router has suitable routing table entries to return
traffic to this host, and that some other management
system has been used to put in place any necessary
firewall rules. Although no firewall rules will be added
for the network, it is of course still possible to add
restrictions for specific guests using
< a href = "formatnwfilter.html" > nwfilter rules< / a > on the
guests' interfaces.)
< span class = "since" > Since 2.2.0< / span >
< / dd >
2011-08-10 09:41:19 +04:00
< dt > < code > bridge< / code > < / dt >
< dd >
This network describes either 1) an existing host bridge
that was configured outside of libvirt (if
a < code > < bridge name='xyz'/> < / code > element has been
network: merge relevant virtualports rather than choosing one
One of the original ideas behind allowing a <virtualport> in an
interface definition as well as in the <network> definition *and*one
or more <portgroup>s within the network, was that guest-specific
parameteres (like instanceid and interfaceid) could be given in the
interface's virtualport, and more general things (portid, managerid,
etc) could be given in the network and/or portgroup, with all the bits
brought together at guest startup time and combined into a single
virtualport to be used by the guest. This was somehow overlooked in
the implementation, though - it simply picks the "most specific"
virtualport, and uses the entire thing, with no attempt to merge in
details from the others.
This patch uses virNetDevVPortProfileMerge3() to combine the three
possible virtualports into one, then uses
virNetDevVPortProfileCheck*() to verify that the resulting virtualport
type is appropriate for the type of network, and that all the required
attributes for that type are present.
An example of usage is this: assuming a <network> definitions on host
ABC of:
<network>
<name>testA</name>
...
<virtualport type='openvswitch'/>
...
<portgroup name='engineering'>
<virtualport>
<parameters profileid='eng'/>
</virtualport>
</portgroup>
<portgroup name='sales'>
<virtualport>
<parameters profileid='sales'/>
</virtualport>
</portgroup>
</network>
and the same <network> on host DEF of:
<network>
<name>testA</name>
...
<virtualport type='802.1Qbg'>
<parameters typeid="1193047" typeidversion="2"/>
</virtualport>
...
<portgroup name='engineering'>
<virtualport>
<parameters managerid="11"/>
</virtualport>
</portgroup>
<portgroup name='sales'>
<virtualport>
<parameters managerid="55"/>
</virtualport>
</portgroup>
</network>
and a guest <interface> definition of:
<interface type='network'>
<source network='testA' portgroup='sales'/>
<virtualport>
<parameters instanceid="09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f"
interfaceid="09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f"\>
</virtualport>
...
</interface>
If the guest was started on host ABC, the <virtualport> used would be:
<virtualport type='openvswitch'>
<parameters interfaceid='09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f'
profileid='sales'/>
</virtualport>
but if that guest was started on host DEF, the <virtualport> would be:
<virtualport type='802.1Qbg'>
<parameters instanceid="09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f"
typeid="1193047" typeidversion="2"
managerid="55"/>
</virtualport>
Additionally, if none of the involved <virtualport>s had a specified type
(this includes cases where no virtualport is given at all),
2012-08-02 22:10:00 +04:00
specified, < span class = "since" > Since 0.9.4< / span > ), 2) an
existing Open vSwitch bridge that was configured outside of
libvirt (if both a < code > < bridge name='xyz'/> < / code >
element < b > and< / b > a < code > < virtualport
type='openvswitch'/> < / code > have been
specified < span class = "since" > Since 0.10.0< / span > ) 3) an
interface or group of interfaces to be used for a "direct"
connection via macvtap using macvtap's "bridge" mode (if
the forward element has one or
more < code > < interface> < / code >
subelements, < span class = "since" > Since 0.9.4< / span > )
2011-08-10 09:41:19 +04:00
(see < a href = "formatdomain.html#elementsNICSDirect" > Direct
attachment to physical interface< / a > for descriptions of
the various macvtap modes). libvirt doesn't attempt to
manage the bridge interface at all, thus
the < code > < bridge> < / code > element's < code > stp< / code >
and < code > delay< / code > attributes are not allowed; no
iptables rules, IP addresses, or DHCP/DNS services are
added; at the IP level, the guest interface appears to be
directly connected to the physical
interface.< span class = "since" > Since 0.9.4< / span >
< / dd >
< dt > < code > private< / code > < / dt >
< dd >
This network uses a macvtap "direct" connection in
"private" mode to connect each guest to the network. The
physical interface to be used will be picked from among
those listed in < code > < interface> < / code > subelements
of the < code > < forward> < / code > element; when using
802.1Qbh mode (as indicated by
the < code > < virtualport> < / code > type attribute - note
that this requires an 802.1Qbh-capable hardware switch),
each physical interface can only be in use by a single
guest interface at a time; in modes other than 802.1Qbh,
multiple guest interfaces can share each physical
interface (libvirt will attempt to balance usage between
all available interfaces).< span class = "since" > Since
0.9.4< / span >
< / dd >
< dt > < code > vepa< / code > < / dt >
< dd >
This network uses a macvtap "direct" connection in "vepa"
mode to connect each guest to the network (this requires
that the physical interfaces used be connected to a
vepa-capable hardware switch. The physical interface to be
used will be picked from among those listed
in < code > < interface> < / code > subelements of
the < code > < forward> < / code > element; multiple guest
interfaces can share each physical interface (libvirt will
attempt to balance usage between all available
interfaces).< span class = "since" > Since 0.9.4< / span >
< / dd >
< dt > < code > passthrough< / code > < / dt >
< dd >
This network uses a macvtap "direct" connection in
"passthrough" mode to connect each guest to the network
(note that this is < i > not< / i > the same thing as "PCI
passthrough"). The physical interface to be used will be
picked from among those listed
in < code > < interface> < / code > subelements of
the < code > < forward> < / code > element. Each physical
interface can only be in use by a single guest interface
at a time, so libvirt will keep track of which interfaces
are currently in use, and only assign unused interfaces
(if there are no available physical interfaces when a
domain interface is being attached, an error will be
logged, and the operation causing the attach will fail
(usually either a domain start, or a hotplug interface
attach to a domain).< span class = "since" > Since 0.9.4< / span >
< / dd >
2012-08-16 19:42:31 +04:00
< dt > < code > hostdev< / code > < / dt >
< dd >
This network facilitates PCI Passthrough of a network
device. A network device is chosen from the interface
pool and directly assigned to the guest using generic
device passthrough, after first optionally setting the
device's MAC address and vlan tag to the configured value,
and optionally associating the device with an 802.1Qbh
capable switch using a < code > < virtualport> < / code >
element. Note that - due to limitations in standard
single-port PCI ethernet card driver design - only SR-IOV
(Single Root I/O Virtualization) virtual function (VF)
devices can be assigned in this manner; to assign a
standard single-port PCI or PCIe ethernet card to a guest,
2014-12-05 12:38:46 +03:00
use the traditional < code > < hostdev> < / code > device
2012-08-16 19:42:31 +04:00
definition. < span class = "since" > Since 0.10.0< / span >
2013-03-15 23:15:14 +04:00
< p >
2014-04-16 13:23:02 +04:00
To force use of a particular type of device assignment,
a < forward type='hostdev'> interface can have an
optional < code > driver< / code > sub-element with
a < code > name< / code > attribute set to either "vfio" (VFIO
is a new method of device assignment that is compatible
with UEFI Secure Boot) or "kvm" (the legacy device
assignment handled directly by the KVM kernel module)
< span class = "since" > Since 1.0.5 (QEMU and KVM only,
requires kernel 3.6 or newer)< / span > . When specified,
device assignment will fail if the requested method of
device assignment isn't available on the host. When not
specified, the default is "vfio" on systems where the
VFIO driver is available and loaded, and "kvm" on older
systems, or those where the VFIO driver hasn't been
loaded < span class = "since" > Since 1.1.3< / span > (prior to
that the default was always "kvm").
2013-03-15 23:15:14 +04:00
< / p >
2012-08-16 19:42:31 +04:00
< p > Note that this "intelligent passthrough" of network
devices is very similar to the functionality of a
2014-12-05 12:38:46 +03:00
standard < code > < hostdev> < / code > device, the
2012-08-16 19:42:31 +04:00
difference being that this method allows specifying a MAC
2014-12-05 12:38:46 +03:00
address, vlan tag, and < code > < virtualport> < / code >
2012-08-16 19:42:31 +04:00
for the passed-through device. If these capabilities are
not required, if you have a standard single-port PCI,
PCIe, or USB network card that doesn't support SR-IOV (and
hence would anyway lose the configured MAC address during
reset after being assigned to the guest domain), or if you
are using a version of libvirt older than 0.10.0, you
should use a standard
< code > < hostdev> < / code > device definition in the
domain's configuration to assign the device to the guest
instead of defining an < code > < interface
type='network'> < / code > pointing to a network
with < code > < forward mode='hostdev'/> < / code > .
< / p >
< / dd >
2011-08-10 09:41:19 +04:00
< / dl >
As mentioned above, a < code > < forward> < / code > element can
have multiple < code > < interface> < / code > subelements, each
one giving the name of a physical interface that can be used
2011-10-14 22:35:32 +04:00
for this network < span class = "since" > Since 0.9.4< / span > :
2011-08-10 09:41:19 +04:00
< pre >
...
< forward mode='passthrough'>
< interface dev='eth10'/>
< interface dev='eth11'/>
< interface dev='eth12'/>
< interface dev='eth13'/>
< interface dev='eth14'/>
< /forward>
...
< / pre >
2012-08-07 00:17:58 +04:00
< p >
< span class = "since" > since 0.10.0< / span > ,
< code > < interface> < / code > also has an optional read-only
attribute - when examining the live configuration of a
network, the attribute < code > connections< / code > , if present,
specifies the number of guest interfaces currently connected
via this physical interface.
< / p >
< p >
Additionally, < span class = "since" > since 0.9.10< / span > , libvirt
allows a shorthand for specifying all virtual interfaces
associated with a single physical function, by using
the < code > < pf> < / code > subelement to call out the
corresponding physical interface associated with multiple
virtual interfaces:
< / p >
2011-12-14 14:50:23 +04:00
< pre >
...
< forward mode='passthrough'>
< pf dev='eth0'/>
< /forward>
...
< / pre >
< p > When a guest interface is being constructed, libvirt will pick
2011-08-10 09:41:19 +04:00
an interface from this list to use for the connection. In
modes where physical interfaces can be shared by multiple
guest interfaces, libvirt will choose the interface that
currently has the least number of connections. For those modes
that do not allow sharing of the physical device (in
particular, 'passthrough' mode, and 'private' mode when using
802.1Qbh), libvirt will choose an unused physical interface
2011-12-14 14:50:23 +04:00
or, if it can't find an unused interface, fail the operation.< / p >
2012-08-16 19:42:31 +04:00
< p >
< span class = "since" > since 0.10.0< / span > When using forward
mode 'hostdev', the interface pool is specified with a list
of < code > < address> < / code > elements, each of which has
2014-12-05 12:38:46 +03:00
< code > < type> < / code > (must always be < code > 'pci'< / code > ),
2012-08-16 19:42:31 +04:00
< code > < domain> < / code > , < code > < bus> < / code > ,
2014-12-05 12:38:46 +03:00
< code > < slot> < / code > and < code > < function> < / code >
2012-08-16 19:42:31 +04:00
attributes.
< / p >
< pre >
...
< forward mode='hostdev' managed='yes'>
2013-03-15 23:15:14 +04:00
< driver name='vfio'/>
2012-08-16 19:42:31 +04:00
< address type='pci' domain='0' bus='4' slot='0' function='1'/>
< address type='pci' domain='0' bus='4' slot='0' function='2'/>
< address type='pci' domain='0' bus='4' slot='0' function='3'/>
< /forward>
...
< / pre >
Alternatively the interface pool can also be defined using a
single physical function < code > < pf> < / code > subelement to
call out the corresponding physical interface associated with
multiple virtual interfaces (similar to passthrough mode):
< pre >
...
< forward mode='hostdev' managed='yes'>
< pf dev='eth0'/>
< /forward>
...
< / pre >
2011-08-10 09:41:19 +04:00
< / dd >
2008-04-29 18:08:08 +04:00
< / dl >
2017-07-26 17:52:42 +03:00
< h5 > < a id = "elementQoS" > Quality of service< / a > < / h5 >
2011-07-22 18:07:23 +04:00
< pre >
...
< forward mode='nat' dev='eth0'/>
< b > < bandwidth>
< inbound average='1000' peak='5000' burst='5120'/>
< outbound average='128' peak='256' burst='256'/>
< /bandwidth> < / b >
...< / pre >
< p >
network: disallow <bandwidth>/<mac> for bridged/macvtap/hostdev networks
https://bugzilla.redhat.com/show_bug.cgi?id=1057321
pointed out that we weren't honoring the <bandwidth> element in
libvirt networks using <forward mode='bridge'/>. In fact, these
networks are just a method of giving a libvirt network name to an
existing Linux host bridge on the system, and libvirt doesn't have
enough information to know where to set such limits. We are working on
a method of supporting network bandwidths for some specific cases of
<forward mode='bridge'/>, but currently libvirt doesn't support it. So
the proper thing to do now is just log an error when someone tries to
put a <bandwidth> element in that type of network. (It's unclear if we
will be able to do proper bandwidth limiting for macvtap networks, and
most definitely we will not be able to support it for hostdev
networks).
While looking through the network XML documentation and comparing it
to the networkValidate function, I noticed that we also ignore the
presence of a mac address in the config in the same cases, rather than
failing so that the user will understand that their desired action has
not been taken.
This patch updates networkValidate() (which is called any time a
persistent network is defined, or a transient network created) to log
an error and fail if it finds either a <bandwidth> or <mac> element
and the network forward mode is anything except 'route'. 'nat', or
nothing. (Yes, neither of those elements is acceptable for any macvtap
mode, nor for a hostdev network).
NB: This does *not* cause failure to start any existing network that
contains one of those elements, so someone might have erroneously
defined such a network in the past, and that network will continue to
function unmodified. I considered it too disruptive to suddenly break
working configs on the next reboot after a libvirt upgrade.
2014-01-24 15:58:05 +04:00
The < code > < bandwidth> < / code > element allows setting
2014-02-13 00:33:02 +04:00
quality of service for a particular network
(< span class = "since" > since 0.9.4< / span > ). Setting
< code > bandwidth< / code > for a network is supported only
for networks with a < code > < forward> < / code > mode
network: disallow <bandwidth>/<mac> for bridged/macvtap/hostdev networks
https://bugzilla.redhat.com/show_bug.cgi?id=1057321
pointed out that we weren't honoring the <bandwidth> element in
libvirt networks using <forward mode='bridge'/>. In fact, these
networks are just a method of giving a libvirt network name to an
existing Linux host bridge on the system, and libvirt doesn't have
enough information to know where to set such limits. We are working on
a method of supporting network bandwidths for some specific cases of
<forward mode='bridge'/>, but currently libvirt doesn't support it. So
the proper thing to do now is just log an error when someone tries to
put a <bandwidth> element in that type of network. (It's unclear if we
will be able to do proper bandwidth limiting for macvtap networks, and
most definitely we will not be able to support it for hostdev
networks).
While looking through the network XML documentation and comparing it
to the networkValidate function, I noticed that we also ignore the
presence of a mac address in the config in the same cases, rather than
failing so that the user will understand that their desired action has
not been taken.
This patch updates networkValidate() (which is called any time a
persistent network is defined, or a transient network created) to log
an error and fail if it finds either a <bandwidth> or <mac> element
and the network forward mode is anything except 'route'. 'nat', or
nothing. (Yes, neither of those elements is acceptable for any macvtap
mode, nor for a hostdev network).
NB: This does *not* cause failure to start any existing network that
contains one of those elements, so someone might have erroneously
defined such a network in the past, and that network will continue to
function unmodified. I considered it too disruptive to suddenly break
working configs on the next reboot after a libvirt upgrade.
2014-01-24 15:58:05 +04:00
of < code > route< / code > , < code > nat< / code > , or no mode at all
2014-02-13 00:33:02 +04:00
(i.e. an "isolated" network). Setting < code > bandwidth< / code >
network: disallow <bandwidth>/<mac> for bridged/macvtap/hostdev networks
https://bugzilla.redhat.com/show_bug.cgi?id=1057321
pointed out that we weren't honoring the <bandwidth> element in
libvirt networks using <forward mode='bridge'/>. In fact, these
networks are just a method of giving a libvirt network name to an
existing Linux host bridge on the system, and libvirt doesn't have
enough information to know where to set such limits. We are working on
a method of supporting network bandwidths for some specific cases of
<forward mode='bridge'/>, but currently libvirt doesn't support it. So
the proper thing to do now is just log an error when someone tries to
put a <bandwidth> element in that type of network. (It's unclear if we
will be able to do proper bandwidth limiting for macvtap networks, and
most definitely we will not be able to support it for hostdev
networks).
While looking through the network XML documentation and comparing it
to the networkValidate function, I noticed that we also ignore the
presence of a mac address in the config in the same cases, rather than
failing so that the user will understand that their desired action has
not been taken.
This patch updates networkValidate() (which is called any time a
persistent network is defined, or a transient network created) to log
an error and fail if it finds either a <bandwidth> or <mac> element
and the network forward mode is anything except 'route'. 'nat', or
nothing. (Yes, neither of those elements is acceptable for any macvtap
mode, nor for a hostdev network).
NB: This does *not* cause failure to start any existing network that
contains one of those elements, so someone might have erroneously
defined such a network in the past, and that network will continue to
function unmodified. I considered it too disruptive to suddenly break
working configs on the next reboot after a libvirt upgrade.
2014-01-24 15:58:05 +04:00
is < b > not< / b > supported for forward modes
of < code > bridge< / code > , < code > passthrough< / code > , < code > private< / code > ,
2014-02-13 00:33:02 +04:00
or < code > hostdev< / code > . Attempts to do this will lead to
a failure to define the network or to create a transient network.
< / p >
< p >
The < code > < bandwidth> < / code > element can only be a
subelement of a domain's < code > < interface> < / code > , a
subelement of a < code > < network> < / code > , or a subelement of
a < code > < portgroup> < / code > in a < code > < network> < / code > .
< / p >
< p >
As a subelement of a domain's < code > < interface> < / code > ,
the bandwidth only applies to that one interface of the domain.
As a subelement of a < code > < network> < / code > , the bandwidth
is a total aggregate bandwidth to/from all guest interfaces attached
to that network, < b > not< / b > to each guest interface individually.
If a domain's < code > < interface> < / code > has
< code > < bandwidth> < / code > element values higher
than the aggregate for the entire network, then the aggregate
bandwidth for the < code > < network> < / code > takes precedence.
This is because the two choke points are independent of each other
where the domain's < code > < interface> < / code > bandwidth control
is applied on the interface's tap device, while the
< code > < network> < / code > bandwidth control is applied on the
interface part of the bridge device created for that network.
< / p >
< p >
As a subelement of a
< code > < portgroup> < / code > in a < code > < network> < / code > ,
if a domain's < code > < interface> < / code > has a
< code > portgroup< / code > attribute in its
< code > < source> < / code > element < b > and< / b > if the
< code > < interface> < / code >
itself has no < code > < bandwidth> < / code > element, then the
< code > < bandwidth> < / code > element of the portgroup will be
applied individually to each guest interface defined to be a
member of that portgroup. Any < code > < bandwidth> < / code >
element in the domain's < code > < interface> < / code > definition
will override the setting in the portgroup
(< span class = "since" > since 1.0.1< / span > ).
network: disallow <bandwidth>/<mac> for bridged/macvtap/hostdev networks
https://bugzilla.redhat.com/show_bug.cgi?id=1057321
pointed out that we weren't honoring the <bandwidth> element in
libvirt networks using <forward mode='bridge'/>. In fact, these
networks are just a method of giving a libvirt network name to an
existing Linux host bridge on the system, and libvirt doesn't have
enough information to know where to set such limits. We are working on
a method of supporting network bandwidths for some specific cases of
<forward mode='bridge'/>, but currently libvirt doesn't support it. So
the proper thing to do now is just log an error when someone tries to
put a <bandwidth> element in that type of network. (It's unclear if we
will be able to do proper bandwidth limiting for macvtap networks, and
most definitely we will not be able to support it for hostdev
networks).
While looking through the network XML documentation and comparing it
to the networkValidate function, I noticed that we also ignore the
presence of a mac address in the config in the same cases, rather than
failing so that the user will understand that their desired action has
not been taken.
This patch updates networkValidate() (which is called any time a
persistent network is defined, or a transient network created) to log
an error and fail if it finds either a <bandwidth> or <mac> element
and the network forward mode is anything except 'route'. 'nat', or
nothing. (Yes, neither of those elements is acceptable for any macvtap
mode, nor for a hostdev network).
NB: This does *not* cause failure to start any existing network that
contains one of those elements, so someone might have erroneously
defined such a network in the past, and that network will continue to
function unmodified. I considered it too disruptive to suddenly break
working configs on the next reboot after a libvirt upgrade.
2014-01-24 15:58:05 +04:00
< / p >
< p >
Incoming and outgoing traffic can be shaped independently. The
2014-02-13 00:33:02 +04:00
< code > bandwidth< / code > element can have at most one
< code > inbound< / code > and at most one < code > outbound< / code >
network: disallow <bandwidth>/<mac> for bridged/macvtap/hostdev networks
https://bugzilla.redhat.com/show_bug.cgi?id=1057321
pointed out that we weren't honoring the <bandwidth> element in
libvirt networks using <forward mode='bridge'/>. In fact, these
networks are just a method of giving a libvirt network name to an
existing Linux host bridge on the system, and libvirt doesn't have
enough information to know where to set such limits. We are working on
a method of supporting network bandwidths for some specific cases of
<forward mode='bridge'/>, but currently libvirt doesn't support it. So
the proper thing to do now is just log an error when someone tries to
put a <bandwidth> element in that type of network. (It's unclear if we
will be able to do proper bandwidth limiting for macvtap networks, and
most definitely we will not be able to support it for hostdev
networks).
While looking through the network XML documentation and comparing it
to the networkValidate function, I noticed that we also ignore the
presence of a mac address in the config in the same cases, rather than
failing so that the user will understand that their desired action has
not been taken.
This patch updates networkValidate() (which is called any time a
persistent network is defined, or a transient network created) to log
an error and fail if it finds either a <bandwidth> or <mac> element
and the network forward mode is anything except 'route'. 'nat', or
nothing. (Yes, neither of those elements is acceptable for any macvtap
mode, nor for a hostdev network).
NB: This does *not* cause failure to start any existing network that
contains one of those elements, so someone might have erroneously
defined such a network in the past, and that network will continue to
function unmodified. I considered it too disruptive to suddenly break
working configs on the next reboot after a libvirt upgrade.
2014-01-24 15:58:05 +04:00
child element. Leaving either of these children elements out
results in no QoS applied for that traffic direction. So,
2014-02-13 00:33:02 +04:00
when you want to shape only incoming traffic, use
network: disallow <bandwidth>/<mac> for bridged/macvtap/hostdev networks
https://bugzilla.redhat.com/show_bug.cgi?id=1057321
pointed out that we weren't honoring the <bandwidth> element in
libvirt networks using <forward mode='bridge'/>. In fact, these
networks are just a method of giving a libvirt network name to an
existing Linux host bridge on the system, and libvirt doesn't have
enough information to know where to set such limits. We are working on
a method of supporting network bandwidths for some specific cases of
<forward mode='bridge'/>, but currently libvirt doesn't support it. So
the proper thing to do now is just log an error when someone tries to
put a <bandwidth> element in that type of network. (It's unclear if we
will be able to do proper bandwidth limiting for macvtap networks, and
most definitely we will not be able to support it for hostdev
networks).
While looking through the network XML documentation and comparing it
to the networkValidate function, I noticed that we also ignore the
presence of a mac address in the config in the same cases, rather than
failing so that the user will understand that their desired action has
not been taken.
This patch updates networkValidate() (which is called any time a
persistent network is defined, or a transient network created) to log
an error and fail if it finds either a <bandwidth> or <mac> element
and the network forward mode is anything except 'route'. 'nat', or
nothing. (Yes, neither of those elements is acceptable for any macvtap
mode, nor for a hostdev network).
NB: This does *not* cause failure to start any existing network that
contains one of those elements, so someone might have erroneously
defined such a network in the past, and that network will continue to
function unmodified. I considered it too disruptive to suddenly break
working configs on the next reboot after a libvirt upgrade.
2014-01-24 15:58:05 +04:00
< code > inbound< / code > only, and vice versa. Each of these
2014-02-13 00:33:02 +04:00
elements have one mandatory attribute - < code > average< / code > (or
< code > floor< / code > as described below). The attributes are as follows,
where accepted values for each attribute is an integer number.
network: disallow <bandwidth>/<mac> for bridged/macvtap/hostdev networks
https://bugzilla.redhat.com/show_bug.cgi?id=1057321
pointed out that we weren't honoring the <bandwidth> element in
libvirt networks using <forward mode='bridge'/>. In fact, these
networks are just a method of giving a libvirt network name to an
existing Linux host bridge on the system, and libvirt doesn't have
enough information to know where to set such limits. We are working on
a method of supporting network bandwidths for some specific cases of
<forward mode='bridge'/>, but currently libvirt doesn't support it. So
the proper thing to do now is just log an error when someone tries to
put a <bandwidth> element in that type of network. (It's unclear if we
will be able to do proper bandwidth limiting for macvtap networks, and
most definitely we will not be able to support it for hostdev
networks).
While looking through the network XML documentation and comparing it
to the networkValidate function, I noticed that we also ignore the
presence of a mac address in the config in the same cases, rather than
failing so that the user will understand that their desired action has
not been taken.
This patch updates networkValidate() (which is called any time a
persistent network is defined, or a transient network created) to log
an error and fail if it finds either a <bandwidth> or <mac> element
and the network forward mode is anything except 'route'. 'nat', or
nothing. (Yes, neither of those elements is acceptable for any macvtap
mode, nor for a hostdev network).
NB: This does *not* cause failure to start any existing network that
contains one of those elements, so someone might have erroneously
defined such a network in the past, and that network will continue to
function unmodified. I considered it too disruptive to suddenly break
working configs on the next reboot after a libvirt upgrade.
2014-01-24 15:58:05 +04:00
< / p >
2014-02-13 00:33:02 +04:00
< dl >
< dt > < code > average< / code > < / dt >
< dd >
Specifies the desired average bit rate for the interface
being shaped (in kilobytes/second).
< / dd >
< dt > < code > peak< / code > < / dt >
< dd >
Optional attribute which specifies the maximum rate at
which the bridge can send data (in kilobytes/second).
Note the limitation of implementation: this attribute in the
< code > outbound< / code > element is ignored (as Linux ingress
filters don't know it yet).
< / dd >
< dt > < code > burst< / code > < / dt >
< dd >
Optional attribute which specifies the amount of kilobytes that
can be transmitted in a single burst at < code > peak< / code > speed.
< / dd >
< dt > < code > floor< / code > < / dt >
< dd >
Optional attribute available only for the < code > inbound< / code >
element. This attribute guarantees minimal throughput for
shaped interfaces. This, however, requires that all traffic
goes through one point where QoS decisions can take place, hence
why this attribute works only for virtual networks for now
(that is < code > < interface type='network'/> < / code > with a
2020-02-14 19:26:24 +03:00
forward type of route, nat, open or no forward at all). Moreover, the
2014-02-13 00:33:02 +04:00
virtual network the interface is connected to is required to have
at least inbound QoS set (< code > average< / code > at least). If
using the < code > floor< / code > attribute users don't need to specify
< code > average< / code > . However, < code > peak< / code > and
< code > burst< / code > attributes still require < code > average< / code > .
Currently, the Linux kernel doesn't allow ingress qdiscs to have
any classes therefore < code > floor< / code > can be applied only
on < code > inbound< / code > and not < code > outbound< / code > .
< / dd >
< / dl >
network: disallow <bandwidth>/<mac> for bridged/macvtap/hostdev networks
https://bugzilla.redhat.com/show_bug.cgi?id=1057321
pointed out that we weren't honoring the <bandwidth> element in
libvirt networks using <forward mode='bridge'/>. In fact, these
networks are just a method of giving a libvirt network name to an
existing Linux host bridge on the system, and libvirt doesn't have
enough information to know where to set such limits. We are working on
a method of supporting network bandwidths for some specific cases of
<forward mode='bridge'/>, but currently libvirt doesn't support it. So
the proper thing to do now is just log an error when someone tries to
put a <bandwidth> element in that type of network. (It's unclear if we
will be able to do proper bandwidth limiting for macvtap networks, and
most definitely we will not be able to support it for hostdev
networks).
While looking through the network XML documentation and comparing it
to the networkValidate function, I noticed that we also ignore the
presence of a mac address in the config in the same cases, rather than
failing so that the user will understand that their desired action has
not been taken.
This patch updates networkValidate() (which is called any time a
persistent network is defined, or a transient network created) to log
an error and fail if it finds either a <bandwidth> or <mac> element
and the network forward mode is anything except 'route'. 'nat', or
nothing. (Yes, neither of those elements is acceptable for any macvtap
mode, nor for a hostdev network).
NB: This does *not* cause failure to start any existing network that
contains one of those elements, so someone might have erroneously
defined such a network in the past, and that network will continue to
function unmodified. I considered it too disruptive to suddenly break
working configs on the next reboot after a libvirt upgrade.
2014-01-24 15:58:05 +04:00
< p >
2014-02-13 00:33:02 +04:00
Attributes < code > average< / code > , < code > peak< / code > , and
< code > burst< / code > are available
< span class = "since" > since 0.9.4< / span > , while the
< code > floor< / code > attribute is available
< span class = "since" > since 1.0.1< / span > .
2011-07-22 18:07:23 +04:00
< / p >
2008-04-29 18:08:08 +04:00
2017-07-26 17:52:42 +03:00
< h5 > < a id = "elementVlanTag" > Setting VLAN tag (on supported network types only)< / a > < / h5 >
2012-08-12 11:51:30 +04:00
< pre >
2013-06-26 10:13:45 +04:00
< network>
< name> ovs-net< /name>
< forward mode='bridge'/>
< bridge name='ovsbr0'/>
< virtualport type='openvswitch'>
< parameters interfaceid='09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f'/>
< /virtualport>
< b > < vlan trunk='yes'> < / b >
< b > < tag id='42' nativeMode='untagged'/> < / b >
< b > < tag id='47'/> < / b >
< b > < /vlan> < / b >
< portgroup name='dontpanic'>
< b > < vlan> < / b >
< b > < tag id='42'/> < / b >
< b > < /vlan> < / b >
< /portgroup>
< /network>
< / pre >
2012-08-12 11:51:30 +04:00
< p >
2016-05-04 20:18:16 +03:00
If (and only if) the network connection used by the guest
supports VLAN tagging transparent to the guest, an
optional < code > < vlan> < / code > element can specify one or
more VLAN tags to apply to the guest's network
traffic < span class = "since" > Since 0.10.0< / span > . Network
connections that support guest-transparent VLAN tagging include
1) type='bridge' interfaces connected to an Open vSwitch bridge
< span class = "since" > Since 0.10.0< / span > , 2) SRIOV Virtual
Functions (VF) used via type='hostdev' (direct device
assignment) < span class = "since" > Since 0.10.0< / span > , and 3)
SRIOV VFs used via type='direct' with mode='passthrough'
(macvtap "passthru" mode) < span class = "since" > Since
2016-05-10 22:23:55 +03:00
1.3.5< / span > . All other connection types, including standard
2012-08-12 11:51:30 +04:00
linux bridges and libvirt's own virtual networks, < b > do not< / b >
support it. 802.1Qbh (vn-link) and 802.1Qbg (VEPA) switches
provide their own way (outside of libvirt) to tag guest traffic
2016-05-04 20:18:16 +03:00
onto a specific VLAN. Each tag is given in a
separate < code > < tag> < / code > subelement
of < code > < vlan> < / code > (for example: < code > < tag
id='42'/> < / code > ). For VLAN trunking of multiple tags (which
is supported only on Open vSwitch connections),
multiple < code > < tag> < / code > subelements can be specified,
which implies that the user wants to do VLAN trunking on the
interface for all the specified tags. In the case that VLAN
trunking of a single tag is desired, the optional
attribute < code > trunk='yes'< / code > can be added to the toplevel
< code > < vlan> < / code > element to differentiate trunking of a
single tag from normal tagging.
2012-08-12 11:51:30 +04:00
< / p >
2013-05-23 21:12:10 +04:00
< p >
2016-05-04 20:18:16 +03:00
For network connections using Open vSwitch it is also possible
to configure 'native-tagged' and 'native-untagged' VLAN modes
< span class = "since" > Since 1.1.0.< / span > This is done with the
optional < code > nativeMode< / code > attribute on
the < code > < tag> < / code > subelement: < code > nativeMode< / code >
may be set to 'tagged' or 'untagged'. The < code > id< / code >
attribute of the < code > < tag> < / code > subelement
containing < code > nativeMode< / code > sets which VLAN is considered
to be the "native" VLAN for this interface, and
the < code > nativeMode< / code > attribute determines whether or not
traffic for that VLAN will be tagged.
2013-05-23 21:12:10 +04:00
< / p >
2012-08-12 11:51:30 +04:00
< p >
< code > < vlan> < / code > elements can also be specified in
a < code > < portgroup> < / code > element, as well as directly in
a domain's < code > < interface> < / code > element. In the case
that a vlan tag is specified in multiple locations, the setting
in < code > < interface> < / code > takes precedence, followed by
the setting in the < code > < portgroup> < / code > selected by
the interface config. The < code > < vlan> < / code >
in < code > < network> < / code > will be selected only if none is
given in < code > < portgroup> < / code >
or < code > < interface> < / code > .
< / p >
2017-07-26 17:52:42 +03:00
< h5 > < a id = "elementsPortgroup" > Portgroups< / a > < / h5 >
2011-08-10 09:41:19 +04:00
< pre >
...
< forward mode='private'/>
< interface dev="eth20"/>
< interface dev="eth21"/>
< interface dev="eth22"/>
< interface dev="eth23"/>
< interface dev="eth24"/>
< /forward>
< b > < portgroup name='engineering' default='yes'>
< virtualport type='802.1Qbh'>
< parameters profileid='test'/>
< /virtualport>
< bandwidth>
< inbound average='1000' peak='5000' burst='5120'/>
< outbound average='1000' peak='5000' burst='5120'/>
< /bandwidth>
< /portgroup> < / b >
2014-09-23 22:19:08 +04:00
< b > < portgroup name='sales' trustGuestRxFilters='no'>
2011-08-10 09:41:19 +04:00
< virtualport type='802.1Qbh'>
< parameters profileid='salestest'/>
< /virtualport>
< bandwidth>
< inbound average='500' peak='2000' burst='2560'/>
< outbound average='128' peak='256' burst='256'/>
< /bandwidth>
< /portgroup> < / b >
...< / pre >
< p >
2011-10-14 22:35:32 +04:00
< span class = "since" > Since 0.9.4< / span >
2011-08-10 09:41:19 +04:00
A portgroup provides a method of easily putting guest
connections to the network into different classes, with each
2011-10-14 22:35:32 +04:00
class potentially having a different level/type of service.
< span class = "since" > Since 0.9.4< / span > Each
2011-08-10 09:41:19 +04:00
network can have multiple portgroup elements (and one of those
can optionally be designated as the 'default' portgroup for the
network), and each portgroup has a name, as well as various
2014-09-23 22:19:08 +04:00
attributes and subelements associated with it. The currently supported
2011-08-10 09:41:19 +04:00
subelements are < code > < bandwidth> < / code >
2014-02-13 00:33:02 +04:00
(described < a href = "formatnetwork.html#elementQoS" > here< / a > )
2011-08-10 09:41:19 +04:00
and < code > < virtualport> < / code >
(documented < a href = "formatdomain.html#elementsNICSDirect" > here< / a > ).
If a domain interface definition specifies a portgroup (by
adding a < code > portgroup< / code > attribute to
the < code > < source> < / code > subelement), that portgroup's
info will be merged into the interface's configuration. If no
portgroup is given in the interface definition, and one of the
network's portgroups has < code > default='yes'< / code > , that
default portgroup will be used. If no portgroup is given in the
interface definition, and there is no default portgroup, then
none will be used. Any < code > < bandwidth> < / code >
network: merge relevant virtualports rather than choosing one
One of the original ideas behind allowing a <virtualport> in an
interface definition as well as in the <network> definition *and*one
or more <portgroup>s within the network, was that guest-specific
parameteres (like instanceid and interfaceid) could be given in the
interface's virtualport, and more general things (portid, managerid,
etc) could be given in the network and/or portgroup, with all the bits
brought together at guest startup time and combined into a single
virtualport to be used by the guest. This was somehow overlooked in
the implementation, though - it simply picks the "most specific"
virtualport, and uses the entire thing, with no attempt to merge in
details from the others.
This patch uses virNetDevVPortProfileMerge3() to combine the three
possible virtualports into one, then uses
virNetDevVPortProfileCheck*() to verify that the resulting virtualport
type is appropriate for the type of network, and that all the required
attributes for that type are present.
An example of usage is this: assuming a <network> definitions on host
ABC of:
<network>
<name>testA</name>
...
<virtualport type='openvswitch'/>
...
<portgroup name='engineering'>
<virtualport>
<parameters profileid='eng'/>
</virtualport>
</portgroup>
<portgroup name='sales'>
<virtualport>
<parameters profileid='sales'/>
</virtualport>
</portgroup>
</network>
and the same <network> on host DEF of:
<network>
<name>testA</name>
...
<virtualport type='802.1Qbg'>
<parameters typeid="1193047" typeidversion="2"/>
</virtualport>
...
<portgroup name='engineering'>
<virtualport>
<parameters managerid="11"/>
</virtualport>
</portgroup>
<portgroup name='sales'>
<virtualport>
<parameters managerid="55"/>
</virtualport>
</portgroup>
</network>
and a guest <interface> definition of:
<interface type='network'>
<source network='testA' portgroup='sales'/>
<virtualport>
<parameters instanceid="09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f"
interfaceid="09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f"\>
</virtualport>
...
</interface>
If the guest was started on host ABC, the <virtualport> used would be:
<virtualport type='openvswitch'>
<parameters interfaceid='09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f'
profileid='sales'/>
</virtualport>
but if that guest was started on host DEF, the <virtualport> would be:
<virtualport type='802.1Qbg'>
<parameters instanceid="09b11c53-8b5c-4eeb-8f00-d84eaa0aaa4f"
typeid="1193047" typeidversion="2"
managerid="55"/>
</virtualport>
Additionally, if none of the involved <virtualport>s had a specified type
(this includes cases where no virtualport is given at all),
2012-08-02 22:10:00 +04:00
specified directly in the domain XML will take precedence over
any setting in the chosen portgroup. if
a < code > < virtualport> < / code > is specified in the portgroup
(and/or directly in the network definition), the multiple
virtualports will be merged, and any parameter that is specified
in more than one virtualport, and is not identical, will be
considered an error, and will prevent the interface from
starting.
2011-08-10 09:41:19 +04:00
< / p >
2014-09-23 22:19:08 +04:00
< p >
portgroups also support the optional
parameter < code > trustGuestRxFilters< / code > which can be used to
set that attribute of the same name for each domain interface
using this portgroup (< span class = "since" > since
1.2.10< / span > ). See
2017-01-23 14:24:37 +03:00
the < a href = "formatdomain.html#elementsNICS" > Network
2014-09-23 22:19:08 +04:00
interfaces< / a > section of the domain XML documentation for more
details. Note that an explicit setting of this attribute in the
portgroup overrides the network-wide setting, and an explicit
setting in the individual domain interface will override the
setting in the portgroup.
< / p >
2011-08-10 09:41:19 +04:00
2017-07-26 17:52:42 +03:00
< h5 > < a id = "elementsStaticroute" > Static Routes< / a > < / h5 >
Support for static routes on a virtual bridge
network: static route support for <network>
This patch adds the <route> subelement of <network> to define a static
route. the address and prefix (or netmask) attribute identify the
destination network, and the gateway attribute specifies the next hop
address (which must be directly reachable from the containing
<network>) which is to receive the packets destined for
"address/(prefix|netmask)".
These attributes are translated into an "ip route add" command that is
executed when the network is started. The command used is of the
following form:
ip route add <address>/<prefix> via <gateway> \
dev <virbr-bridge> proto static metric <metric>
Tests are done to validate that the input data are correct. For
example, for a static route ip definition, the address must be a
network address and not a host address. Additional checks are added
to ensure that the specified gateway is directly reachable via this
network (i.e. that the gateway IP address is in the same subnet as one
of the IP's defined for the network).
prefix='0' is supported for both family='ipv4' address='0.0.0.0'
netmask='0.0.0.0' or prefix='0', and for family='ipv6' address='::',
prefix=0', although care should be taken to not override a desired
system default route.
Anytime an attempt is made to define a static route which *exactly*
duplicates an existing static route (for example, address=::,
prefix=0, metric=1), the following error message will be sent to
syslog:
RTNETLINK answers: File exists
This can be overridden by decreasing the metric value for the route
that should be preferred, or increasing the metric for the route that
shouldn't be preferred (and is thus in place only in anticipation that
the preferred route may be removed in the future). Caution should be
used when manipulating route metrics, especially for a default route.
Note: The use of the command-line interface should be replaced by
direct use of libnl so that error conditions can be handled better. But,
that is being left as an exercise for another day.
Signed-off-by: Gene Czarcinski <gene@czarc.net>
Signed-off-by: Laine Stump <laine@laine.org>
2013-05-07 21:42:55 +04:00
< p >
Static route definitions are used to provide routing information
to the virtualization host for networks which are not directly
reachable from the virtualization host, but *are* reachable from
a guest domain that is itself reachable from the
host < span class = "since" > since 1.0.6< / span > .
< / p >
< p >
As shown in < a href = "formatnetwork.html#examplesNoGateway" > this
example< / a > , it is possible to define a virtual network
interface with no IPv4 or IPv6 addresses. Such networks are
useful to provide host connectivity to networks which are only
reachable via a guest. A guest with connectivity both to the
guest-only network and to another network that is directly
reachable from the host can act as a gateway between the
networks. A static route added to the "host-visible" network
definition provides the routing information so that IP packets
can be sent from the virtualization host to guests on the hidden
network.
< / p >
< p >
Here is a fragment of a definition which shows the static
route specification as well as the IPv4 and IPv6 definitions
for network addresses which are referred to in the
< code > gateway< / code > gateway address specifications. Note
that the third static route specification includes the
< code > metric< / code > attribute specification with a value of 2.
This particular route would *not* be preferred if there was
another existing rout on the system with the same address and
prefix but with a lower value for the metric. If there is a
2013-09-10 22:10:55 +04:00
route in the host system configuration that should be overridden
Support for static routes on a virtual bridge
network: static route support for <network>
This patch adds the <route> subelement of <network> to define a static
route. the address and prefix (or netmask) attribute identify the
destination network, and the gateway attribute specifies the next hop
address (which must be directly reachable from the containing
<network>) which is to receive the packets destined for
"address/(prefix|netmask)".
These attributes are translated into an "ip route add" command that is
executed when the network is started. The command used is of the
following form:
ip route add <address>/<prefix> via <gateway> \
dev <virbr-bridge> proto static metric <metric>
Tests are done to validate that the input data are correct. For
example, for a static route ip definition, the address must be a
network address and not a host address. Additional checks are added
to ensure that the specified gateway is directly reachable via this
network (i.e. that the gateway IP address is in the same subnet as one
of the IP's defined for the network).
prefix='0' is supported for both family='ipv4' address='0.0.0.0'
netmask='0.0.0.0' or prefix='0', and for family='ipv6' address='::',
prefix=0', although care should be taken to not override a desired
system default route.
Anytime an attempt is made to define a static route which *exactly*
duplicates an existing static route (for example, address=::,
prefix=0, metric=1), the following error message will be sent to
syslog:
RTNETLINK answers: File exists
This can be overridden by decreasing the metric value for the route
that should be preferred, or increasing the metric for the route that
shouldn't be preferred (and is thus in place only in anticipation that
the preferred route may be removed in the future). Caution should be
used when manipulating route metrics, especially for a default route.
Note: The use of the command-line interface should be replaced by
direct use of libnl so that error conditions can be handled better. But,
that is being left as an exercise for another day.
Signed-off-by: Gene Czarcinski <gene@czarc.net>
Signed-off-by: Laine Stump <laine@laine.org>
2013-05-07 21:42:55 +04:00
by a route in a virtual network whenever the virtual network is
running, the configuration for the system-defined route should
be modified to have a higher metric, and the route on the
virtual network given a lower metric (for example, the default
metric of "1").
< / p >
< pre >
2016-11-12 01:40:27 +03:00
...
< ip address="192.168.122.1" netmask="255.255.255.0">
< dhcp>
2016-12-02 20:40:40 +03:00
< range start="192.168.122.128" end="192.168.122.254"/>
2016-11-12 01:40:27 +03:00
< /dhcp>
< /ip>
2016-12-02 20:40:40 +03:00
< route address="192.168.222.0" prefix="24" gateway="192.168.122.2"/>
< ip family="ipv6" address="2001:db8:ca2:2::1" prefix="64"/>
2016-11-12 01:40:27 +03:00
< route family="ipv6" address="2001:db8:ca2:3::" prefix="64" gateway="2001:db8:ca2:2::2"/>
2016-12-02 20:36:31 +03:00
< route family="ipv6" address="2001:db9:4:1::" prefix="64" gateway="2001:db8:ca2:2::3" metric='2'/>
2016-11-12 01:40:27 +03:00
...
Support for static routes on a virtual bridge
network: static route support for <network>
This patch adds the <route> subelement of <network> to define a static
route. the address and prefix (or netmask) attribute identify the
destination network, and the gateway attribute specifies the next hop
address (which must be directly reachable from the containing
<network>) which is to receive the packets destined for
"address/(prefix|netmask)".
These attributes are translated into an "ip route add" command that is
executed when the network is started. The command used is of the
following form:
ip route add <address>/<prefix> via <gateway> \
dev <virbr-bridge> proto static metric <metric>
Tests are done to validate that the input data are correct. For
example, for a static route ip definition, the address must be a
network address and not a host address. Additional checks are added
to ensure that the specified gateway is directly reachable via this
network (i.e. that the gateway IP address is in the same subnet as one
of the IP's defined for the network).
prefix='0' is supported for both family='ipv4' address='0.0.0.0'
netmask='0.0.0.0' or prefix='0', and for family='ipv6' address='::',
prefix=0', although care should be taken to not override a desired
system default route.
Anytime an attempt is made to define a static route which *exactly*
duplicates an existing static route (for example, address=::,
prefix=0, metric=1), the following error message will be sent to
syslog:
RTNETLINK answers: File exists
This can be overridden by decreasing the metric value for the route
that should be preferred, or increasing the metric for the route that
shouldn't be preferred (and is thus in place only in anticipation that
the preferred route may be removed in the future). Caution should be
used when manipulating route metrics, especially for a default route.
Note: The use of the command-line interface should be replaced by
direct use of libnl so that error conditions can be handled better. But,
that is being left as an exercise for another day.
Signed-off-by: Gene Czarcinski <gene@czarc.net>
Signed-off-by: Laine Stump <laine@laine.org>
2013-05-07 21:42:55 +04:00
< / pre >
2017-07-26 17:52:42 +03:00
< h3 > < a id = "elementsAddress" > Addressing< / a > < / h3 >
2008-04-29 18:08:08 +04: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 11:28:12 +03: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
2011-08-10 09:41:19 +04:00
services. These elements are only valid for isolated networks
(no < code > forward< / code > element specified), and for those with
a forward mode of 'route' or 'nat'.
2008-04-29 18:08:08 +04:00
< / p >
< pre >
2016-11-12 01:40:27 +03:00
...
< mac address='00:16:3E:5D:C7:9E'/>
< domain name="example.com"/>
< dns>
2016-12-02 20:40:40 +03:00
< txt name="example" value="example value"/>
2016-11-12 01:40:27 +03:00
< forwarder addr="8.8.8.8"/>
< forwarder domain='example.com' addr="8.8.4.4"/>
< forwarder domain='www.example.com'/>
2016-12-02 20:38:20 +03:00
< srv service='name' protocol='tcp' domain='test-domain-name' target='.'
port='1024' priority='10' weight='10'/>
2016-11-12 01:40:27 +03:00
< host ip='192.168.122.2'>
< hostname> myhost< /hostname>
< hostname> myhostalias< /hostname>
< /host>
< /dns>
2016-12-09 00:23:09 +03:00
< ip address="192.168.122.1" netmask="255.255.255.0" localPtr="yes">
2016-11-12 01:40:27 +03:00
< dhcp>
2016-12-02 20:40:40 +03:00
< 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"/>
2016-11-12 01:40:27 +03:00
< /dhcp>
< /ip>
2016-12-09 00:23:09 +03:00
< ip family="ipv6" address="2001:db8:ca2:2::1" prefix="64" localPtr="yes"/>
2016-12-02 20:40:40 +03:00
< route family="ipv6" address="2001:db9:ca1:1::" prefix="64" gateway="2001:db8:ca2:2::2"/>
2016-11-12 01:40:27 +03:00
< / pre >
2008-04-29 18:08:08 +04:00
< 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 11:28:12 +03: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 >
2013-08-14 02:56:38 +04:00
< 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 > .
2016-08-12 00:29:43 +03:00
< p >
The dns element can have an optional < code > enable< / code >
attribute < span class = "since" > Since 2.2.0< / span > .
If < code > enable< / code > is "no", then no DNS server will be
setup by libvirt for this network (and any other
configuration in < code > < dns> < / code > will be ignored).
If < code > enable< / code > is "yes" or unspecified (including
the complete absence of any < code > < dns> < / code >
element) then a DNS server will be setup by libvirt to
listen on all IP addresses specified in the network's
configuration.
< / p >
2013-08-14 02:56:38 +04:00
< p >
The dns element
can have an optional < code > forwardPlainNames< / code >
attribute < span class = "since" > Since 1.1.2< / span > .
If < code > forwardPlainNames< / code > is "no", then DNS resolution
requests for names that are not qualified with a domain
(i.e. names with no "." character) will not be forwarded to
the host's upstream DNS server - they will only be resolved if
they are known locally within the virtual network's own DNS
server. If < code > forwardPlainNames< / code > is "yes",
unqualified names < b > will< / b > be forwarded to the upstream DNS
server if they can't be resolved by the virtual network's own
DNS server.
< / p >
Currently supported sub-elements of < code > < dns> < / code > are:
2011-06-24 14:04:36 +04:00
< dl >
2013-09-13 20:31:07 +04:00
< dt > < code > forwarder< / code > < / dt >
2016-08-12 05:28:27 +03:00
< dd > The dns element can have 0 or
more < code > < forwarder> < / code > elements. Each
forwarder element defines an alternate DNS server to use
for some, or all, DNS requests sent to this network's DNS
server. There are two attributes - < code > domain< / code > ,
and < code > addr< / code > ; at least one of these must be
specified in any < code > < forwarder> < / code >
element. If both < code > domain< / code > and < code > addr< / code >
are specified, then all requests that match the given
domain will be forwarded to the DNS server at addr. If
only < code > domain< / code > is specified, then all matching
domains will be resolved locally (or via the host's
standard DNS forwarding if they can't be resolved
locally). If an < code > addr< / code > is specified by itself,
then all DNS requests to the network's DNS server will be
forwarded to the DNS server at that address with no
exceptions. < code > addr< / code > < span class = "since" > Since
1.1.3< / span > , < code > domain< / code > < span class = "since" > Since
2.2.0< / span > .
2013-09-13 20:31:07 +04:00
< / dd >
2011-06-24 14:04:36 +04:00
< 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 >
2011-06-24 14:04:40 +04: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 >
2011-06-24 14:04:36 +04:00
< / dl >
2012-01-02 18:23:54 +04:00
< dl >
< dt > < code > srv< / code > < / dt >
< dd > The < code > dns< / code > element can have also 0 or more < code > srv< / code >
record elements. Each < code > srv< / code > record element defines a DNS SRV record
and has 2 mandatory and 5 optional attributes. The mandatory attributes
2016-12-02 21:50:11 +03:00
are service < code > name< / code > and < code > protocol< / code > (tcp, udp)
and the optional attributes are < code > target< / code > ,
< code > port< / code > , < code > priority< / code > , < code > weight< / code > and
< code > domain< / code > as defined in DNS server SRV RFC (RFC 2782).
2012-01-02 18:23:54 +04:00
< span class = "since" > Since 0.9.9< / span >
< / dd >
< / dl >
2011-06-24 14:04:36 +04:00
< / dd >
2011-06-25 01:48:55 +04:00
< dt > < code > ip< / code > < / dt >
< dd > The < code > address< / code > attribute defines an IPv4 address in
2016-12-09 18:26:12 +03:00
dotted-decimal format, or an IPv6 address in standard colon-separated
hexadecimal format, that will be configured on the bridge device
associated with the virtual network. To the guests this IPv4 address
will be their IPv4 default route. For IPv6, the default route is
established via Router Advertisement. For IPv4 addresses, the
< code > netmask< / code > attribute defines the significant bits of the
network address, again specified in dotted-decimal format. For IPv6
addresses, and as an alternate method for IPv4 addresses, the
significant bits of the network address can be specified 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
2017-07-26 19:54:30 +03:00
to specify the type of address - < code > ipv4< / code > or
2016-12-09 18:26:12 +03:00
< code > ipv6< / code > ; if no < code > family< / code > is given,
< code > ipv4< / code > is assumed. More than one address of each family can
2016-12-09 00:23:09 +03:00
be defined for a network. The optional < code > localPtr< / code > attribute
(< span class = "since" > since 3.0.0< / span > ) configures the DNS server to
not forward any reverse DNS requests for IP addresses from the network
configured by the < code > address< / code > and
< code > netmask< / code > /< code > prefix< / code > attributes. For some unusual
network prefixes (not divisible by 8 for IPv4 or not divisible by 4 for
IPv6) libvirt may be unable to compute the PTR domain automatically.
The < code > ip< / code > element is supported < span class = "since" > since
0.3.0< / span > . IPv6, multiple addresses on a single network,
< code > family< / code > , and < code > prefix< / code > are supported
< span class = "since" > since 0.8.7< / span > . The < code > ip< / code > element may
contain the following elements:
2012-12-06 21:20:38 +04:00
2011-06-25 01:48:55 +04:00
< dl >
< dt > < code > tftp< / code > < / dt >
2016-12-09 18:26:12 +03:00
< dd > The optional < code > tftp< / code > element and its mandatory
< code > root< / code > attribute enable TFTP services. The attribute
specifies the path to the root directory served via TFTP. The
< code > tftp< / code > element is not supported for IPv6 addresses,
and can only be specified on a single IPv4 address per network.
2011-06-25 01:48:55 +04:00
< span class = "since" > Since 0.7.1< / span >
< / dd >
< dt > < code > dhcp< / code > < / dt >
2016-12-09 18:26:12 +03:00
< dd > The presence of this element enables DHCP services on the
virtual network. The < code > dhcp< / code > element is supported for
both IPv4 (< span class = "since" > since 0.3.0< / span > ) and IPv6
(< span class = "since" > since 1.0.1< / span > ), but only for one IP
address of each type per network. The following sub-elements are
supported:
2011-06-25 01:48:55 +04:00
< dl >
< dt > < code > range< / code > < / dt >
< dd > The < code > start< / code > and < code > end< / code > attributes on the
< code > range< / code > element specify the boundaries of a pool of
2012-12-06 21:20:38 +04:00
addresses to be provided to DHCP clients. These two addresses
2011-06-25 01:48:55 +04:00
must lie within the scope of the network defined on the parent
2012-12-06 21:20:38 +04:00
< code > ip< / code > element. There may be zero or more
< code > range< / code > elements specified.
< span class = "since" > Since 0.3.0< / span >
2011-06-25 01:48:55 +04:00
< / dd >
< dt > < code > host< / code > < / dt >
2016-12-09 18:26:12 +03:00
< dd > Within the < code > dhcp< / code > element there may be zero or
more < code > host< / code > elements. These specify hosts which will
be given names and predefined IP addresses by the built-in DHCP
server. Any IPv4 < code > host< / code > element must specify the MAC
address of the host to be assigned a given name (via the
< code > mac< / code > attribute), the IP to be assigned to that host
(via the < code > ip< / code > attribute), and the name itself (the
< code > name< / code > attribute). The IPv6 < code > host< / code >
element differs slightly from that for IPv4: there is no
< code > mac< / code > attribute since a MAC address has no defined
meaning in IPv6. Instead, the < code > name< / code > attribute is
used to identify the host to be assigned the IPv6 address. For
DHCPv6, the name is the plain name of the client host sent by the
client to the server. Note that this method of assigning a
specific IP address can also be used for IPv4 instead of the
< code > mac< / code > attribute.
< span class = "since" > Since 0.4.5< / span >
2011-06-25 01:48:55 +04:00
< / dd >
< dt > < code > bootp< / code > < / dt >
2016-12-09 18:26:12 +03:00
< dd > The optional < code > bootp< / code > element specifies BOOTP
options to be provided by the DHCP server for IPv4 only. 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< / span > (< code > server< / code >
< span class = "since" > since 0.7.3< / span > )
2011-06-25 01:48:55 +04:00
< / dd >
< / dl >
< / dd >
< / dl >
2009-10-28 17:57:49 +03:00
< / dd >
2008-04-29 18:08:08 +04:00
< / dl >
2008-04-23 21:08:31 +04:00
2019-07-15 02:46:15 +03:00
< h3 > < a id = "elementsNamespaces" > Network namespaces< / a > < / h3 >
< p >
A special XML namespace is available for passing options directly to the
underlying dnsmasq configuration file. Usage of XML namespaces comes with no
support guarantees, so use at your own risk.
< / p >
< p >
This example XML will pass the option strings < code > foo=bar< / code > and
< code > cname=*.foo.example.com,master.example.com< / code > directly to the
underlying dnsmasq instance.
< pre >
< network xmlns:dnsmasq='http://libvirt.org/schemas/network/dnsmasq/1.0'>
...
< dnsmasq:options>
< dnsmasq:option value="foo=bar"/>
< dnsmasq:option value="cname=*.foo.example.com,master.example.com"/>
< /dnsmasq:options>
< /network> < / pre >
< / p >
2017-07-26 17:52:42 +03:00
< h2 > < a id = "examples" > Example configuration< / a > < / h2 >
2008-04-23 21:08:31 +04:00
2017-07-26 17:52:42 +03:00
< h3 > < a id = "examplesNAT" > NAT based network< / a > < / h3 >
2008-04-23 21:08:31 +04:00
2008-04-29 18:08:08 +04: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-23 21:08:31 +04:00
< pre >
2016-11-12 01:40:27 +03:00
< network>
< name> default< /name>
2016-12-02 20:40:40 +03:00
< bridge name="virbr0"/>
2016-11-12 01:40:27 +03:00
< forward mode="nat"/>
< ip address="192.168.122.1" netmask="255.255.255.0">
< dhcp>
2016-12-02 20:40:40 +03:00
< range start="192.168.122.2" end="192.168.122.254"/>
2016-11-12 01:40:27 +03:00
< /dhcp>
< /ip>
2016-12-02 20:40:40 +03:00
< ip family="ipv6" address="2001:db8:ca2:2::1" prefix="64"/>
2016-11-12 01:40:27 +03:00
< /network> < / pre >
2008-04-23 21:08:31 +04:00
2012-12-06 21:20:38 +04:00
< p >
Below is a variation of the above example which adds an IPv6
dhcp range definition.
< / p >
< pre >
2016-11-12 01:40:27 +03:00
< network>
< name> default6< /name>
2016-12-02 20:40:40 +03:00
< bridge name="virbr0"/>
2016-11-12 01:40:27 +03:00
< forward mode="nat"/>
< ip address="192.168.122.1" netmask="255.255.255.0">
< dhcp>
2016-12-02 20:40:40 +03:00
< range start="192.168.122.2" end="192.168.122.254"/>
2016-11-12 01:40:27 +03:00
< /dhcp>
< /ip>
2016-12-02 20:40:40 +03:00
< ip family="ipv6" address="2001:db8:ca2:2::1" prefix="64">
2016-11-12 01:40:27 +03:00
< dhcp>
2016-12-02 20:40:40 +03:00
< range start="2001:db8:ca2:2:1::10" end="2001:db8:ca2:2:1::ff"/>
2016-11-12 01:40:27 +03:00
< /dhcp>
< /ip>
< /network> < / pre >
2012-12-06 21:20:38 +04:00
2017-07-26 17:52:42 +03:00
< h3 > < a id = "examplesRoute" > Routed network config< / a > < / h3 >
2008-04-23 21:08:31 +04:00
2008-04-29 18:08:08 +04: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-23 21:08:31 +04:00
< pre >
2016-11-12 01:40:27 +03:00
< network>
< name> local< /name>
2016-12-02 20:40:40 +03:00
< bridge name="virbr1"/>
2016-11-12 01:40:27 +03:00
< forward mode="route" dev="eth1"/>
< ip address="192.168.122.1" netmask="255.255.255.0">
< dhcp>
2016-12-02 20:40:40 +03:00
< range start="192.168.122.2" end="192.168.122.254"/>
2016-11-12 01:40:27 +03:00
< /dhcp>
< /ip>
2016-12-02 20:40:40 +03:00
< ip family="ipv6" address="2001:db8:ca2:2::1" prefix="64"/>
2016-11-12 01:40:27 +03:00
< /network> < / pre >
2008-04-23 21:08:31 +04:00
2012-12-06 21:20:38 +04:00
< p >
2013-02-28 08:18:04 +04:00
Below is another IPv6 variation. Instead of a dhcp range being
2012-12-06 21:20:38 +04:00
specified, this example has a couple of IPv6 host definitions.
2013-02-15 23:02:26 +04:00
Note that most of the dhcp host definitions use an "id" (client
id or DUID) since this has proven to be a more reliable way
of specifying the interface and its association with an IPv6
address. The first is a DUID-LLT, the second a DUID-LL, and
the third a DUID-UUID. < span class = "since" > Since 1.0.3< / span >
2012-12-06 21:20:38 +04:00
< / p >
< pre >
2016-11-12 01:40:27 +03:00
< network>
< name> local6< /name>
2016-12-02 20:40:40 +03:00
< bridge name="virbr1"/>
2016-11-12 01:40:27 +03:00
< forward mode="route" dev="eth1"/>
< ip address="192.168.122.1" netmask="255.255.255.0">
< dhcp>
2016-12-02 20:40:40 +03:00
< range start="192.168.122.2" end="192.168.122.254"/>
2016-11-12 01:40:27 +03:00
< /dhcp>
< /ip>
2016-12-02 20:40:40 +03:00
< ip family="ipv6" address="2001:db8:ca2:2::1" prefix="64">
2016-11-12 01:40:27 +03:00
< dhcp>
2016-12-02 20:40:40 +03:00
< host name="paul" ip="2001:db8:ca2:2:3::1"/>
< host id="0:1:0:1:18:aa:62:fe:0:16:3e:44:55:66" ip="2001:db8:ca2:2:3::2"/>
< host id="0:3:0:1:0:16:3e:11:22:33" name="ralph" ip="2001:db8:ca2:2:3::3"/>
2016-12-02 20:38:20 +03:00
< host id="0:4:7e:7d:f0:7d:a8:bc:c5:d2:13:32:11:ed:16:ea:84:63"
name="badbob" ip="2001:db8:ca2:2:3::4"/>
2016-11-12 01:40:27 +03:00
< /dhcp>
< /ip>
< /network> < / pre >
2012-12-06 21:20:38 +04:00
Support for static routes on a virtual bridge
network: static route support for <network>
This patch adds the <route> subelement of <network> to define a static
route. the address and prefix (or netmask) attribute identify the
destination network, and the gateway attribute specifies the next hop
address (which must be directly reachable from the containing
<network>) which is to receive the packets destined for
"address/(prefix|netmask)".
These attributes are translated into an "ip route add" command that is
executed when the network is started. The command used is of the
following form:
ip route add <address>/<prefix> via <gateway> \
dev <virbr-bridge> proto static metric <metric>
Tests are done to validate that the input data are correct. For
example, for a static route ip definition, the address must be a
network address and not a host address. Additional checks are added
to ensure that the specified gateway is directly reachable via this
network (i.e. that the gateway IP address is in the same subnet as one
of the IP's defined for the network).
prefix='0' is supported for both family='ipv4' address='0.0.0.0'
netmask='0.0.0.0' or prefix='0', and for family='ipv6' address='::',
prefix=0', although care should be taken to not override a desired
system default route.
Anytime an attempt is made to define a static route which *exactly*
duplicates an existing static route (for example, address=::,
prefix=0, metric=1), the following error message will be sent to
syslog:
RTNETLINK answers: File exists
This can be overridden by decreasing the metric value for the route
that should be preferred, or increasing the metric for the route that
shouldn't be preferred (and is thus in place only in anticipation that
the preferred route may be removed in the future). Caution should be
used when manipulating route metrics, especially for a default route.
Note: The use of the command-line interface should be replaced by
direct use of libnl so that error conditions can be handled better. But,
that is being left as an exercise for another day.
Signed-off-by: Gene Czarcinski <gene@czarc.net>
Signed-off-by: Laine Stump <laine@laine.org>
2013-05-07 21:42:55 +04:00
< p >
Below is yet another IPv6 variation. This variation has only
IPv6 defined with DHCPv6 on the primary IPv6 network. A static
link if defined for a second IPv6 network which will not be
directly visible on the bridge interface but there will be a
static route defined for this network via the specified
gateway. Note that the gateway address must be directly
reachable via (on the same subnet as) one of the < ip>
addresses defined for this < network> .
< span class = "since" > Since 1.0.6< / span >
< / p >
< pre >
2016-11-12 01:40:27 +03:00
< network>
< name> net7< /name>
2016-12-02 20:40:40 +03:00
< bridge name="virbr7"/>
2016-11-12 01:40:27 +03:00
< forward mode="route"/>
2016-12-02 20:40:40 +03:00
< ip family="ipv6" address="2001:db8:ca2:7::1" prefix="64">
2016-11-12 01:40:27 +03:00
< dhcp>
2016-12-02 20:40:40 +03:00
< range start="2001:db8:ca2:7::100" end="2001:db8:ca2::1ff"/>
2016-12-02 20:38:20 +03:00
< host id="0:4:7e:7d:f0:7d:a8:bc:c5:d2:13:32:11:ed:16:ea:84:63"
name="lucas" ip="2001:db8:ca2:2:3::4"/>
2016-11-12 01:40:27 +03:00
< /dhcp>
< /ip>
2016-12-02 20:36:31 +03:00
< route family="ipv6" address="2001:db8:ca2:8::" prefix="64" gateway="2001:db8:ca2:7::4"/>
2016-11-12 01:40:27 +03:00
< /network> < / pre >
Support for static routes on a virtual bridge
network: static route support for <network>
This patch adds the <route> subelement of <network> to define a static
route. the address and prefix (or netmask) attribute identify the
destination network, and the gateway attribute specifies the next hop
address (which must be directly reachable from the containing
<network>) which is to receive the packets destined for
"address/(prefix|netmask)".
These attributes are translated into an "ip route add" command that is
executed when the network is started. The command used is of the
following form:
ip route add <address>/<prefix> via <gateway> \
dev <virbr-bridge> proto static metric <metric>
Tests are done to validate that the input data are correct. For
example, for a static route ip definition, the address must be a
network address and not a host address. Additional checks are added
to ensure that the specified gateway is directly reachable via this
network (i.e. that the gateway IP address is in the same subnet as one
of the IP's defined for the network).
prefix='0' is supported for both family='ipv4' address='0.0.0.0'
netmask='0.0.0.0' or prefix='0', and for family='ipv6' address='::',
prefix=0', although care should be taken to not override a desired
system default route.
Anytime an attempt is made to define a static route which *exactly*
duplicates an existing static route (for example, address=::,
prefix=0, metric=1), the following error message will be sent to
syslog:
RTNETLINK answers: File exists
This can be overridden by decreasing the metric value for the route
that should be preferred, or increasing the metric for the route that
shouldn't be preferred (and is thus in place only in anticipation that
the preferred route may be removed in the future). Caution should be
used when manipulating route metrics, especially for a default route.
Note: The use of the command-line interface should be replaced by
direct use of libnl so that error conditions can be handled better. But,
that is being left as an exercise for another day.
Signed-off-by: Gene Czarcinski <gene@czarc.net>
Signed-off-by: Laine Stump <laine@laine.org>
2013-05-07 21:42:55 +04:00
2017-07-26 17:52:42 +03:00
< h3 > < a id = "examplesPrivate" > Isolated network config< / a > < / h3 >
2008-04-23 21:08:31 +04:00
2008-04-29 18:08:08 +04: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-23 21:08:31 +04:00
< pre >
2016-11-12 01:40:27 +03:00
< network>
< name> private< /name>
2016-12-02 20:40:40 +03:00
< bridge name="virbr2"/>
2016-11-12 01:40:27 +03:00
< ip address="192.168.152.1" netmask="255.255.255.0">
< dhcp>
2016-12-02 20:40:40 +03:00
< range start="192.168.152.2" end="192.168.152.254"/>
2016-11-12 01:40:27 +03:00
< /dhcp>
< /ip>
2016-12-02 20:40:40 +03:00
< ip family="ipv6" address="2001:db8:ca2:3::1" prefix="64"/>
2016-11-12 01:40:27 +03:00
< /network> < / pre >
2008-04-23 21:08:31 +04:00
2017-07-26 17:52:42 +03:00
< h3 > < a id = "examplesPrivate6" > Isolated IPv6 network config< / a > < / h3 >
2012-12-06 21:20:38 +04:00
< p >
This variation of an isolated network defines only IPv6.
2013-02-15 23:02:26 +04:00
Note that most of the dhcp host definitions use an "id" (client
id or DUID) since this has proven to be a more reliable way
of specifying the interface and its association with an IPv6
address. The first is a DUID-LLT, the second a DUID-LL, and
the third a DUID-UUID. < span class = "since" > Since 1.0.3< / span >
2012-12-06 21:20:38 +04:00
< / p >
< pre >
2016-11-12 01:40:27 +03:00
< network>
< name> sixnet< /name>
2016-12-02 20:40:40 +03:00
< bridge name="virbr6"/>
< ip family="ipv6" address="2001:db8:ca2:6::1" prefix="64">
2016-11-12 01:40:27 +03:00
< dhcp>
2016-12-02 20:40:40 +03:00
< host name="peter" ip="2001:db8:ca2:6:6::1"/>
< host id="0:1:0:1:18:aa:62:fe:0:16:3e:44:55:66" ip="2001:db8:ca2:6:6::2"/>
< host id="0:3:0:1:0:16:3e:11:22:33" name="dariusz" ip="2001:db8:ca2:6:6::3"/>
2016-12-02 20:38:20 +03:00
< host id="0:4:7e:7d:f0:7d:a8:bc:c5:d2:13:32:11:ed:16:ea:84:63"
name="anita" ip="2001:db8:ca2:6:6::4"/>
2016-11-12 01:40:27 +03:00
< /dhcp>
< /ip>
< /network> < / pre >
2012-12-06 21:20:38 +04:00
2017-07-26 17:52:42 +03:00
< h3 > < a id = "examplesBridge" > Using an existing host bridge< / a > < / h3 >
2011-08-10 09:41:19 +04:00
< p >
2011-10-14 22:35:32 +04:00
< span class = "since" > Since 0.9.4< / span >
2011-08-10 09:41:19 +04:00
This shows how to use a pre-existing host bridge "br0". The
guests will effectively be directly connected to the physical
network (i.e. their IP addresses will all be on the subnet of
the physical network, and there will be no restrictions on
inbound or outbound connections).
< / p >
< pre >
2016-11-12 01:40:27 +03:00
< network>
< name> host-bridge< /name>
< forward mode="bridge"/>
< bridge name="br0"/>
< /network> < / pre >
2011-08-10 09:41:19 +04:00
2017-07-26 17:52:42 +03:00
< h3 > < a id = "examplesDirect" > Using a macvtap "direct" connection< / a > < / h3 >
2011-08-10 09:41:19 +04:00
< p >
2011-10-14 22:35:32 +04:00
< span class = "since" > Since 0.9.4, QEMU and KVM only, requires
Linux kernel 2.6.34 or newer< / span >
2011-08-10 09:41:19 +04:00
This shows how to use macvtap to connect to the physical network
directly through one of a group of physical devices (without
using a host bridge device). As with the host bridge network,
the guests will effectively be directly connected to the
physical network so their IP addresses will all be on the subnet
of the physical network, and there will be no restrictions on
inbound or outbound connections. Note that, due to a limitation
in the implementation of macvtap, these connections do not allow
communication directly between the host and the guests - if you
require this you will either need the attached physical switch
to be operating in a mirroring mode (so that all traffic coming
to the switch is reflected back to the host's interface), or
provide alternate means for this communication (e.g. a second
interface on each guest that is connected to an isolated
network). The other forward modes that use macvtap (private,
vepa, and passthrough) would be used in a similar fashion.
< / p >
< pre >
2016-11-12 01:40:27 +03:00
< network>
< name> direct-macvtap< /name>
< forward mode="bridge">
< interface dev="eth20"/>
< interface dev="eth21"/>
< interface dev="eth22"/>
< interface dev="eth23"/>
< interface dev="eth24"/>
< /forward>
< /network> < / pre >
2011-08-10 09:41:19 +04:00
2017-07-26 17:52:42 +03:00
< h3 > < a id = "examplesNoGateway" > Network config with no gateway addresses< / a > < / h3 >
2012-12-03 20:13:36 +04:00
< p >
A valid network definition can contain no IPv4 or IPv6 addresses. Such a definition
can be used for a "very private" or "very isolated" network since it will not be
possible to communicate with the virtualization host via this network. However,
this virtual network interface can be used for communication between virtual guest
systems. This works for IPv4 and < span class = "since" > (Since 1.0.1)< / span > IPv6.
However, the new ipv6='yes' must be added for guest-to-guest IPv6
communication.
< / p >
< pre >
2016-11-12 01:40:27 +03:00
< network ipv6='yes'>
< name> nogw< /name>
< uuid> 7a3b7497-1ec7-8aef-6d5c-38dff9109e93< /uuid>
2016-12-02 20:40:40 +03:00
< bridge name="virbr2" stp="on" delay="0"/>
2016-11-12 01:40:27 +03:00
< mac address='00:16:3E:5D:C7:9E'/>
< /network> < / pre >
2012-12-03 20:13:36 +04:00
2008-04-23 21:08:31 +04:00
< / body >
< / html >
