summaryrefslogtreecommitdiff
path: root/docs/configuration/protocols/arp.md
blob: 7d9bf4f92789cd93f0e2d7dec4bd50d3d72cd73d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
```{eval-rst}
.. meta::
   :description: The Address Resolution Protocol (ARP) resolves
                 network-layer addresses to link-layer MAC addresses.
   :keywords: arp, network, protocol, mac, address, ipv4, static
```

(routing_static_arp)=

# ARP

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).

:::{note}
In Internet Protocol version 6 (IPv6) networks, address resolution is
performed by the Neighbor Discovery Protocol (NDP).
:::

Use the following commands to configure or view ARP table entries.

## Configuration

```{eval-rst}
.. cfgcmd:: set protocols static arp interface <interface> address <host> mac <mac>

   **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
```

## Operation

```{eval-rst}
.. opcmd:: show protocols static arp

   Show all ARP table entries across all interfaces.

   .. 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
```

```{eval-rst}
.. opcmd:: show protocols static arp interface <interface>

   Show all ARP table entries for the specific interface.

   Example for ``eth1``:

   .. 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
```

[arp]: https://en.wikipedia.org/wiki/Address_Resolution_Protocol