vyos/vyos-documentation
1
0
Fork 0
mirror of https://github.com/vyos/vyos-documentation.git synced 2025-10-26 08:41:46 +01:00
Code Issues Packages Projects Releases Wiki Activity

console-server: sync branches

Browse Source
This commit is contained in:
rebortg 2023-01-27 13:48:34 +01:00
parent 65ccd6f2e6
commit 4f88fbdbce
1 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/configuration/service/console-server.rst
View File

@ -26,30 +26,30 @@ times are used to send a single character, and so dividing the signalling
bit-rate by ten results in the overall transmission speed in characters per bit-rate by ten results in the overall transmission speed in characters per
second. This is also the default setting if none of those options are defined. second. This is also the default setting if none of those options are defined.
.. cfgcmd:: set service console-server <device> data-bits [7 | 8] .. cfgcmd:: set service console-server device <device> data-bits [7 | 8]
Configure either seven or eight data bits. This defaults to eight data Configure either seven or eight data bits. This defaults to eight data
bits if left unconfigured. bits if left unconfigured.
.. cfgcmd:: set service console-server <device> description <string> .. cfgcmd:: set service console-server device <device> description <string>
A user friendly description identifying the connected peripheral. A user friendly description identifying the connected peripheral.
.. cfgcmd:: set service console-server <device> alias <string> .. cfgcmd:: set service console-server device <device> alias <string>
A user friendly alias for this connection. Can be used instead of the A user friendly alias for this connection. Can be used instead of the
device name when connecting. device name when connecting.
.. cfgcmd:: set service console-server <device> parity [even | odd | none] .. cfgcmd:: set service console-server device <device> parity [even | odd | none]
Set the parity option for the console. If unset this will default to none. Set the parity option for the console. If unset this will default to none.
.. cfgcmd:: set service console-server <device> stop-bits [1 | 2] .. cfgcmd:: set service console-server device <device> stop-bits [1 | 2]
Configure either one or two stop bits. This defaults to one stop bits if Configure either one or two stop bits. This defaults to one stop bits if
left unconfigured. left unconfigured.
.. cfgcmd:: set service console-server <device> speed .. cfgcmd:: set service console-server device <device> speed
[ 300 | 1200 | 2400 | 4800 | 9600 | 19200 | 38400 | 57600 | 115200 ] [ 300 | 1200 | 2400 | 4800 | 9600 | 19200 | 38400 | 57600 | 115200 ]
.. note:: USB to serial converters will handle most of their work in software .. note:: USB to serial converters will handle most of their work in software
@ -63,7 +63,7 @@ Each individual configured console-server device can be directly exposed to
the outside world. A user can directly connect via SSH to the configured the outside world. A user can directly connect via SSH to the configured
port. port.
.. cfgcmd:: set service console-server <device> ssh port <port> .. cfgcmd:: set service console-server device <device> ssh port <port>
Accept SSH connections for the given `<device>` on TCP port `<port>`. Accept SSH connections for the given `<device>` on TCP port `<port>`.
After successfull authentication the user will be directly dropped to After successfull authentication the user will be directly dropped to
@ -114,3 +114,7 @@ Operation
.. hint:: If ``alias`` is set, it can be used instead of the device when .. hint:: If ``alias`` is set, it can be used instead of the device when
connecting. connecting.
.. opcmd:: show log console-server
Show the console server log.