1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
|
---
myst:
html_meta:
description: |
A serial console provides text-based access to the router's command
line over a serial device, useful for diagnostics, upgrades, and other
situations where SSH access is unavailable.
keywords: serial console, text-based interface, serial device, baud rate
---
(serial-console)=
# Serial console
A serial console is a text-based interface that provides access to the
router's command line via a serial device.
For routine local access, a serial console offers no advantage over a
directly attached keyboard and screen.
There are some scenarios where serial consoles are useful. Remote
systems are usually administered over {ref}`ssh`, but sometimes console
access is the only way to diagnose and correct software failures. Certain
system upgrades may also require console access.
## Configuration
```{cfgcmd} set system console device \<device\>
**Enable a serial console on the specified device.**
`<device>` is the device name, in one of the following formats:
- `ttySN`: Standard serial device.
- `ttyAMAN`: ARM serial device.
- `usbNbXpY`: {abbr}`USB (Universal Serial Bus)`-to-serial converter,
addressed by its bus path.
- `hvcN`: Xen console.
`N` is a number in all formats. In `usbNbXpY`, `X` and `Y` are the bus
and port parts of the converter's USB path and can contain dot-separated
numbers.
A USB serial converter must be connected upon commit. Otherwise, the
commit fails.
```
Example:
```none
set system console device ttyS0
```
```{cfgcmd} set system console device \<device\> kernel
**Output kernel messages to the specified device.**
By default, the router sends them to `tty0`.
The specified device must be a `ttyS` or `ttyAMA` device, and only one
device can receive kernel messages. Otherwise, the commit fails.
```
```{note}
If you install the router from a serial console, the installer sets this
option automatically on the device used during installation, usually
`ttyS0` or `ttyAMA0`.
```
Example:
```none
set system console device ttyS0 kernel
```
```{cfgcmd} set system console device \<device\> speed \<1200 | 2400 | 4800 | 9600 | 19200 | 38400 | 57600 | 115200\>
**Configure the console baud rate.**
The default is `115200`, except for `hvcN` (Xen) consoles, which default
to `38400`.
```
```{note}
Many USB-to-serial converters lack hardware flow control. Without it, a
converter may silently drop data at high baud rates. If you cannot
connect at a high rate, set the speed to `9600`.
```
Example:
```none
set system console device ttyS0 speed 115200
```
```{cfgcmd} set system console powersave
**Enable screen-blank power saving on the local VGA console.**
When enabled, the local console blanks the screen after 15 minutes of
inactivity and powers down the monitor after 60 minutes. This does not
affect serial consoles or SSH sessions.
```
Example:
```none
set system console powersave
```
|
