diff options
| author | Yuriy Andamasov <yuriy@vyos.io> | 2026-05-06 20:42:32 +0300 |
|---|---|---|
| committer | Yuriy Andamasov <yuriy@vyos.io> | 2026-05-06 20:42:32 +0300 |
| commit | 5d6fa52b8985f8068314aba26878a1d7d5cb84e5 (patch) | |
| tree | 99359ff282846e26b5c5fa2b9b176b35b172809f /docs/configuration/protocols/arp.md | |
| parent | 631e454d674ad5111d2b56a6964ead461894a1f6 (diff) | |
| download | vyos-documentation-5d6fa52b8985f8068314aba26878a1d7d5cb84e5.tar.gz vyos-documentation-5d6fa52b8985f8068314aba26878a1d7d5cb84e5.zip | |
feat: flip swap mechanism — MD as primary, RST as override (Phase 1)
This is the first of three phases inverting the per-page swap mechanism
so MD becomes the canonical primary and RST becomes the rare override.
Phase 1 — file renames + conf.py exclude_patterns flip only:
- Rename docs/**/md-<stem>.md to docs/**/<stem>.md (drop md- prefix)
for all 254 stems previously listed in docs/_swap.txt
- Rename docs/**/<stem>.rst to docs/**/rst-<stem>.rst (add rst- prefix)
for the same 254 stems
- Repurpose docs/_swap.txt as docs/_rst_overrides.txt; initially empty
comment-only since no pages need the RST fallback right now
- conf.py exclude_patterns flipped: rst-*.rst is now excluded by default
instead of md-*.md
- conf.py runtime-artifact references updated to _rst_override_state.json
and _md_exclude.txt (Phase 2 will rewrite swap_sources.py to produce
these names; for now no swap script runs because overrides list is empty)
Phase 2 (next commit on this branch) will rewrite scripts/swap_sources.py
with inverted rename direction, delete scripts/import_myst.py + tests, and
update tests/test_swap_sources.py for the new semantics.
Phase 3 will be the cleanup pass and ready-for-review flip.
Generated by robots https://vyos.io
Diffstat (limited to 'docs/configuration/protocols/arp.md')
| -rw-r--r-- | docs/configuration/protocols/arp.md | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/docs/configuration/protocols/arp.md b/docs/configuration/protocols/arp.md new file mode 100644 index 00000000..7d9bf4f9 --- /dev/null +++ b/docs/configuration/protocols/arp.md @@ -0,0 +1,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 + |
