summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2019-12-21 19:58:15 +0100
committerChristian Poessinger <christian@poessinger.com>2019-12-21 19:58:15 +0100
commit954ee55be75d799b57350cc3926b2a7e14d85858 (patch)
treefd9ddbf8a52a62425104d1bbcb21f2b19ee6eb4b /docs
parent79ccadbccbab3a44fd46b1a25940ffd26bee9554 (diff)
downloadvyos-documentation-954ee55be75d799b57350cc3926b2a7e14d85858.tar.gz
vyos-documentation-954ee55be75d799b57350cc3926b2a7e14d85858.zip
interfaces: rename index to advanced-index
Diffstat (limited to 'docs')
-rw-r--r--docs/index.rst2
-rw-r--r--docs/interfaces/advanced-index.rst19
-rw-r--r--docs/interfaces/index.rst59
3 files changed, 20 insertions, 60 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 93541f39..affde670 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -33,7 +33,7 @@ VyOS User Guide
:name: advanced
:maxdepth: 2
- interfaces/index
+ interfaces/advanced-index
services/index
system/index
firewall
diff --git a/docs/interfaces/advanced-index.rst b/docs/interfaces/advanced-index.rst
new file mode 100644
index 00000000..9f137198
--- /dev/null
+++ b/docs/interfaces/advanced-index.rst
@@ -0,0 +1,19 @@
+.. _network-interfaces:
+
+##################
+Network Interfaces
+##################
+
+.. toctree::
+ :maxdepth: 2
+
+ dummy
+ bridge
+ bond
+ l2tpv3
+ wireless
+ tunnel
+ vlan
+ qinq
+ vxlan
+ geneve
diff --git a/docs/interfaces/index.rst b/docs/interfaces/index.rst
deleted file mode 100644
index 95f60d11..00000000
--- a/docs/interfaces/index.rst
+++ /dev/null
@@ -1,59 +0,0 @@
-.. _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
-
- dummy
- bridge
- bond
- l2tpv3
- wireless
- tunnel
- vlan
- qinq
- vxlan
- geneve