diff options
| author | Christian Poessinger <christian@poessinger.com> | 2019-12-30 12:13:36 +0100 |
|---|---|---|
| committer | Christian Poessinger <christian@poessinger.com> | 2019-12-30 12:13:36 +0100 |
| commit | 92f65db0256c6f3bef42c62cb32ce02512944743 (patch) | |
| tree | ea51cdd58790f0ac375c1be0f344c3d3f3306d33 | |
| parent | 37850e2f6f9efed96c9e807fd98623465337d330 (diff) | |
| download | vyos-documentation-92f65db0256c6f3bef42c62cb32ce02512944743.tar.gz vyos-documentation-92f65db0256c6f3bef42c62cb32ce02512944743.zip | |
loopback: add missing interface description
| -rw-r--r-- | docs/interfaces/basic-index.rst | 1 | ||||
| -rw-r--r-- | docs/interfaces/loopback.rst | 69 |
2 files changed, 70 insertions, 0 deletions
diff --git a/docs/interfaces/basic-index.rst b/docs/interfaces/basic-index.rst index 3477b238..c652c7bb 100644 --- a/docs/interfaces/basic-index.rst +++ b/docs/interfaces/basic-index.rst @@ -8,4 +8,5 @@ Basic Interfaces :maxdepth: 1 ethernet + loopback pppoe diff --git a/docs/interfaces/loopback.rst b/docs/interfaces/loopback.rst new file mode 100644 index 00000000..ccdc88e5 --- /dev/null +++ b/docs/interfaces/loopback.rst @@ -0,0 +1,69 @@ +.. _loopback-interface: + +######## +Loopback +######## + +The loopback networking interface is a virtual network device implemented +entirely in software. All traffic sent to it "loops back" and just targets +services on your local machine. + +.. note:: There can only be one loopback ``lo`` interface on the system. If + you need multiple interfaces, please use the :ref:`dummy-interface` + interface type. + +Configuration +============= + +Address +------- + +.. cfgcmd:: set interfaces loopback lo address <address> + + Configure Loopback interface `lo` with one or more interface addresses. + + * **address** can be specified multiple times as IPv4 and/or IPv6 address, + e.g. 192.0.2.1/24 and/or 2001:db8::1/64 + +Link Administration +------------------- + +.. cfgcmd:: set interfaces loopback lo description <description> + + Assign given `<description>` to interface `lo`. Description will also be + passed to SNMP monitoring systems. + +Operation +========= + +.. opcmd:: show interfaces loopback + + Show brief interface information. + + .. code-block:: none + + vyos@vyos:~$ show interfaces loopback + Codes: S - State, L - Link, u - Up, D - Down, A - Admin Down + Interface IP Address S/L Description + --------- ---------- --- ----------- + lo 127.0.0.1/8 u/u + ::1/128 + +.. opcmd:: show interfaces loopback lo + + Show detailed information on given loopback interface `lo`. + + .. code-block:: none + + vyos@vyos:~$ show interfaces ethernet eth0 + lo: <LOOPBACK,UP,LOWER_UP> mtu 65536 qdisc noqueue state UNKNOWN group default qlen 1000 + link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00 + inet 127.0.0.1/8 scope host lo + valid_lft forever preferred_lft forever + inet6 ::1/128 scope host + valid_lft forever preferred_lft forever + + RX: bytes packets errors dropped overrun mcast + 300 6 0 0 0 0 + TX: bytes packets errors dropped carrier collisions + 300 6 0 0 0 0 |