[libvirt] [PATCH] docs: add forward mode='hostdev' example

Also rearrange examples so that all "managed" networks (those with bridges created by libvirt) are together. --- docs/formatnetwork.html.in | 52 +++++++++++++++++++++++++++++++++------------- 1 file changed, 37 insertions(+), 15 deletions(-) diff --git a/docs/formatnetwork.html.in b/docs/formatnetwork.html.in index 4b4c47b..46b7270 100644 --- a/docs/formatnetwork.html.in +++ b/docs/formatnetwork.html.in @@ -332,7 +332,7 @@ </p> <pre> ... - &lt;forward mode='passthrough'&gt; + &lt;forward mode='passthrough' managed='yes'&gt; &lt;pf dev='eth0'/&gt; &lt;/forward&gt; ... @@ -863,6 +863,27 @@ &lt;/ip&gt; &lt;/network&gt;</pre> + <h3><a name="examplesNoGateway">Network config with no gateway addresses</a></h3> + + <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 <code>ipv6</code> attribute must be set to "yes" for + functional guest-to-guest IPv6 communication. + </p> + + <pre> + &lt;network ipv6='yes'&gt; + &lt;name&gt;nogw&lt;/name&gt; + &lt;bridge name="virbr2" stp="on" delay="0"/&gt; + &lt;/network&gt; + </pre> + <h3><a name="examplesBridge">Using an existing host bridge</a></h3> <p> @@ -916,25 +937,26 @@ &lt;/forward&gt; &lt;/network&gt;</pre> - <h3><a name="examplesNoGateway">Network config with no gateway addresses</a></h3> + <h3><a name="examplesPCIPassthrough">Assigning SR-IOV Virtual Functions via PCI Passthrough</a></h3> <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. + <span class="since">Since 0.9.10, requires a host with working + IOMMU</span> This example shows how to use a libvirt network to + assign individual SR-IOV Virtual Functions (VF) to guests using + PCI passthrough. Only the Physical Function (PF) of the SR-IOV + network adapter needs to be listed in the network definition; a + list of all VFs will be automatically derived from that, and VFs + will be allocated to guest domains as requested. </p> <pre> - &lt;network ipv6='yes'&gt; - &lt;name&gt;nogw&lt;/name&gt; - &lt;uuid&gt;7a3b7497-1ec7-8aef-6d5c-38dff9109e93&lt;/uuid&gt; - &lt;bridge name="virbr2" stp="on" delay="0" /&gt; - &lt;mac address='00:16:3E:5D:C7:9E'/&gt; - &lt;/network&gt;</pre> + &lt;network&gt; + &lt;name&gt;passthrough&lt;/name&gt; + &lt;forward mode='hostdev' managed='yes'&gt; + &lt;pf dev='eth3'/&gt; + &lt;/forward&gt; + &lt;/network&gt; + </pre> </body> </html> -- 1.7.11.7