From 51b9acd79f87a8eba0621ed59cf48bac6222245b Mon Sep 17 00:00:00 2001
From: Ad Schellevis <ad@opnsense.org>
Date: Sun, 15 Oct 2023 15:29:19 +0200
Subject: [PATCH] Interfaces: Neighbors - add initial documentation, closes
 https://github.com/opnsense/docs/issues/506

---
 source/interfaces.rst       |  1 +
 source/manual/neighbors.rst | 31 +++++++++++++++++++++++++++++++
 2 files changed, 32 insertions(+)
 create mode 100644 source/manual/neighbors.rst

diff --git a/source/interfaces.rst b/source/interfaces.rst
index d685f9da..1810e3b1 100644
--- a/source/interfaces.rst
+++ b/source/interfaces.rst
@@ -18,6 +18,7 @@ All traffic flowing through your appliance is using (virtual) interfaces, this i
    manual/interfaces
    manual/interfaces_overview
    manual/interfaces_settings
+   manual/neighbors
    manual/firewall_vip
    manual/wireless
    manual/other-interfaces
diff --git a/source/manual/neighbors.rst b/source/manual/neighbors.rst
new file mode 100644
index 00000000..8e3ab30b
--- /dev/null
+++ b/source/manual/neighbors.rst
@@ -0,0 +1,31 @@
+===========================
+Neighbors
+===========================
+
+The neighbors section (available as of 24.1) allows the definition of static IPv4 and IPv6 addresses
+on your network.
+
+For IPv4 entries will be saved into the :code:`ARP` table, IPv6 uses :code:`NDP` to register machines mac addresses
+to IP addresses.
+
+These tables determine to which (physcal) machine an IP address is connected, which can be practical when arp
+messages are not being received or we want to force the ip/mac combination for specific clients.
+
+When opening the page it will show a grid containing all static entries defined, these may also originate from
+other components (such as dhcp), in which case you cannot edit them. Entries defined here do contain the following
+options:
+
+==============================================================================================================================================
+
+=========================== ==================================================================================================================
+Ether Address               Hardware MAC address of the cllient (format xx:xx:xx:xx:xx:xx)
+IP address                  IP address to assign to the provided MAC address, which will either end up in the arp (IPv4) or ndp (IPv6) table
+Description                 Description for internal use
+=========================== ==================================================================================================================
+
+
+.. Tip::
+
+    To analyse the current contents of the ARP or NDP tables, use the interface diagnostics menu detailed in
+    the :doc:`diagnostics </manual/diagnostics_interfaces>` document.
+