summaryrefslogtreecommitdiff
path: root/docs/_include/interface-description.txt
blob: 2de47fe3cd9d126eea3fae196f64c78d230dc1ef (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
  {{ var5 }} {{ var6 }} description <description>

  **Configure a clear, descriptive alias for the interface.** 

  This alias appears in the :opcmd:`show interfaces` command and SNMP-based 
  monitoring tools.

  Example:

  .. code-block:: none

    set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} description 'This is an interface running on VyOS.'