summaryrefslogtreecommitdiff
path: root/docs/configuration/service/console-server.rst
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2022-09-28 06:43:22 +0200
committerGitHub <noreply@github.com>2022-09-28 06:43:22 +0200
commit380ad169a9f8bb4c4860d9e635bef6923c9ffc71 (patch)
tree60092e7443a49df48d0a92df4115556265a3f26a /docs/configuration/service/console-server.rst
parentdbac1be57b47403c4b14dbd0180ea928c080a0f6 (diff)
parent78dbc71354cced5543ff01a190050c0f6f14334f (diff)
downloadvyos-documentation-380ad169a9f8bb4c4860d9e635bef6923c9ffc71.tar.gz
vyos-documentation-380ad169a9f8bb4c4860d9e635bef6923c9ffc71.zip
Merge pull request #862 from insertjokehere/console-server-names
conserver: T4717: Support for setting a name for console-server devices
Diffstat (limited to 'docs/configuration/service/console-server.rst')
-rw-r--r--docs/configuration/service/console-server.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/configuration/service/console-server.rst b/docs/configuration/service/console-server.rst
index dd2f5032..435c972c 100644
--- a/docs/configuration/service/console-server.rst
+++ b/docs/configuration/service/console-server.rst
@@ -35,6 +35,11 @@ second. This is also the default setting if none of those options are defined.
A user friendly description identifying the connected peripheral.
+.. cfgcmd:: set service console-server <device> alias <string>
+
+ A user friendly alias for this connection. Can be used instead of the
+ device name when connecting.
+
.. cfgcmd:: set service console-server <device> parity [even | odd | none]
Set the parity option for the console. If unset this will default to none.
@@ -106,3 +111,6 @@ Operation
.. hint:: The sequence ``^Ec?`` translates to: ``Ctrl+E c ?``. To quit
the session use: ``Ctrl+E c .``
+
+ .. hint:: If ``alias`` is set, it can be used instead of the device when
+ connecting.