diff options
| author | Christian Poessinger <christian@poessinger.com> | 2019-11-19 07:16:57 +0100 |
|---|---|---|
| committer | Christian Poessinger <christian@poessinger.com> | 2019-11-19 07:16:59 +0100 |
| commit | d31736cd25184ba78bb9ef570534cd91d0ebe962 (patch) | |
| tree | 66638e83f353950a6fb761603c729e8f548fb039 /docs/routing | |
| parent | 40a202c3b992c1dd9950740eb1c2cfad67afb928 (diff) | |
| download | vyos-documentation-d31736cd25184ba78bb9ef570534cd91d0ebe962.tar.gz vyos-documentation-d31736cd25184ba78bb9ef570534cd91d0ebe962.zip | |
arp: restructure chapter
- Use initial passage from WikiPedia (thanks)
- use new style .. option:: for operational commands
Diffstat (limited to 'docs/routing')
| -rw-r--r-- | docs/routing/arp.rst | 52 |
1 files changed, 31 insertions, 21 deletions
diff --git a/docs/routing/arp.rst b/docs/routing/arp.rst index 0b9bb3a7..55b8666f 100644 --- a/docs/routing/arp.rst +++ b/docs/routing/arp.rst @@ -1,34 +1,44 @@ .. _routing-arp: -Address Resolution Protocol (ARP) ---------------------------------- +ARP +--- -To manipulate or display ARP_ table entries, the following commands are implemented. +: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. -adding a static arp entry -^^^^^^^^^^^^^^^^^^^^^^^^^ +In Internet Protocol Version 6 (IPv6) networks, the functionality of ARP is +provided by the Neighbor Discovery Protocol (NDP). -.. code-block:: sh +To manipulate or display ARP_ table entries, the following commands are +implemented. - set protocols static arp 10.1.1.100 hwaddr 08:00:27:de:23:aa - commit +.. option:: set protocols static arp 10.1.1.100 hwaddr 08:00:27:de:23:aa -display arp table entries -^^^^^^^^^^^^^^^^^^^^^^^^^ + adding a static arp entry -.. code-block:: sh +.. option:: show protocols static arp - show protocols static arp + In operational level, display all known ARP table entries + .. - Address HWtype HWaddress Flags Mask Iface - 10.1.1.1 ether 08:00:27:de:23:2e C eth1 - 10.1.1.100 ether 08:00:27:de:23:aa CM eth1 + vyos@vyos:~$ show protocols static arp + Address HWtype HWaddress Flags Mask Iface + 10.1.1.1 ether 08:00:27:de:23:2e C eth1 + 10.1.1.100 ether 08:00:27:de:23:aa CM eth1 -.. code-block:: sh +.. option:: show protocols static arp interface eth1 - show protocols static arp interface eth1 - Address HWtype HWaddress Flags Mask Iface - 10.1.1.1 ether 08:00:27:de:23:2e C eth1 - 10.1.1.100 ether 08:00:27:de:23:aa CM eth1 + In operational level, display all known ARP table entries on a specific + interface. + + .. -.. _ARP: https://en.wikipedia.org/wiki/Address_Resolution_Protocol + vyos@vyos:~$ show protocols static arp interface eth1 + Address HWtype HWaddress Flags Mask Iface + 10.1.1.1 ether 08:00:27:de:23:2e C eth1 + 10.1.1.100 ether 08:00:27:de:23:aa CM eth1 + +.. _ARP: https://en.wikipedia.org/wiki/Address_Resolution_Protocol
\ No newline at end of file |