dummy: extend interface documentation

1 files changed, 75 insertions, 13 deletions

diff --git a/docs/interfaces/dummy.rst b/docs/interfaces/dummy.rst
index 9dbb9668..77bd3cc2 100644
--- a/docs/interfaces/dummy.rst
+++ b/docs/interfaces/dummy.rst
@@ -1,25 +1,87 @@
 .. _dummy-interface:
 
+#####
 Dummy
------
+#####
 
+The dummy interface is really a little exotic, but rather useful nevertheless.
 Dummy interfaces are much like the loopback interface, except you can have
 as many as you want. Dummy interfaces can be used as interfaces that always
 stay up (in the same fashion to loopbacks in Cisco IOS), or for testing
 purposes.
 
-Configuration commands:
+Configuration
+#############
 
-.. code-block:: none
+Address
+-------
+
+.. cfgcmd:: set interfaces dummy '<interface>' address <address | dhcp | dhcpv6>
+
+   Configure dummy 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 dummy dum10 address 192.0.2.1/24
+     set interfaces dummy dum10 address 192.0.2.2/24
+     set interfaces dummy dum10 address 2001:db8::ffff/64
+     set interfaces dummy dum10 address 2001:db8:100::ffff/64
+
+Link Administration
+-------------------
+
+.. cfgcmd:: set interfaces dummy '<interface>' description '<description>'
+
+   Assign given `<description>` to interface. Description will also be passed
+   to SNMP monitoring systems.
+
+.. cfgcmd:: set interfaces dummy '<interface>' disable
+
+   Disable given `<interface>`. It will be placed in administratively down
+   state.
+
+Operation
+=========
+
+.. opcmd:: show interfaces dummy
+
+   Show brief interface information.information
+
+   .. code-block:: none
+
+     vyos@vyos:~$ show interfaces dummy
+     Codes: S - State, L - Link, u - Up, D - Down, A - Admin Down
+     Interface        IP Address                        S/L  Description
+     ---------        ----------                        ---  -----------
+     dum0             172.18.254.201/32                 u/u
+
+.. opcmd:: show interfaces dummy '<interface>'
+
+   Show detailed information on given `<interface>`
+
+   .. code-block::
+
+     vyos@vyos:~$ show interfaces ethernet eth0
+     dum0: <BROADCAST,NOARP,UP,LOWER_UP> mtu 1500 qdisc noqueue state UNKNOWN group default qlen 1000
+         link/ether 26:7c:8e:bc:fc:f5 brd ff:ff:ff:ff:ff:ff
+         inet 172.18.254.201/32 scope global dum0
+            valid_lft forever preferred_lft forever
+         inet6 fe80::247c:8eff:febc:fcf5/64 scope link
+            valid_lft forever preferred_lft forever
+
+         RX:  bytes    packets     errors    dropped    overrun      mcast
+                  0          0          0          0          0          0
+         TX:  bytes    packets     errors    dropped    carrier collisions
+            1369707       4267          0          0          0          0
 
-  vyos@vyos# set interfaces dummy dum0
-  Possible completions:
-  +  address      IP address
-     description  Interface description
-     disable      Disable interface
-   > ip           IPv4 routing parameters
-   > ipv6         IPv6 routing parameters
-     redirect     Incoming packet redirection destination
-   > traffic-policy
-                  Traffic-policy for interface