Initial commit of Sphinx docs

Change-Id: I9fca8fb98502dffc2555f9de7f507b6f006e0e77
Signed-off-by: John DeNisco <jdenisco@cisco.com>

7 files changed, 733 insertions, 0 deletions

diff --git a/docs/reference/cmdreference/index.rst b/docs/reference/cmdreference/index.rst
new file mode 100644
index 00000000000..5c8effa3310
--- /dev/null
+++ b/docs/reference/cmdreference/index.rst
@@ -0,0 +1,55 @@
+.. _cmdreference:
+
+Command Line Reference
+======================
+
+This is a reference guide for the vpp debug commands that are referenced in the within these documents. This is **NOT** a complete list. For a complete list refer to the Debug CLI section of the 
+`Source Code Documents <https://docs.fd.io/vpp/18.07/clicmd.html>`_.
+
+The debug CLI can be executed from a su shell using the vppctl command.
+
+.. code-block:: console
+
+    # sudo bash
+    # vppctl show interface
+                  Name               Idx       State          Counter          Count     
+    TenGigabitEthernet86/0/0          1         up       rx packets               6569213
+                                                         rx bytes              9928352943
+                                                         tx packets                 50384
+                                                         tx bytes                 3329279
+    TenGigabitEthernet86/0/1          2        down      
+    VirtualEthernet0/0/0              3         up       rx packets                 50384
+                                                         rx bytes                 3329279
+                                                         tx packets               6569213
+                                                         tx bytes              9928352943
+                                                         drops                       1498
+    local0                            0        down      
+
+Commands can also be executed from the vppct shell.
+
+.. code-block:: console
+
+    # vppctl
+        _______    _        _   _____  ___ 
+     __/ __/ _ \  (_)__    | | / / _ \/ _ \
+     _/ _// // / / / _ \   | |/ / ___/ ___/
+     /_/ /____(_)_/\___/   |___/_/  /_/    
+    
+    vpp# show interface 
+                  Name               Idx       State          Counter          Count     
+    TenGigabitEthernet86/0/0          1         up       rx packets               6569213
+                                                         rx bytes              9928352943
+                                                         tx packets                 50384
+                                                         tx bytes                 3329279
+    TenGigabitEthernet86/0/1          2        down      
+    VirtualEthernet0/0/0              3         up       rx packets                 50384
+                                                         rx bytes                 3329279
+                                                         tx packets               6569213
+                                                         tx bytes              9928352943
+                                                         drops                       1498
+    local0                            0        down      
+
+.. toctree::
+
+   interface/index.rst
+   vhost/index.rst
diff --git a/docs/reference/cmdreference/interface/hardware.rst b/docs/reference/cmdreference/interface/hardware.rst
new file mode 100644
index 00000000000..f4d334fd935
--- /dev/null
+++ b/docs/reference/cmdreference/interface/hardware.rst
@@ -0,0 +1,109 @@
+.. _hardwarecommands:
+
+.. toctree::
+
+Show Hardware-Interfaces
+========================
+Display more detailed information about all or a list of given
+interfaces. The verboseness of the output can be controlled by the
+following optional parameters:
+
+-  brief: Only show name, index and state (default for bonded
+   interfaces).
+-  verbose: Also display additional attributes (default for all other
+   interfaces).
+-  detail: Also display all remaining attributes and extended
+   statistics.
+
+**To limit the output of the command to bonded interfaces and their
+slave interfaces, use the '*bond*' optional parameter.**
+
+Summary/Usage
+-------------
+
+.. code-block:: shell
+
+    show hardware-interfaces [brief|verbose|detail] [bond] [<interface> [<interface> [..]]] [<sw_idx> [<sw_idx> [..]]].
+
+Examples
+--------
+Example of how to display default data for all interfaces:
+
+.. code-block:: console
+
+    vpp# show hardware-interfaces
+                  Name                Idx   Link  Hardware
+    GigabitEthernet7/0/0               1     up   GigabitEthernet7/0/0
+      Ethernet address ec:f4:bb:c0:bc:fc
+      Intel e1000
+        carrier up full duplex speed 1000 mtu 9216
+        rx queues 1, rx desc 1024, tx queues 3, tx desc 1024
+        cpu socket 0
+    GigabitEthernet7/0/1               2     up   GigabitEthernet7/0/1
+      Ethernet address ec:f4:bb:c0:bc:fd
+      Intel e1000
+        carrier up full duplex speed 1000 mtu 9216
+        rx queues 1, rx desc 1024, tx queues 3, tx desc 1024
+        cpu socket 0
+    VirtualEthernet0/0/0               3     up   VirtualEthernet0/0/0
+      Ethernet address 02:fe:a5:a9:8b:8e
+    VirtualEthernet0/0/1               4     up   VirtualEthernet0/0/1
+      Ethernet address 02:fe:c0:4e:3b:b0
+    VirtualEthernet0/0/2               5     up   VirtualEthernet0/0/2
+      Ethernet address 02:fe:1f:73:92:81
+    VirtualEthernet0/0/3               6     up   VirtualEthernet0/0/3
+      Ethernet address 02:fe:f2:25:c4:68
+    local0                             0    down  local0
+      local
+
+Example of how to display '*verbose*' data for an interface by name and software index (where 2 is the software index):
+
+.. code-block:: console
+
+    vpp# show hardware-interfaces GigabitEthernet7/0/0 2 verbose
+                   Name                Idx   Link  Hardware
+    GigabitEthernet7/0/0               1     up   GigabitEthernet7/0/0
+      Ethernet address ec:f4:bb:c0:bc:fc
+      Intel e1000
+        carrier up full duplex speed 1000 mtu 9216
+        rx queues 1, rx desc 1024, tx queues 3, tx desc 1024
+        cpu socket 0
+    GigabitEthernet7/0/1               2    down  GigabitEthernet7/0/1
+      Ethernet address ec:f4:bb:c0:bc:fd
+      Intel e1000
+        carrier up full duplex speed 1000 mtu 9216
+        rx queues 1, rx desc 1024, tx queues 3, tx desc 1024
+        cpu socket 0
+
+Clear Hardware-Interfaces
+=========================
+
+Clear the extended statistics for all or a list of given interfaces
+(statistics associated with the '*show hardware-interfaces*' command).
+
+
+Summary/Usage
+-------------
+
+.. code-block:: shell
+
+    clear hardware-interfaces [<interface> [<interface> [..]]] [<sw_idx> [<sw_idx> [..]]].
+                
+
+Examples
+--------
+
+Example of how to clear the extended statistics for all interfaces:
+
+
+.. code-block:: console
+
+        vpp# clear hardware-interfaces
+
+Example of how to clear the extended statistics for an interface by name and software index (where 2 is the software index): 
+
+.. code-block:: console
+
+        vpp# clear hardware-interfaces GigabitEthernet7/0/0 2
+
+
diff --git a/docs/reference/cmdreference/interface/index.rst b/docs/reference/cmdreference/interface/index.rst
new file mode 100644
index 00000000000..db4aa44bba2
--- /dev/null
+++ b/docs/reference/cmdreference/interface/index.rst
@@ -0,0 +1,10 @@
+.. _interfacecommands:
+
+Interface Commands
+==================
+
+.. toctree::
+
+   hardware
+   interface
+   subinterface
diff --git a/docs/reference/cmdreference/interface/interface.rst b/docs/reference/cmdreference/interface/interface.rst
new file mode 100644
index 00000000000..a3429037e8b
--- /dev/null
+++ b/docs/reference/cmdreference/interface/interface.rst
@@ -0,0 +1,165 @@
+.. _intcommands:
+
+Interface Commands
+==================
+
+.. toctree::
+
+.. _showintcommand:
+
+Show Interface
+==============
+Shows software interface information including counters and features
+
+Summary/Usage
+-------------
+
+.. code-block:: shell
+
+    show interface [address|addr|features|feat] [<interface> [<interface> [..]]]
+
+Examples
+--------
+
+Example of how to show the interface counters:
+
+.. code-block:: console
+
+    vpp# show int
+                  Name               Idx       State          Counter          Count     
+    TenGigabitEthernet86/0/0          1         up       rx packets               6569213
+                                                         rx bytes              9928352943
+                                                         tx packets                 50384
+                                                         tx bytes                 3329279
+    TenGigabitEthernet86/0/1          2        down      
+    VirtualEthernet0/0/0              3         up       rx packets                 50384
+                                                         rx bytes                 3329279
+                                                         tx packets               6569213
+                                                         tx bytes              9928352943
+                                                         drops                       1498
+    local0                            0        down      
+
+Example of how to display the interface placement:
+
+.. code-block:: console
+
+    vpp# show interface rx-placement
+    Thread 1 (vpp_wk_0):
+      node dpdk-input:
+        GigabitEthernet7/0/0 queue 0 (polling)
+      node vhost-user-input:
+        VirtualEthernet0/0/12 queue 0 (polling)
+        VirtualEthernet0/0/12 queue 2 (polling)
+        VirtualEthernet0/0/13 queue 0 (polling)
+        VirtualEthernet0/0/13 queue 2 (polling)
+    Thread 2 (vpp_wk_1):
+      node dpdk-input:
+        GigabitEthernet7/0/1 queue 0 (polling)
+      node vhost-user-input:
+        VirtualEthernet0/0/12 queue 1 (polling)
+        VirtualEthernet0/0/12 queue 3 (polling)
+        VirtualEthernet0/0/13 queue 1 (polling)
+        VirtualEthernet0/0/13 queue 3 (polling)
+
+Clear Interfaces
+================
+Clear the statistics for all interfaces (statistics associated with the
+'*show interface*' command).
+
+Summary/Usage
+-------------
+
+.. code-block:: shell
+
+    clear interfaces
+
+Example
+-------
+Example of how to clear the statistics for all interfaces:
+
+.. code-block:: console
+
+    vpp# clear interfaces
+
+Set Interface Mac Address
+=========================
+The '*set interface mac address* ' command allows to set MAC address of
+given interface. In case of NIC interfaces the one has to support MAC
+address change. A side effect of MAC address change are changes of MAC
+addresses in FIB tables (ipv4 and ipv6).
+
+
+Summary/Usage
+-------------
+
+.. code-block:: shell
+
+    set interface mac address <interface> <mac-address>.
+
+Examples
+--------
+
+Examples of how to change MAC Address of interface:
+
+.. code-block:: console
+
+    vpp# set interface mac address GigabitEthernet0/8/0 aa:bb:cc:dd:ee:01
+    vpp# set interface mac address host-vpp0 aa:bb:cc:dd:ee:02
+    vpp# set interface mac address tap-0 aa:bb:cc:dd:ee:03
+    vpp# set interface mac address pg0 aa:bb:cc:dd:ee:04
+
+Set Interface Mtu
+=================
+
+.. toctree::
+
+Summary/Usage
+-------------
+
+.. code-block:: shell
+
+    set interface mtu [packet|ip4|ip6|mpls] <value> <interface>.
+
+Set Interface Promiscuous
+=========================
+
+Summary/Usage
+-------------
+
+.. code-block:: shell
+
+    set interface promiscuous [on|off] <interface>.
+
+.. _setintstate:
+
+Set Interface State
+===================
+This command is used to change the admin state (up/down) of an
+interface.
+
+If an interface is down, the optional '*punt*' flag can also be set. The
+'*punt*' flag implies the interface is disabled for forwarding but punt
+all traffic to slow-path. Use the '*enable*' flag to clear '*punt*' flag
+(interface is still down).
+
+Summary/Usage
+-------------
+
+.. code-block:: shell
+
+    set interface state <interface> [up|down|punt|enable].
+
+Examples
+--------
+
+Example of how to configure the admin state of an interface to **up**:
+
+.. code-block:: console
+
+    vpp# set interface state GigabitEthernet2/0/0 up
+
+Example of how to configure the admin state of an interface to **down**:
+
+.. code-block:: console
+
+    vpp# set interface state GigabitEthernet2/0/0 down
diff --git a/docs/reference/cmdreference/interface/subinterface.rst b/docs/reference/cmdreference/interface/subinterface.rst
new file mode 100644
index 00000000000..24519bc1a26
--- /dev/null
+++ b/docs/reference/cmdreference/interface/subinterface.rst
@@ -0,0 +1,117 @@
+.. _subinterfacecommands:
+
+.. toctree::
+
+Create Sub-Interfaces
+=====================
+This command is used to add VLAN IDs to interfaces, also known as
+subinterfaces. The primary input to this command is the '*interface*'
+and '*subId*' (subinterface Id) parameters. If no additional VLAN ID is
+provide, the VLAN ID is assumed to be the '*subId*'. The VLAN ID and
+'*subId*' can be different, but this is not recommended.
+
+This command has several variations:
+
+-  **create sub-interfaces <interface> <subId>** - Create a subinterface
+   to process packets with a given 802.1q VLAN ID (same value as the
+   '*subId*').
+-  **create sub-interfaces <interface> <subId> default** - Adding the
+   '*default*' parameter indicates that packets with VLAN IDs that do
+   not match any other subinterfaces should be sent to this
+   subinterface.
+-  **create sub-interfaces <interface> <subId> untagged** - Adding the
+   '*untagged*' parameter indicates that packets no VLAN IDs should be
+   sent to this subinterface.
+-  **create sub-interfaces <interface> <subId>-<subId>** - Create a
+   range of subinterfaces to handle a range of VLAN IDs.
+-  **create sub-interfaces <interface> <subId> dot1q|dot1ad <vlanId>|any
+   [exact-match]** - Use this command to specify the outer VLAN ID, to
+   either be explicited or to make the VLAN ID different from the
+   '*subId*'.
+-  **create sub-interfaces <interface> <subId> dot1q|dot1ad <vlanId>|any
+   inner-dot1q <vlanId>|any [exact-match]** - Use this command to
+   specify the outer VLAN ID and the innner VLAN ID.
+
+When '*dot1q*' or '*dot1ad*' is explictly entered, subinterfaces can be
+configured as either exact-match or non-exact match. Non-exact match is
+the CLI default. If '*exact-match*' is specified, packets must have the
+same number of VLAN tags as the configuration. For non-exact-match,
+packets must at least that number of tags. L3 (routed) interfaces must
+be configured as exact-match. L2 interfaces are typically configured as
+non-exact-match. If '*dot1q*' or '*dot1ad*' is NOT entered, then the
+default behavior is exact-match.
+
+Use the '*show interface*' command to display all subinterfaces.
+
+Summary/Usage
+-------------
+
+.. code-block:: shell
+
+    create sub-interfaces <interface> {<subId> [default|untagged]} | {<subId>-<subId>} | {<subId> dot1q|dot1ad <vlanId>|any [inner-dot1q <vlanId>|any] [exact-match]}.
+
+Examples
+--------
+
+Example of how to create a VLAN subinterface 11 to process packets on 802.1q VLAN ID 11:
+
+.. code-block:: console
+
+    vpp# create sub-interfaces GigabitEthernet2/0/0 11
+
+The previous example is shorthand and is equivalent to:
+
+.. code-block:: console
+
+    vpp# create sub-interfaces GigabitEthernet2/0/0 11 dot1q 11 exact-match
+
+Example of how to create a subinterface number that is different from the VLAN ID:
+
+.. code-block:: console
+
+    vpp# create sub-interfaces GigabitEthernet2/0/0 11 dot1q 100
+
+Examples of how to create q-in-q and q-in-any subinterfaces:
+
+.. code-block:: console
+
+    vpp# create sub-interfaces GigabitEthernet2/0/0 11 dot1q 100 inner-dot1q 200
+    vpp# create sub-interfaces GigabitEthernet2/0/0 12 dot1q 100 inner-dot1q any
+
+Examples of how to create dot1ad interfaces:
+
+.. code-block:: console
+
+    vpp# create sub-interfaces GigabitEthernet2/0/0 11 dot1ad 11
+    vpp# create sub-interfaces GigabitEthernet2/0/0 12 dot1ad 100 inner-dot1q 200
+
+Examples of '*exact-match*' versus non-exact match. A packet with outer VLAN 100 and inner VLAN 200 would match this interface, because the default is non-exact match:
+
+.. code-block:: console
+
+    vpp# create sub-interfaces GigabitEthernet2/0/0 5 dot1q 100
+
+However, the same packet would NOT match this interface because '*exact-match*' is specified and only one VLAN is configured, but packet contains two VLANs:
+
+.. code-block:: console
+
+    vpp# create sub-interfaces GigabitEthernet2/0/0 5 dot1q 100 exact-match
+
+Example of how to created a subinterface to process untagged packets:
+
+.. code-block:: console
+
+   vpp# create sub-interfaces GigabitEthernet2/0/0 5 untagged
+
+Example of how to created a subinterface to process any packet with a VLAN ID that does not match any other subinterface:
+
+.. code-block:: console
+
+    vpp# create sub-interfaces GigabitEthernet2/0/0 7 default
+
+When subinterfaces are created, they are in the down state. Example of how to enable a newly created subinterface:
+
+.. code-block:: console
+
+    vpp# set interface GigabitEthernet2/0/0.7 up
+        
diff --git a/docs/reference/cmdreference/vhost/index.rst b/docs/reference/cmdreference/vhost/index.rst
new file mode 100644
index 00000000000..3e41718af26
--- /dev/null
+++ b/docs/reference/cmdreference/vhost/index.rst
@@ -0,0 +1,8 @@
+.. _vhostcommands:
+
+Vhost User Commands
+===================
+
+.. toctree::
+
+    vhostuser
diff --git a/docs/reference/cmdreference/vhost/vhostuser.rst b/docs/reference/cmdreference/vhost/vhostuser.rst
new file mode 100644
index 00000000000..a21c314404c
--- /dev/null
+++ b/docs/reference/cmdreference/vhost/vhostuser.rst
@@ -0,0 +1,269 @@
+.. _vhostusercommands:
+
+.. toctree::
+
+.. _createvhostuser:
+
+Create Vhost-User
+=================
+
+Create a vHost User interface. Once created, a new virtual interface
+will exist with the name '*VirtualEthernet0/0/x*', where '*x*' is the
+next free index.
+
+There are several parameters associated with a vHost interface:
+
+-  **socket <socket-filename>** - Name of the linux socket used by
+   hypervisor and VPP to manage the vHost interface. If in '*server*'
+   mode, VPP will create the socket if it does not already exist. If in
+   '*client*' mode, hypervisor will create the socket if it does not
+   already exist. The VPP code is indifferent to the file location.
+   However, if SELinux is enabled, then the socket needs to be created
+   in '*/var/run/vpp/*'.
+-  **server** - Optional flag to indicate that VPP should be the server
+   for the linux socket. If not provided, VPP will be the client. In
+   '*server*' mode, the VM can be reset without tearing down the vHost
+   Interface. In '*client*' mode, VPP can be reset without bringing down
+   the VM and tearing down the vHost Interface.
+-  **feature-mask <hex>** - Optional virtio/vhost feature set negotiated
+   at startup. **This is intended for degugging only.** It is
+   recommended that this parameter not be used except by experienced
+   users. By default, all supported features will be advertised.
+   Otherwise, provide the set of features desired.
+
+   -  0x000008000 (15) - VIRTIO_NET_F_MRG_RXBUF
+   -  0x000020000 (17) - VIRTIO_NET_F_CTRL_VQ
+   -  0x000200000 (21) - VIRTIO_NET_F_GUEST_ANNOUNCE
+   -  0x000400000 (22) - VIRTIO_NET_F_MQ
+   -  0x004000000 (26) - VHOST_F_LOG_ALL
+   -  0x008000000 (27) - VIRTIO_F_ANY_LAYOUT
+   -  0x010000000 (28) - VIRTIO_F_INDIRECT_DESC
+   -  0x040000000 (30) - VHOST_USER_F_PROTOCOL_FEATURES
+   -  0x100000000 (32) - VIRTIO_F_VERSION_1
+
+-  **hwaddr <mac-addr>** - Optional ethernet address, can be in either
+   X:X:X:X:X:X unix or X.X.X cisco format.
+-  **renumber <dev_instance>** - Optional parameter which allows the
+   instance in the name to be specified. If instance already exists,
+   name will be used anyway and multiple instances will have the same
+   name. Use with caution.
+
+
+Summary/Usage
+-------------
+
+.. code-block:: shell
+
+    create vhost-user socket <socket-filename> [server] [feature-mask <hex>] [hwaddr <mac-addr>] [renumber <dev_instance>]
+
+
+Examples
+--------
+
+    Example of how to create a vhost interface with VPP as the client
+    and all features enabled:
+
+.. code-block:: console
+
+    vpp# create vhost-user socket /var/run/vpp/vhost1.sock
+    VirtualEthernet0/0/0
+
+Example of how to create a vhost interface with VPP as the server
+and with just multiple queues enabled:
+
+.. code-block:: console
+
+    vpp# create vhost-user socket /var/run/vpp/vhost2.sock server feature-mask 0x40400000
+    VirtualEthernet0/0/1
+
+Once the vHost interface is created, enable the interface using:
+
+.. code-block:: console
+
+    vpp# set interface state VirtualEthernet0/0/0 up
+
+.. _showvhost:
+
+Show Vhost-User
+===============
+
+Display the attributes of a single vHost User interface (provide
+interface name), multiple vHost User interfaces (provide a list of
+interface names seperated by spaces) or all Vhost User interfaces (omit
+an interface name to display all vHost interfaces).
+
+Summary/Usage
+-------------
+
+.. code-block:: shell
+
+    show vhost-user [<interface> [<interface> [..]]] [descriptors].
+
+Examples
+--------
+Example of how to display a vhost interface:
+
+.. code-block:: console
+
+    vpp# show vhost-user VirtualEthernet0/0/0
+    Virtio vhost-user interfaces
+    Global:
+      coalesce frames 32 time 1e-3
+    Interface: VirtualEthernet0/0/0 (ifindex 1)
+    virtio_net_hdr_sz 12
+     features mask (0xffffffffffffffff):
+     features (0x50408000):
+       VIRTIO_NET_F_MRG_RXBUF (15)
+       VIRTIO_NET_F_MQ (22)
+       VIRTIO_F_INDIRECT_DESC (28)
+       VHOST_USER_F_PROTOCOL_FEATURES (30)
+      protocol features (0x3)
+       VHOST_USER_PROTOCOL_F_MQ (0)
+       VHOST_USER_PROTOCOL_F_LOG_SHMFD (1)
+
+     socket filename /var/run/vpp/vhost1.sock type client errno "Success"
+
+    rx placement:
+       thread 1 on vring 1
+       thread 1 on vring 5
+       thread 2 on vring 3
+       thread 2 on vring 7
+     tx placement: spin-lock
+       thread 0 on vring 0
+       thread 1 on vring 2
+       thread 2 on vring 0
+
+    Memory regions (total 2)
+    region fd    guest_phys_addr    memory_size        userspace_addr     mmap_offset        mmap_addr
+    ====== ===== ================== ================== ================== ================== ==================
+      0     60    0x0000000000000000 0x00000000000a0000 0x00002aaaaac00000 0x0000000000000000 0x00002aab2b400000
+      1     61    0x00000000000c0000 0x000000003ff40000 0x00002aaaaacc0000 0x00000000000c0000 0x00002aababcc0000
+
+     Virtqueue 0 (TX)
+      qsz 256 last_avail_idx 0 last_used_idx 0
+      avail.flags 1 avail.idx 128 used.flags 1 used.idx 0
+      kickfd 62 callfd 64 errfd -1
+
+     Virtqueue 1 (RX)
+      qsz 256 last_avail_idx 0 last_used_idx 0
+      avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
+      kickfd 65 callfd 66 errfd -1
+
+     Virtqueue 2 (TX)
+      qsz 256 last_avail_idx 0 last_used_idx 0
+      avail.flags 1 avail.idx 128 used.flags 1 used.idx 0
+      kickfd 63 callfd 70 errfd -1
+
+     Virtqueue 3 (RX)
+      qsz 256 last_avail_idx 0 last_used_idx 0
+      avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
+      kickfd 72 callfd 74 errfd -1
+
+     Virtqueue 4 (TX disabled)
+      qsz 256 last_avail_idx 0 last_used_idx 0
+      avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
+      kickfd 76 callfd 78 errfd -1
+
+     Virtqueue 5 (RX disabled)
+      qsz 256 last_avail_idx 0 last_used_idx 0
+      avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
+      kickfd 80 callfd 82 errfd -1
+
+     Virtqueue 6 (TX disabled)
+      qsz 256 last_avail_idx 0 last_used_idx 0
+     avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
+      kickfd 84 callfd 86 errfd -1
+
+     Virtqueue 7 (RX disabled)
+      qsz 256 last_avail_idx 0 last_used_idx 0
+      avail.flags 1 avail.idx 0 used.flags 1 used.idx 0
+      kickfd 88 callfd 90 errfd -1
+
+The optional '*descriptors*' parameter will display the same output as the
+previous example but will include the descriptor table for each queue. The output is truncated below:
+
+.. code-block:: console
+
+    vpp# show vhost-user VirtualEthernet0/0/0 descriptors
+
+    Virtio vhost-user interfaces
+    Global:
+      coalesce frames 32 time 1e-3
+    Interface: VirtualEthernet0/0/0 (ifindex 1)
+    virtio_net_hdr_sz 12
+     features mask (0xffffffffffffffff):
+     features (0x50408000):
+       VIRTIO_NET_F_MRG_RXBUF (15)
+       VIRTIO_NET_F_MQ (22)
+    :
+     Virtqueue 0 (TX)
+      qsz 256 last_avail_idx 0 last_used_idx 0
+      avail.flags 1 avail.idx 128 used.flags 1 used.idx 0
+      kickfd 62 callfd 64 errfd -1
+
+      descriptor table:
+       id          addr         len  flags  next      user_addr
+      ===== ================== ===== ====== ===== ==================
+      0     0x0000000010b6e974 2060  0x0002 1     0x00002aabbc76e974
+      1     0x0000000010b6e034 2060  0x0002 2     0x00002aabbc76e034
+      2     0x0000000010b6d6f4 2060  0x0002 3     0x00002aabbc76d6f4
+      3     0x0000000010b6cdb4 2060  0x0002 4     0x00002aabbc76cdb4
+      4     0x0000000010b6c474 2060  0x0002 5     0x00002aabbc76c474
+      5     0x0000000010b6bb34 2060  0x0002 6     0x00002aabbc76bb34
+      6     0x0000000010b6b1f4 2060  0x0002 7     0x00002aabbc76b1f4
+      7     0x0000000010b6a8b4 2060  0x0002 8     0x00002aabbc76a8b4
+      8     0x0000000010b69f74 2060  0x0002 9     0x00002aabbc769f74
+      9     0x0000000010b69634 2060  0x0002 10    0x00002aabbc769634
+      10    0x0000000010b68cf4 2060  0x0002 11    0x00002aabbc768cf4
+    :
+      249   0x0000000000000000 0     0x0000 250   0x00002aab2b400000
+      250   0x0000000000000000 0     0x0000 251   0x00002aab2b400000
+      251   0x0000000000000000 0     0x0000 252   0x00002aab2b400000
+      252   0x0000000000000000 0     0x0000 253   0x00002aab2b400000
+      253   0x0000000000000000 0     0x0000 254   0x00002aab2b400000
+      254   0x0000000000000000 0     0x0000 255   0x00002aab2b400000
+      255   0x0000000000000000 0     0x0000 32768 0x00002aab2b400000
+
+     Virtqueue 1 (RX)
+      qsz 256 last_avail_idx 0 last_used_idx 0
+
+ 
+Debug Vhost-User
+================
+Turn on/off debug for vhost
+
+
+Summary/Usage
+-------------
+
+.. code-block:: shell
+
+    debug vhost-user <on | off>.
+ 
+Delete Vhost-User
+========================
+Delete a vHost User interface using the interface name or the software
+interface index. Use the '*show interface*' command to determine the
+software interface index. On deletion, the linux socket will not be
+deleted.
+
+Summary/Usage
+-------------
+
+.. code-block:: shell
+
+    delete vhost-user {<interface> | sw_if_index <sw_idx>}.
+
+Examples
+--------
+Example of how to delete a vhost interface by name:
+
+.. code-block:: console
+
+    vpp# delete vhost-user VirtualEthernet0/0/1
+
+Example of how to delete a vhost interface by software interface index:
+
+.. code-block:: console
+
+    vpp# delete vhost-user sw_if_index 1