diff options
| author | kmpm <peter@birchroad.net> | 2019-01-20 19:47:04 +0100 |
|---|---|---|
| committer | kmpm <peter@birchroad.net> | 2019-01-20 19:47:04 +0100 |
| commit | e6fa2569332c15a61f3c99ba0fe639696836d3bd (patch) | |
| tree | ea76f27cd53bd4f4de869e5fc7f2654775cb5501 /docs/interfaces/index.rst | |
| parent | bc5ad9350e7444d5efc470340cb0c979c0606e0c (diff) | |
| download | vyos-documentation-e6fa2569332c15a61f3c99ba0fe639696836d3bd.tar.gz vyos-documentation-e6fa2569332c15a61f3c99ba0fe639696836d3bd.zip | |
Split network-interfaces into multiple files
- Now sections as separate files under interfaces/
- Fixed some references
Diffstat (limited to 'docs/interfaces/index.rst')
| -rw-r--r-- | docs/interfaces/index.rst | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/docs/interfaces/index.rst b/docs/interfaces/index.rst new file mode 100644 index 00000000..577ffe09 --- /dev/null +++ b/docs/interfaces/index.rst @@ -0,0 +1,60 @@ +.. _network-interfaces: + +Network Interfaces +================== + +Configured interfaces on a VyOS system can be displayed using the +`show interfaces` command. + +.. code-block:: sh + + 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 + vyos@vyos:~$ + +A specific interface can be shown using the `show interfaces <type> <name>` +command. + +.. code-block:: sh + + vyos@vyos:~$ show interfaces ethernet eth0 + eth0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc pfifo_fast state UP qlen 1000 + link/ether 00:0c: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 + vyos@vyos:~$ + +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 + :hidden: + + addresses + ethernet + wireless + bridging + bonding + vti + vlan + vxlan + wireguard |