summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRobert Göhler <github@ghlr.de>2023-12-28 11:36:47 +0100
committerGitHub <noreply@github.com>2023-12-28 11:36:47 +0100
commit7bfb181bda71a05a1498bc02072dacc76376035f (patch)
tree52764622a750d54acfc53d33596b03cad7be8be4 /docs
parentb77163ebed5d7356d1c4fbf576b10c39996b26e3 (diff)
parent0893ca769b1796d2d61dc26a0c0c13d1eda56f5e (diff)
downloadvyos-documentation-7bfb181bda71a05a1498bc02072dacc76376035f.tar.gz
vyos-documentation-7bfb181bda71a05a1498bc02072dacc76376035f.zip
Merge pull request #1207 from nicolas-fort/leases
dhcp-server: update docs for op-mode command <show dhcp server leases>
Diffstat (limited to 'docs')
-rw-r--r--docs/configuration/firewall/global-options.rst2
-rw-r--r--docs/configuration/service/dhcp-server.rst34
2 files changed, 30 insertions, 6 deletions
diff --git a/docs/configuration/firewall/global-options.rst b/docs/configuration/firewall/global-options.rst
index 455e530b..b3f311aa 100644
--- a/docs/configuration/firewall/global-options.rst
+++ b/docs/configuration/firewall/global-options.rst
@@ -1,4 +1,4 @@
-:lastproofread: 2023-12-026
+:lastproofread: 2023-12-26
.. _firewall-global-options-configuration:
diff --git a/docs/configuration/service/dhcp-server.rst b/docs/configuration/service/dhcp-server.rst
index b5b12a5b..0cc10feb 100644
--- a/docs/configuration/service/dhcp-server.rst
+++ b/docs/configuration/service/dhcp-server.rst
@@ -549,18 +549,43 @@ Operation Mode
.. code-block:: none
vyos@vyos:~$ show dhcp server leases
- IP address Hardware address State Lease start Lease expiration Remaining Pool Hostname
- -------------- ------------------ ------- ------------------- ------------------- ---------- ----------- ---------
- 192.0.2.104 00:53:01:dd:ee:ff active 2019/12/05 14:24:23 2019/12/06 02:24:23 6:05:35 dhcpexample test1
- 192.0.2.115 00:53:01:ae:af:bf active 2019/12/05 18:02:37 2019/12/06 06:02:37 9:43:49 dhcpexample test2
+ IP Address MAC address State Lease start Lease expiration Remaining Pool Hostname Origin
+ -------------- ----------------- ------- ------------------- ------------------- ----------- -------- ---------- --------
+ 192.168.11.134 00:50:79:66:68:09 active 2023/11/29 09:51:05 2023/11/29 10:21:05 0:24:10 LAN VPCS1 local
+ 192.168.11.133 50:00:00:06:00:00 active 2023/11/29 09:51:38 2023/11/29 10:21:38 0:24:43 LAN VYOS-6 local
+ 10.11.11.108 50:00:00:05:00:00 active 2023/11/29 09:51:43 2023/11/29 10:21:43 0:24:48 VIF-1001 VYOS5 local
+ 192.168.11.135 00:50:79:66:68:07 active 2023/11/29 09:55:16 2023/11/29 09:59:16 0:02:21 remote
+ vyos@vyos:~$
.. hint:: Static mappings aren't shown. To show all states, use
``show dhcp server leases state all``.
+.. opcmd:: show dhcp server leases origin [local | remote]
+
+ Show statuses of all active leases granted by local (this server) or
+ remote (failover server):
+
+.. code-block:: none
+
+ vyos@vyos:~$ show dhcp server leases origin remote
+ IP Address MAC address State Lease start Lease expiration Remaining Pool Hostname Origin
+ -------------- ----------------- ------- ------------------- ------------------- ----------- -------- ---------- --------
+ 192.168.11.135 00:50:79:66:68:07 active 2023/11/29 09:55:16 2023/11/29 09:59:16 0:02:21 remote
+ vyos@vyos:~$
+
.. opcmd:: show dhcp server leases pool <pool>
Show only leases in the specified pool.
+.. code-block:: none
+
+ vyos@vyos:~$ show dhcp server leases pool LAN
+ IP Address MAC address State Lease start Lease expiration Remaining Pool Hostname Origin
+ -------------- ----------------- ------- ------------------- ------------------- ----------- ------ ---------- --------
+ 192.168.11.134 00:50:79:66:68:09 active 2023/11/29 09:51:05 2023/11/29 10:21:05 0:23:55 LAN VPCS1 local
+ 192.168.11.133 50:00:00:06:00:00 active 2023/11/29 09:51:38 2023/11/29 10:21:38 0:24:28 LAN VYOS-6 local
+ vyos@vyos:~$
+
.. opcmd:: show dhcp server leases sort <key>
Sort the output by the specified key. Possible keys: ip, hardware_address,
@@ -572,7 +597,6 @@ Operation Mode
free, expired, released, abandoned, reset, backup (default = active)
-
***********
IPv6 server
***********