diff --git a/docs/formatnetwork.html.in b/docs/formatnetwork.html.in index cc7d7c7e7a..9cf940052b 100644 --- a/docs/formatnetwork.html.in +++ b/docs/formatnetwork.html.in @@ -968,49 +968,44 @@
ip
The address attribute defines an IPv4 address in - 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 netmask - 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, you can specify - the significant bits of the network address with the prefix - attribute, which is an integer (for example, netmask='255.255.255.0' - could also be given as prefix='24'. The family - attribute is used to specify the type of address - 'ipv4' or 'ipv6'; if no - family is given, 'ipv4' is assumed. A network can have more than - one of each family of address defined, but only a single IPv4 address can have a - dhcp or tftp element. Since 0.3.0 - IPv6, multiple addresses on a single network, family, and - prefix are support Since 0.8.7. - Similar to IPv4, one IPv6 address per network can also have - a dhcp definition. Since 1.0.1 + 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 + netmask 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 + prefix attribute, which is an integer (for example, + netmask='255.255.255.0' could also be given as + prefix='24'). The family attribute is used + to specify the type of address — ipv4 or + ipv6; if no family is given, + ipv4 is assumed. More than one address of each family can + be defined for a network. The ip element is supported + since 0.3.0. IPv6, multiple addresses on a + single network, family, and prefix are + supported since 0.8.7. The ip + element may contain the following elements:
tftp
-
Immediately within - the ip element there is an optional tftp - element. The presence of this element and of its attribute - root enables TFTP services. The attribute specifies - the path to the root directory served via TFTP. tftp is not - supported for IPv6 addresses, and can only be specified on a single IPv4 address - per network. +
The optional tftp element and its mandatory + root attribute enable TFTP services. The attribute + specifies the path to the root directory served via TFTP. The + tftp element is not supported for IPv6 addresses, + and can only be specified on a single IPv4 address per network. Since 0.7.1
dhcp
-
Also within the ip element there is an - optional dhcp element. The presence of this element - enables DHCP services on the virtual network. It will further - contain one or more range elements. The - dhcp element supported for both - IPv4 Since 0.3.0 - and IPv6 Since 1.0.1, but - only for one IP address of each type per network. +
The presence of this element enables DHCP services on the + virtual network. The dhcp element is supported for + both IPv4 (since 0.3.0) and IPv6 + (since 1.0.1), but only for one IP + address of each type per network. The following sub-elements are + supported:
range
The start and end attributes on the @@ -1020,39 +1015,39 @@ ip element. There may be zero or more range elements specified. Since 0.3.0 - range can be specified for one IPv4 address, - one IPv6 address, or both. Since 1.0.1
host
-
Within the dhcp element there may be zero or more - host elements. These specify hosts which will be given - names and predefined IP addresses by the built-in DHCP server. Any - IPv4 host element must specify the MAC address of the host to be assigned - a given name (via the mac attribute), the IP to be - assigned to that host (via the ip attribute), and the - name to be given that host by the DHCP server (via the - name attribute). Since 0.4.5 - An IPv6 host element differs slightly from that for IPv4: - there is no mac attribute since a MAC address has no - defined meaning in IPv6. Instead, the name 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 instead of the mac - attribute for IPv4. Since 1.0.1 +
Within the dhcp element there may be zero or + more host elements. These specify hosts which will + be given names and predefined IP addresses by the built-in DHCP + server. Any IPv4 host element must specify the MAC + address of the host to be assigned a given name (via the + mac attribute), the IP to be assigned to that host + (via the ip attribute), and the name itself (the + name attribute). The IPv6 host + element differs slightly from that for IPv4: there is no + mac attribute since a MAC address has no defined + meaning in IPv6. Instead, the name 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 + mac attribute. + Since 0.4.5
bootp
-
The optional bootp - element specifies BOOTP options to be provided by the DHCP - server for IPv4 only. - Two attributes are supported: file is mandatory and - gives the file to be used for the boot image; server is - optional and gives the address of the TFTP server from which the boot - image will be fetched. server defaults to the same host - that runs the DHCP server, as is the case when the tftp - element is used. The BOOTP options currently have to be the same - for all address ranges and statically assigned addresses.Since 0.7.1 (server since 0.7.3). +
The optional bootp element specifies BOOTP + options to be provided by the DHCP server for IPv4 only. Two + attributes are supported: file is mandatory and + gives the file to be used for the boot image; + server is optional and gives the address of the + TFTP server from which the boot image will be fetched. + server defaults to the same host that runs the + DHCP server, as is the case when the tftp element + is used. The BOOTP options currently have to be the same for + all address ranges and statically assigned addresses. Since 0.7.1 (server + since 0.7.3)