doc: document DHCP server options in AP profiles

This commit is contained in:
James Prestwood 2020-11-04 08:52:27 -08:00 committed by Denis Kenzior
parent 946a67502b
commit 32db13aef8
1 changed files with 48 additions and 0 deletions

View File

@ -56,6 +56,54 @@ configuration.
Passphrase to be used with this access point.
DHCP Server Settings
--------------------
The group ``[IPv4]`` contains settings for IWD's built in DHCP server. All
settings are optional.
.. list-table::
:header-rows: 0
:stub-columns: 0
:widths: 20 80
* - Address
- IP Address of AP
Optional address for the DHCP server/access point. If provided this
address will be set on the AP interface and any other DHCP server options
will be derived from this address, unless they are overriden inside the
AP profile. If [IPv4].Address is not provided and no IP address is set
on the interface prior to calling StartProfile the IP pool will be used.
* - Gateway
- IP Address of gateway
IP address of gateway. This will inherit from [IPv4].Address if not
provided.
* - Netmask
- Netmask of DHCP server
This will be generated from [IPv4].Address if not provided.
* - DNSList
- List of DNS servers
A list of DNS servers which will be advertised by the DHCP server. If
not provided no DNS servers will be sent by the DHCP server.
* - LeaseTime
- Time limit for DHCP leases
Override the default lease time.
* - IPRange
- Range of IPs to use for the DHCP server
If not provided a default range will be chosen which is the DHCP server
address + 1 to 254.
SEE ALSO
========