Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

T4389: extend DHCP server documentation on vendor options #1339

Merged
merged 2 commits into from
Mar 23, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 36 additions & 2 deletions docs/configuration/service/dhcp-server.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
Create DNS record per client lease, by adding clients to /etc/hosts file.
Entry will have format: `<shared-network-name>_<hostname>.<domain-name>`

.. cfgcmd:: set service dhcp-server shared-network-name <name> option domain-name <domain-name>

Check warning on line 29 in docs/configuration/service/dhcp-server.rst

View workflow job for this annotation

GitHub Actions / lint

Line too long: len=95

The domain-name parameter should be the domain name that will be appended to
the client's hostname to form a fully-qualified domain-name (FQDN) (DHCP
Expand All @@ -35,7 +35,7 @@
This is the configuration parameter for the entire shared network definition.
All subnets will inherit this configuration item if not specified locally.

.. cfgcmd:: set service dhcp-server shared-network-name <name> option domain-search <domain-name>

Check warning on line 38 in docs/configuration/service/dhcp-server.rst

View workflow job for this annotation

GitHub Actions / lint

Line too long: len=97

The domain-name parameter should be the domain name used when completing DNS
request where no full FQDN is passed. This option can be given multiple times
Expand All @@ -44,15 +44,31 @@
This is the configuration parameter for the entire shared network definition.
All subnets will inherit this configuration item if not specified locally.

.. cfgcmd:: set service dhcp-server shared-network-name <name> option name-server <address>

Check warning on line 47 in docs/configuration/service/dhcp-server.rst

View workflow job for this annotation

GitHub Actions / lint

Line too long: len=91

Inform client that the DNS server can be found at `<address>`.

This is the configuration parameter for the entire shared network definition.
All subnets will inherit this configuration item if not specified locally.

All subnets will inherit this configuration item if not specified locally.
Multiple DNS servers can be defined.

.. cfgcmd:: set service dhcp-server shared-network-name <name> option
vendor-option <option-name>

This configuration parameter lets you specify a vendor-option for the
entire shared network definition. All subnets will inherit this
configuration item if not specified locally. An example for Ubiquiti is
shown below:

**Example:**

Pass address of Unifi controller at ``172.16.100.1`` to all clients of ``NET1``

.. code-block:: none

set service dhcp-server shared-network-name 'NET1' option vendor-option
ubiquiti '172.16.100.1'

.. cfgcmd:: set service dhcp-server listen-address <address>

This configuration parameter lets the DHCP server to listen for DHCP
Expand Down Expand Up @@ -132,6 +148,24 @@
request where no full FQDN is passed. This option can be given multiple times
if you need multiple search domains (DHCP Option 119).

.. cfgcmd:: set service dhcp-server shared-network-name <name> subnet <subnet>
option vendor-option <option-name>

This configuration parameter lets you specify a vendor-option for the
subnet specified within the shared network definition. An example for
Ubiquiti is shown below:

**Example:**

Create ``172.18.201.0/24`` as a subnet within ``NET1`` and pass address of
Unifi controller at ``172.16.100.1`` to clients of that subnet.

.. code-block:: none

set service dhcp-server shared-network-name 'NET1' subnet
'172.18.201.0/24' option vendor-option ubiquiti '172.16.100.1'


Failover
--------

Expand Down Expand Up @@ -205,7 +239,7 @@

**Example:**

* IP address ``192.168.1.100`` shall be statically mapped to client named ``client1``

Check warning on line 242 in docs/configuration/service/dhcp-server.rst

View workflow job for this annotation

GitHub Actions / lint

Line too long: len=85

.. code-block:: none

Expand Down
Loading