shaba/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2025-01-27 18:03:50 +03:00
Code Releases Activity

formatnetwork: Cleanup /network/ip documentation

Browse Source 
Signed-off-by: Jiri Denemark <jdenemar@redhat.com>
This commit is contained in:
Jiri Denemark 2016-12-09 16:26:12 +01:00
parent df80cdf297
commit 6408f422a5
1 changed files with 60 additions and 65 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

125
docs/formatnetwork.html.in
View File

@ -968,49 +968,44 @@
</dd> </dd>
<dt><code>ip</code></dt> <dt><code>ip</code></dt>
<dd>The <code>address</code> attribute defines an IPv4 address in <dd>The <code>address</code> attribute defines an IPv4 address in
dotted-decimal format, or an IPv6 address in standard dotted-decimal format, or an IPv6 address in standard colon-separated
colon-separated hexadecimal format, that will be configured on hexadecimal format, that will be configured on the bridge device
the bridge associated with the virtual network. To the guests this IPv4 address
device associated with the virtual network. To the guests this IPv4 will be their IPv4 default route. For IPv6, the default route is
address will be their IPv4 default route. For IPv6, the default route is established via Router Advertisement. For IPv4 addresses, the
established via Router Advertisement. <code>netmask</code> attribute defines the significant bits of the
For IPv4 addresses, the <code>netmask</code> network address, again specified in dotted-decimal format. For IPv6
attribute defines the significant bits of the network address, addresses, and as an alternate method for IPv4 addresses, the
again specified in dotted-decimal format. For IPv6 addresses, significant bits of the network address can be specified with the
and as an alternate method for IPv4 addresses, you can specify <code>prefix</code> attribute, which is an integer (for example,
the significant bits of the network address with the <code>prefix</code> <code>netmask='255.255.255.0'</code> could also be given as
attribute, which is an integer (for example, <code>netmask='255.255.255.0'</code> <code>prefix='24'</code>). The <code>family</code> attribute is used
could also be given as <code>prefix='24'</code>. The <code>family</code> to specify the type of address &mdash; <code>ipv4</code> or
attribute is used to specify the type of address - 'ipv4' or 'ipv6'; if no <code>ipv6</code>; if no <code>family</code> is given,
<code>family</code> is given, 'ipv4' is assumed. A network can have more than <code>ipv4</code> is assumed. More than one address of each family can
one of each family of address defined, but only a single IPv4 address can have a be defined for a network. The <code>ip</code> element is supported
<code>dhcp</code> or <code>tftp</code> element. <span class="since">Since 0.3.0 </span> <span class="since">since 0.3.0</span>. IPv6, multiple addresses on a
IPv6, multiple addresses on a single network, <code>family</code>, and single network, <code>family</code>, and <code>prefix</code> are
<code>prefix</code> are support <span class="since">Since 0.8.7</span>. supported <span class="since">since 0.8.7</span>. The <code>ip</code>
Similar to IPv4, one IPv6 address per network can also have element may contain the following elements:
a <code>dhcp</code> definition. <span class="since">Since 1.0.1</span>
<dl> <dl>
<dt><code>tftp</code></dt> <dt><code>tftp</code></dt>
<dd>Immediately within <dd>The optional <code>tftp</code> element and its mandatory
the <code>ip</code> element there is an optional <code>tftp</code> <code>root</code> attribute enable TFTP services. The attribute
element. The presence of this element and of its attribute specifies the path to the root directory served via TFTP. The
<code>root</code> enables TFTP services. The attribute specifies <code>tftp</code> element is not supported for IPv6 addresses,
the path to the root directory served via TFTP. <code>tftp</code> is not and can only be specified on a single IPv4 address per network.
supported for IPv6 addresses, and can only be specified on a single IPv4 address
per network.
<span class="since">Since 0.7.1</span> <span class="since">Since 0.7.1</span>
</dd> </dd>
<dt><code>dhcp</code></dt> <dt><code>dhcp</code></dt>
<dd>Also within the <code>ip</code> element there is an <dd>The presence of this element enables DHCP services on the
optional <code>dhcp</code> element. The presence of this element virtual network. The <code>dhcp</code> element is supported for
enables DHCP services on the virtual network. It will further both IPv4 (<span class="since">since 0.3.0</span>) and IPv6
contain one or more <code>range</code> elements. The (<span class="since">since 1.0.1</span>), but only for one IP
<code>dhcp</code> element supported for both address of each type per network. The following sub-elements are
IPv4 <span class="since">Since 0.3.0</span> supported:
and IPv6 <span class="since">Since 1.0.1</span>, but
only for one IP address of each type per network.
<dl> <dl>
<dt><code>range</code></dt> <dt><code>range</code></dt>
<dd>The <code>start</code> and <code>end</code> attributes on the <dd>The <code>start</code> and <code>end</code> attributes on the
@ -1020,39 +1015,39 @@
<code>ip</code> element. There may be zero or more <code>ip</code> element. There may be zero or more
<code>range</code> elements specified. <code>range</code> elements specified.
<span class="since">Since 0.3.0</span> <span class="since">Since 0.3.0</span>
<code>range</code> can be specified for one IPv4 address,
one IPv6 address, or both. <span class="since">Since 1.0.1</span>
</dd> </dd>
<dt><code>host</code></dt> <dt><code>host</code></dt>
<dd>Within the <code>dhcp</code> element there may be zero or more <dd>Within the <code>dhcp</code> element there may be zero or
<code>host</code> elements. These specify hosts which will be given more <code>host</code> elements. These specify hosts which will
names and predefined IP addresses by the built-in DHCP server. Any be given names and predefined IP addresses by the built-in DHCP
IPv4 <code>host</code> element must specify the MAC address of the host to be assigned server. Any IPv4 <code>host</code> element must specify the MAC
a given name (via the <code>mac</code> attribute), the IP to be address of the host to be assigned a given name (via the
assigned to that host (via the <code>ip</code> attribute), and the <code>mac</code> attribute), the IP to be assigned to that host
name to be given that host by the DHCP server (via the (via the <code>ip</code> attribute), and the name itself (the
<code>name</code> attribute). <span class="since">Since 0.4.5</span> <code>name</code> attribute). The IPv6 <code>host</code>
An IPv6 <code>host</code> element differs slightly from that for IPv4: element differs slightly from that for IPv4: there is no
there is no <code>mac</code> attribute since a MAC address has no <code>mac</code> attribute since a MAC address has no defined
defined meaning in IPv6. Instead, the <code>name</code> attribute is meaning in IPv6. Instead, the <code>name</code> attribute is
used to identify the host to be assigned the IPv6 address. For DHCPv6, used to identify the host to be assigned the IPv6 address. For
the name is the plain name of the client host sent by the 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 client to the server. Note that this method of assigning a
specific IP address can also be used instead of the <code>mac</code> specific IP address can also be used for IPv4 instead of the
attribute for IPv4. <span class="since">Since 1.0.1</span> <code>mac</code> attribute.
<span class="since">Since 0.4.5</span>
</dd> </dd>
<dt><code>bootp</code></dt> <dt><code>bootp</code></dt>
<dd>The optional <code>bootp</code> <dd>The optional <code>bootp</code> element specifies BOOTP
element specifies BOOTP options to be provided by the DHCP options to be provided by the DHCP server for IPv4 only. Two
server for IPv4 only. attributes are supported: <code>file</code> is mandatory and
Two attributes are supported: <code>file</code> is mandatory and gives the file to be used for the boot image;
gives the file to be used for the boot image; <code>server</code> is <code>server</code> is optional and gives the address of the
optional and gives the address of the TFTP server from which the boot TFTP server from which the boot image will be fetched.
image will be fetched. <code>server</code> defaults to the same host <code>server</code> defaults to the same host that runs the
that runs the DHCP server, as is the case when the <code>tftp</code> DHCP server, as is the case when the <code>tftp</code> element
element is used. The BOOTP options currently have to be the same is used. The BOOTP options currently have to be the same for
for all address ranges and statically assigned addresses.<span all address ranges and statically assigned addresses. <span
class="since">Since 0.7.1 (<code>server</code> since 0.7.3).</span> class="since">Since 0.7.1</span> (<code>server</code>
<span class="since">since 0.7.3</span>)
</dd> </dd>
</dl> </dl>
</dd> </dd>