3
0
mirror of https://git.kernel.org/pub/scm/network/wireless/iwd.git synced 2024-11-26 10:39:23 +01:00

doc: Clarify settings in iwd.ap(5)

Change some of the wording, add some references and more specific syntax
information (time units, IP list separator character, etc.)
This commit is contained in:
Andrew Zaborowski 2021-04-27 01:34:07 +02:00 committed by Denis Kenzior
parent ab6cd7e465
commit 5cc0f68d51

View File

@ -3,7 +3,7 @@
============ ============
-------------------------------------- --------------------------------------
Configuration of IWD access point Configuration of IWD access points
-------------------------------------- --------------------------------------
:Author: James Prestwood <prestwoj@gmail.com> :Author: James Prestwood <prestwoj@gmail.com>
@ -25,19 +25,21 @@ Description of access point provisioning files.
DESCRIPTION DESCRIPTION
=========== ===========
An access point provisioning files define the configuration of an IWD access An access point provisioning file defines the configuration of an IWD access
point. These files live in *$STATE_DIRECTORY*/ap (/var/lib/iwd/ap by default). point. These files live in *$STATE_DIRECTORY*/ap (/var/lib/iwd/ap by default).
They are read when the `net.connman.iwd.AccessPoint.StartProfile(ssid)` DBus
method is used.
FILE FORMAT FILE FORMAT
=========== ===========
See *iwd.network* for details on the file format. See *iwd.network* for details on the settings file syntax.
SETTINGS SETTINGS
======== ========
The settings are split into several categories. Each category has a group The settings are split into several categories. Each category has a group
associated with it and described in separate tables below. associated with it and is described in the corresponding table below.
Network Authentication Settings Network Authentication Settings
------------------------------- -------------------------------
@ -54,13 +56,23 @@ configuration.
* - Passphrase * - Passphrase
- 8..63 character string - 8..63 character string
Passphrase to be used with this access point. WPA-PSK Passphrase to be used with this access point.
DHCP Server Settings IPv4 Network Configuration
-------------------- --------------------------
The group ``[IPv4]`` contains settings for IWD's built in DHCP server. All The group ``[IPv4]`` contains settings for IWD's built-in DHCP server. All
settings are optional. settings are optional. They're used if network configuration was enabled as
described in ``iwd.config(5)``. Omitting the ``[IPv4]`` group disables
network configuration for this access point so if an all-defaults DHCP setup
is desired, the group header line must still be present:
.. code-block::
# Enable network configuration
[IPv4]
[other groups follow]
.. list-table:: .. list-table::
:header-rows: 0 :header-rows: 0
@ -68,41 +80,42 @@ settings are optional.
:widths: 20 80 :widths: 20 80
* - Address * - Address
- IP Address of AP - Local IP address
Optional address for the DHCP server/access point. If provided this Optional local address pool for the access point and the DHCP server.
address will be set on the AP interface and any other DHCP server options If provided this addresss will be set on the AP interface and any other
will be derived from this address, unless they are overriden inside the DHCP server options will be derived from it, unless they are overridden
AP profile. If [IPv4].Address is not provided and no IP address is set by other settings below. If *Address* is not provided and no IP
on the interface prior to calling StartProfile the IP pool will be used. address is set on the interface prior to calling `StartProfile`, the IP
pool defined by the global ``[General].APRanges`` setting will be used.
* - Gateway * - Gateway
- IP Address of gateway - IP Address of gateway
IP address of gateway. This will inherit from [IPv4].Address if not IP address of the gateway to be advertised by DHCP. This will fall back
provided. to the local IP address if not provided.
* - Netmask * - Netmask
- Netmask of DHCP server - Local netmask of the AP
This will be generated from [IPv4].Address if not provided. This will be generated from ``[IPv4].Address`` if not provided.
* - DNSList * - DNSList
- List of DNS servers - List of DNS servers as a comma-separated IP address list
A list of DNS servers which will be advertised by the DHCP server. If 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. not provided no DNS servers will be sent by the DHCP server.
* - LeaseTime * - LeaseTime
- Time limit for DHCP leases - Time limit for DHCP leases in seconds
Override the default lease time. Override the default lease time.
* - IPRange * - IPRange
- Range of IPs to use for the DHCP server - Range of IPs given as two addresses separated by a comma
If not provided a default range will be chosen which is the DHCP server From and to addresses of the range assigned to clients through DHCP.
address + 1 to 254. If not provided the range from local address + 1 to .254 will be used.
SEE ALSO SEE ALSO
======== ========