From 2aaeedd7c1533a1458b48b57ac9fbccead376261 Mon Sep 17 00:00:00 2001 From: Christian Poessinger Date: Sat, 21 Dec 2019 18:57:24 +0100 Subject: interface: split into basic and advanced section --- docs/interfaces/basic-index.rst | 52 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 docs/interfaces/basic-index.rst (limited to 'docs/interfaces/basic-index.rst') diff --git a/docs/interfaces/basic-index.rst b/docs/interfaces/basic-index.rst new file mode 100644 index 00000000..67be1a90 --- /dev/null +++ b/docs/interfaces/basic-index.rst @@ -0,0 +1,52 @@ +.. _basic_network-interfaces: + +################## +Network Interfaces +################## + +Configured interfaces on a VyOS system can be displayed using the +``show interfaces`` command. + +.. code-block:: none + + vyos@vyos:~$ show interfaces + Codes: S - State, L - Link, u - Up, D - Down, A - Admin Down + Interface IP Address S/L Description + --------- ---------- --- ----------- + eth0 172.16.51.129/24 u/u OUTSIDE + eth1 192.168.0.1/24 u/u INSIDE + lo 127.0.0.1/8 u/u + ::1/128 + +A specific interface can be shown using the ``show interfaces `` +command. + +.. code-block:: none + + vyos@vyos:~$ show interfaces ethernet eth0 + eth0: mtu 1500 qdisc pfifo_fast state UP qlen 1000 + link/ether 00:53:29:44:3b:0f brd ff:ff:ff:ff:ff:ff + inet 172.16.51.129/24 brd 172.16.51.255 scope global eth0 + inet6 fe80::20c:29ff:fe44:3b0f/64 scope link + valid_lft forever preferred_lft forever + Description: OUTSIDE + + RX: bytes packets errors dropped overrun mcast + 274397 3064 0 0 0 0 + TX: bytes packets errors dropped carrier collisions + 257276 1890 0 0 0 0 + +Different network interfaces provide type-specific configuration. Ethernet +interfaces, for example, allow the configuration of speed and duplex. + +Many services, such as network routing, firewall, and traffic policy also +maintain interface-specific configuration. These will be covered in their +respective sections. + + +.. toctree:: + :maxdepth: 2 + + addresses + ethernet + pppoe -- cgit v1.2.3 From 554e5357b73dc5bae22aa6dc058587e2a1265236 Mon Sep 17 00:00:00 2001 From: Christian Poessinger Date: Sat, 21 Dec 2019 19:24:43 +0100 Subject: interface: remove addresses from basic-index --- docs/interfaces/addresses.rst | 3 +-- docs/interfaces/basic-index.rst | 1 - 2 files changed, 1 insertion(+), 3 deletions(-) (limited to 'docs/interfaces/basic-index.rst') diff --git a/docs/interfaces/addresses.rst b/docs/interfaces/addresses.rst index 709490c8..3fc9b89b 100644 --- a/docs/interfaces/addresses.rst +++ b/docs/interfaces/addresses.rst @@ -96,8 +96,7 @@ The command is ``set interfaces $type $name ipv6 address autoconf``. Examples: set interfaces ethernet eth0 vif 90 ipv6 address autoconf set interfaces bridge br0 ipv6 address autoconf -.. note:: This method automatically disables IPv6 traffic forwarding on the - interface in question. + EUI-64 ****** diff --git a/docs/interfaces/basic-index.rst b/docs/interfaces/basic-index.rst index 67be1a90..4f950a2b 100644 --- a/docs/interfaces/basic-index.rst +++ b/docs/interfaces/basic-index.rst @@ -47,6 +47,5 @@ respective sections. .. toctree:: :maxdepth: 2 - addresses ethernet pppoe -- cgit v1.2.3 From 79ccadbccbab3a44fd46b1a25940ffd26bee9554 Mon Sep 17 00:00:00 2001 From: Christian Poessinger Date: Sat, 21 Dec 2019 19:56:28 +0100 Subject: interfaces: basic: rename to "Basic Interfaces" --- docs/interfaces/basic-index.rst | 46 +++-------------------------------------- 1 file changed, 3 insertions(+), 43 deletions(-) (limited to 'docs/interfaces/basic-index.rst') diff --git a/docs/interfaces/basic-index.rst b/docs/interfaces/basic-index.rst index 4f950a2b..a59d8c47 100644 --- a/docs/interfaces/basic-index.rst +++ b/docs/interfaces/basic-index.rst @@ -1,48 +1,8 @@ .. _basic_network-interfaces: -################## -Network Interfaces -################## - -Configured interfaces on a VyOS system can be displayed using the -``show interfaces`` command. - -.. code-block:: none - - vyos@vyos:~$ show interfaces - Codes: S - State, L - Link, u - Up, D - Down, A - Admin Down - Interface IP Address S/L Description - --------- ---------- --- ----------- - eth0 172.16.51.129/24 u/u OUTSIDE - eth1 192.168.0.1/24 u/u INSIDE - lo 127.0.0.1/8 u/u - ::1/128 - -A specific interface can be shown using the ``show interfaces `` -command. - -.. code-block:: none - - vyos@vyos:~$ show interfaces ethernet eth0 - eth0: mtu 1500 qdisc pfifo_fast state UP qlen 1000 - link/ether 00:53:29:44:3b:0f brd ff:ff:ff:ff:ff:ff - inet 172.16.51.129/24 brd 172.16.51.255 scope global eth0 - inet6 fe80::20c:29ff:fe44:3b0f/64 scope link - valid_lft forever preferred_lft forever - Description: OUTSIDE - - RX: bytes packets errors dropped overrun mcast - 274397 3064 0 0 0 0 - TX: bytes packets errors dropped carrier collisions - 257276 1890 0 0 0 0 - -Different network interfaces provide type-specific configuration. Ethernet -interfaces, for example, allow the configuration of speed and duplex. - -Many services, such as network routing, firewall, and traffic policy also -maintain interface-specific configuration. These will be covered in their -respective sections. - +################ +Basic Interfaces +################ .. toctree:: :maxdepth: 2 -- cgit v1.2.3 From e3c3a6917be3a41a48847a7775a1baeb218ef974 Mon Sep 17 00:00:00 2001 From: Christian Poessinger Date: Sat, 21 Dec 2019 20:05:03 +0100 Subject: interfaces: set toc maxdepth to 1 --- docs/interfaces/advanced-index.rst | 2 +- docs/interfaces/basic-index.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/interfaces/basic-index.rst') diff --git a/docs/interfaces/advanced-index.rst b/docs/interfaces/advanced-index.rst index 9f137198..00c1c73e 100644 --- a/docs/interfaces/advanced-index.rst +++ b/docs/interfaces/advanced-index.rst @@ -5,7 +5,7 @@ Network Interfaces ################## .. toctree:: - :maxdepth: 2 + :maxdepth: 1 dummy bridge diff --git a/docs/interfaces/basic-index.rst b/docs/interfaces/basic-index.rst index a59d8c47..3477b238 100644 --- a/docs/interfaces/basic-index.rst +++ b/docs/interfaces/basic-index.rst @@ -5,7 +5,7 @@ Basic Interfaces ################ .. toctree:: - :maxdepth: 2 + :maxdepth: 1 ethernet pppoe -- cgit v1.2.3 From 92f65db0256c6f3bef42c62cb32ce02512944743 Mon Sep 17 00:00:00 2001 From: Christian Poessinger Date: Mon, 30 Dec 2019 12:13:36 +0100 Subject: loopback: add missing interface description --- docs/interfaces/basic-index.rst | 1 + docs/interfaces/loopback.rst | 69 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 70 insertions(+) create mode 100644 docs/interfaces/loopback.rst (limited to 'docs/interfaces/basic-index.rst') 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
+ + 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 + + Assign given `` 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: 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 -- cgit v1.2.3