diff options
| author | LiudmylaNad <l.nadolina@vyos.io> | 2026-05-01 19:14:14 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2026-05-01 18:14:14 +0100 |
| commit | 836f5de1ec10a21b41542b548a3a70bb9e47bcb5 (patch) | |
| tree | b54260cbc9e9233aee8a47eceab247c00a6d6c73 /docs | |
| parent | 6a0ea2794ba25e90bff042282c6ddeb8da37259a (diff) | |
| download | vyos-documentation-836f5de1ec10a21b41542b548a3a70bb9e47bcb5.tar.gz vyos-documentation-836f5de1ec10a21b41542b548a3a70bb9e47bcb5.zip | |
DOCS: Update ARP page to VyOS 1.5 standards (#1859)
* DOC: Revise arp.rst
* Fix incorrect facts about ARP
---------
Co-authored-by: Daniil Baturin <daniil@baturin.org>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/configuration/protocols/arp.rst | 69 |
1 files changed, 35 insertions, 34 deletions
diff --git a/docs/configuration/protocols/arp.rst b/docs/configuration/protocols/arp.rst index 3d39a816..00865104 100644 --- a/docs/configuration/protocols/arp.rst +++ b/docs/configuration/protocols/arp.rst @@ -1,63 +1,64 @@ .. _routing-static-arp: +.. meta:: + :description: The Address Resolution Protocol (ARP) resolves + network-layer addresses to link-layer MAC addresses. + :keywords: arp, network, protocol, mac, address, ipv4, static ### ARP ### -:abbr:`ARP (Address Resolution Protocol)` is a communication protocol used for -discovering the link layer address, such as a MAC address, associated with a -given internet layer address, typically an IPv4 address. This mapping is a -critical function in the Internet protocol suite. ARP was defined in 1982 by -:rfc:`826` which is Internet Standard STD 37. +The :abbr:`ARP (Address Resolution Protocol)` resolves IPv4 network layer addresses +to link layer MAC addresses. +addresses. This mapping is essential for communication within the Internet +Protocol suite. ARP was standardized in 1982 by :rfc:`826` (STD 37). -In Internet Protocol Version 6 (IPv6) networks, the functionality of ARP is -provided by the Neighbor Discovery Protocol (NDP). +.. note:: In Internet Protocol version 6 (IPv6) networks, address resolution is + performed by the Neighbor Discovery Protocol (NDP). -To manipulate or display ARP_ table entries, the following commands are -implemented. +Use the following commands to configure or view ARP table entries. -********* -Configure -********* +Configuration +------------- -.. cfgcmd:: set protocols static arp interface <interface> address <host> - mac <mac> +.. cfgcmd:: set protocols static arp interface <interface> address <host> mac <mac> - This will configure a static ARP entry always resolving `<address>` to - `<mac>` for interface `<interface>`. + **Configure a static ARP entry on the specified interface.** + + This creates a permanent mapping between an IP address and a MAC address + on the specified interface. Example: .. code-block:: none - set protocols static arp interface eth0 address 192.0.2.1 mac 01:23:45:67:89:01 - + set protocols static arp interface eth0 address 192.0.2.1 mac 01:23:45:67:89:01 -********* Operation -********* +--------- .. opcmd:: show protocols static arp - Display all known ARP table entries spanning across all interfaces + Show all ARP table entries across all interfaces. -.. code-block:: none + .. code-block:: none - vyos@vyos:~$ show protocols static arp - Address HWtype HWaddress Flags Mask Iface - 10.1.1.1 ether 00:53:00:de:23:2e C eth1 - 10.1.1.100 ether 00:53:00:de:23:aa CM eth1 + vyos@vyos:~$ show protocols static arp + Address HWtype HWaddress Flags Mask Iface + 10.1.1.1 ether 00:53:00:de:23:2e C eth1 + 10.1.1.100 ether 00:53:00:de:23:aa CM eth1 +.. opcmd:: show protocols static arp interface <interface> -.. opcmd:: show protocols static arp interface eth1 + Show all ARP table entries for the specific interface. - Display all known ARP table entries on a given interface only (`eth1`): + Example for ``eth1``: -.. code-block:: none + .. code-block:: none - vyos@vyos:~$ show protocols static arp interface eth1 - Address HWtype HWaddress Flags Mask Iface - 10.1.1.1 ether 00:53:00:de:23:2e C eth1 - 10.1.1.100 ether 00:53:00:de:23:aa CM eth1 + vyos@vyos:~$ show protocols static arp interface eth1 + Address HWtype HWaddress Flags Mask Iface + 10.1.1.1 ether 00:53:00:de:23:2e C eth1 + 10.1.1.100 ether 00:53:00:de:23:aa CM eth1 -.. _ARP: https://en.wikipedia.org/wiki/Address_Resolution_Protocol +.. _ARP: https://en.wikipedia.org/wiki/Address_Resolution_Protocol
\ No newline at end of file |