diff options
| author | William Hughes <will@willhughes.name> | 2022-09-26 16:43:44 +1300 |
|---|---|---|
| committer | William Hughes <will@willhughes.name> | 2022-09-28 17:36:54 +1300 |
| commit | 78dbc71354cced5543ff01a190050c0f6f14334f (patch) | |
| tree | 60092e7443a49df48d0a92df4115556265a3f26a | |
| parent | dbac1be57b47403c4b14dbd0180ea928c080a0f6 (diff) | |
| download | vyos-documentation-78dbc71354cced5543ff01a190050c0f6f14334f.tar.gz vyos-documentation-78dbc71354cced5543ff01a190050c0f6f14334f.zip | |
conserver: T4717: Support for setting a name for console-server devices
| -rw-r--r-- | docs/configuration/service/console-server.rst | 8 |
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. |