[PATCH 01/10] docs: Document ability to configure lease time
In v6.3.0-rc1~64 we've introduced ability to configure lease
time, but forgot to document the feature. Let's fix that.
Fixes: 97a0aa246799c97d0a9ca9ecd6b4fd932ae4756c
Resolves: https://bugzilla.redhat.com/show_bug.cgi?id=1908631
Signed-off-by: Michal Privoznik <mprivozn(a)redhat.com>
---
docs/formatnetwork.html.in | 21 +++++++++++++++++++--
1 file changed, 19 insertions(+), 2 deletions(-)
diff --git a/docs/formatnetwork.html.in b/docs/formatnetwork.html.in
index f26909bec8..f5a48d9b92 100644
--- a/docs/formatnetwork.html.in
+++ b/docs/formatnetwork.html.in
@@ -930,8 +930,12 @@
</dns>
<ip address="192.168.122.1" netmask="255.255.255.0"
localPtr="yes">
<dhcp>
- <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"/>
+ <range start="192.168.122.100"
end="192.168.122.254">
+ <lease expiry='1' unit='hours'/>
+ </range>
+ <host mac="00:16:3e:77:e2:ed" name="foo.example.com"
ip="192.168.122.10">
+ <lease expiry='30' unit='minutes'/>
+ </host>
<host mac="00:16:3e:3e:a9:1a" name="bar.example.com"
ip="192.168.122.11"/>
</dhcp>
</ip>
@@ -1130,6 +1134,19 @@
<span class="since">since 0.7.3</span>)
</dd>
</dl>
+
+ <p>
+ Optionally, <code>range</code> and
<code>host</code> elements can
+ have <code>lease</code> child element which specifies the
lease
+ time through it's attributes <code>expiry</code> and
+ <code>unit</code> (which accepts
<code>seconds</code>,
+ <code>minutes</code> and <code>hours</code> and
defaults to
+ <code>minutes</code> if omitted). The minimal lease time is 2
+ minutes, except when setting an infinite lease time
+ (<code>expiry='0'</code>).
+ <span class="since">Since 6.3.0</span>
+ </p>
+
</dd>
</dl>
</dd>
--
2.26.2