console-server: add possible values for configuration

This commit is contained in:
Christian Poessinger 2020-06-19 18:27:03 +02:00
parent 0c24d80f1a
commit a42365f507

View File

@ -1,7 +1,7 @@
.. _console_server:
##############
Console-Server
Console Server
##############
Starting of with VyOS 1.3 (equuleus) we added support for running VyOS as an
@ -107,12 +107,12 @@ 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
second. This is also the default setting if none of those options are defined.
.. cfgcmd:: set service console-server <device> data-bits
.. cfgcmd:: set service console-server <device> data-bits [7 | 8]
Configure either seven or eight data bits. This defaults to eight data
bits if left unconfigured.
.. cfgcmd:: set service console-server <device> description
.. cfgcmd:: set service console-server <device> description <string>
A user friendly description identifying the connected peripheral.
@ -120,12 +120,12 @@ second. This is also the default setting if none of those options are defined.
Set the parity option for the console. If unset this will default to none.
.. cfgcmd:: set service console-server <device> stop-bits
.. cfgcmd:: set service console-server <device> stop-bits [1 | 2]
Configure either one or two stop bits. This defaults to one stop bits if
left unconfigured.
.. cfgcmd:: set service console-server <device> speed <baudrate>
.. cfgcmd:: set service console-server <device> speed [ 300 | 1200 | 2400 | 4800 | 9600 | 19200 | 38400 | 57600 | 115200 ]
.. note:: USB to serial converters will handle most of their work in software
so you should be carefull with the selected baudrate as some times they