summaryrefslogtreecommitdiff
path: root/docs/_include/interface-description.txt
blob: 4347b837b264fa67a77ab47225f8c89d0c0697e6 (plain)
1
2
3
4
5
6
7
8
9
10
.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} 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 }} {{ var2 }} {{ var4 }} description 'This is an awesome interface running on VyOS'