diff options
| author | Christian Poessinger <christian@poessinger.com> | 2020-11-10 20:26:15 +0100 |
|---|---|---|
| committer | Christian Poessinger <christian@poessinger.com> | 2020-11-10 20:26:15 +0100 |
| commit | be6c3c1624174c5762a1349e31111d34db642767 (patch) | |
| tree | 8bc6d89b6e4a6a971cab13b87b8acbc113340e25 /docs/_include/interface-description.txt | |
| parent | 0d8451f1dd3ba31e9c39ebafd2dc32f25d5f582d (diff) | |
| download | vyos-documentation-be6c3c1624174c5762a1349e31111d34db642767.tar.gz vyos-documentation-be6c3c1624174c5762a1349e31111d34db642767.zip | |
interfaces: add common description include file
Diffstat (limited to 'docs/_include/interface-description.txt')
| -rw-r--r-- | docs/_include/interface-description.txt | 10 |
1 files changed, 10 insertions, 0 deletions
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 }} <interface> 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 }} description 'This is an awesome interface running on VyOS'
\ No newline at end of file |