diff options
| -rw-r--r-- | docs/index.rst | 3 | ||||
| -rw-r--r-- | docs/interfaces/basic-index.rst | 52 | ||||
| -rw-r--r-- | docs/interfaces/index.rst | 7 |
3 files changed, 56 insertions, 6 deletions
diff --git a/docs/index.rst b/docs/index.rst index 4d25bb09..93541f39 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -23,7 +23,7 @@ VyOS User Guide :maxdepth: 2 configuration-overview - interfaces/index + interfaces/basic-index system/basic-index image-mgmt @@ -33,6 +33,7 @@ VyOS User Guide :name: advanced :maxdepth: 2 + interfaces/index services/index system/index firewall 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 <type> <name>`` +command. + +.. code-block:: none + + vyos@vyos:~$ show interfaces ethernet eth0 + eth0: <BROADCAST,MULTICAST,UP,LOWER_UP> 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 diff --git a/docs/interfaces/index.rst b/docs/interfaces/index.rst index 0513adf1..95f60d11 100644 --- a/docs/interfaces/index.rst +++ b/docs/interfaces/index.rst @@ -47,14 +47,11 @@ respective sections. .. toctree:: :maxdepth: 2 - addresses dummy - ethernet - l2tpv3 - pppoe - wireless bridge bond + l2tpv3 + wireless tunnel vlan qinq |