From be6c3c1624174c5762a1349e31111d34db642767 Mon Sep 17 00:00:00 2001
From: Christian Poessinger <christian@poessinger.com>
Date: Tue, 10 Nov 2020 20:26:15 +0100
Subject: interfaces: add common description include file

---
 docs/_include/interface-address-with-dhcp.txt | 20 ++++++++++++++++++++
 docs/_include/interface-address.txt           | 11 ++---------
 docs/_include/interface-description.txt       | 10 ++++++++++
 3 files changed, 32 insertions(+), 9 deletions(-)
 create mode 100644 docs/_include/interface-address-with-dhcp.txt
 create mode 100644 docs/_include/interface-description.txt

(limited to 'docs/_include')

diff --git a/docs/_include/interface-address-with-dhcp.txt b/docs/_include/interface-address-with-dhcp.txt
new file mode 100644
index 00000000..28968bea
--- /dev/null
+++ b/docs/_include/interface-address-with-dhcp.txt
@@ -0,0 +1,20 @@
+.. cfgcmd:: set interfaces {{ var0 }} <interface> address <address | dhcp |
+   dhcpv6>
+
+   Configure interface `<interface>` 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
+   * **dhcp** interface address is received by DHCP from a DHCP server
+     on this segment.
+   * **dhcpv6** interface address is received by DHCPv6 from a DHCPv6
+     server on this segment.
+
+   Example:
+
+   .. code-block:: none
+
+     set interfaces {{ var0 }} {{ var1 }} address 192.0.2.1/24
+     set interfaces {{ var0 }} {{ var1 }} address 2001:db8::1/64
+     set interfaces {{ var0 }} {{ var1 }} dhcp
+     set interfaces {{ var0 }} {{ var1 }} dhcpv6
\ No newline at end of file
diff --git a/docs/_include/interface-address.txt b/docs/_include/interface-address.txt
index 1de05c31..4ca75940 100644
--- a/docs/_include/interface-address.txt
+++ b/docs/_include/interface-address.txt
@@ -1,21 +1,14 @@
-.. cfgcmd:: set interfaces {{ var0 }} <interface> address <address | dhcp |
-   dhcpv6>
+.. cfgcmd:: set interfaces {{ var0 }} <interface> address <address>
 
    Configure interface `<interface>` 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
-   * **dhcp** interface address is received by DHCP from a DHCP server
-     on this segment.
-   * **dhcpv6** interface address is received by DHCPv6 from a DHCPv6
-     server on this segment.
 
    Example:
 
    .. code-block:: none
 
      set interfaces {{ var0 }} {{ var1 }} address 192.0.2.1/24
-     set interfaces {{ var0 }} {{ var1 }} address 192.0.2.2/24
-     set interfaces {{ var0 }} {{ var1 }} address 2001:db8::ffff/64
-     set interfaces {{ var0 }} {{ var1 }} address 2001:db8:100::ffff/64
\ No newline at end of file
+     set interfaces {{ var0 }} {{ var1 }} address 2001:db8::1/64
\ No newline at end of file
diff --git a/docs/_include/interface-description.txt b/docs/_include/interface-description.txt
new file mode 100644
index 00000000..992d4945
--- /dev/null
+++ b/docs/_include/interface-description.txt
@@ -0,0 +1,10 @@
+.. cfgcmd:: set interfaces {{ var0 }} <interface> description <description>
+
+   Set a human readable, descriptive alias for this connection. Alias is used by
+   e.g. the :opcmd:`show interfaces` command or SNMP based monitoring tools.
+
+   Example:
+
+   .. code-block:: none
+
+     set interfaces {{ var0 }} {{ var1 }} description 'This is an awesome interface running on VyOS'
\ No newline at end of file
-- 
cgit v1.2.3