From be6c3c1624174c5762a1349e31111d34db642767 Mon Sep 17 00:00:00 2001 From: Christian Poessinger Date: Tue, 10 Nov 2020 20:26:15 +0100 Subject: interfaces: add common description include file --- docs/_include/interface-description.txt | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 docs/_include/interface-description.txt (limited to 'docs/_include/interface-description.txt') 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 }} 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