Skip to content

Commit 8238417

Browse files
[DOCS] Deploy EMT via Serial over LAN for next (#840)
Signed-off-by: Sebastian Golebiewski <sebastianx.golebiewski@intel.com>
1 parent 2eb3b31 commit 8238417

File tree

7 files changed

+190
-5
lines changed

7 files changed

+190
-5
lines changed
96.1 KB
Loading
41 KB
Loading
195 KB
Loading
179 KB
Loading
47.9 KB
Loading
Lines changed: 183 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,183 @@
1+
# Deploy Edge Microvisor Toolkit via Serial over LAN (SOL)
2+
3+
In this article, you will learn how to deploy Edge Microvisor Toolkit using the
4+
Serial over LAN (SOL) method.
5+
6+
Traditional methods such as KVM consoles, physical serial connections, or SSH
7+
have been commonly used to access and manage servers. However, they have certain
8+
limitations, especially during system boot or failure conditions. SSH depends
9+
on the operating system and network services being fully operational, while KVM
10+
requires graphical access, and physical serial connections often require direct
11+
cabling to server.
12+
13+
Serial Over LAN (SOL) addresses these limitations by redirecting the server’s
14+
serial console input and output over a network connection through the management
15+
controller, allowing administrators to remotely access the server’s text-based
16+
console, including BIOS and boot messages, even when the operating system is not
17+
running.
18+
19+
This enables remote troubleshooting and management without requiring physical
20+
access or additional serial cabling.
21+
22+
Testing Serial over LAN (SOL) in a BMC (Baseboard Management Controller)
23+
environment usually involves verifying that the host serial console is redirected
24+
through the BMC network interface and accessible remotely via IPMI
25+
26+
Below you will find the necessary configuration for SOL to work.
27+
28+
## Prerequisites
29+
30+
- The BMC IP address configured.
31+
- A Management LAN cable connected to the BMC port.
32+
- ipmitool installed on the client system.
33+
- The host serial console redirection enabled.
34+
35+
## Configure BIOS Settings on Server
36+
37+
Configure BIOS for serial redirection. Navigate to
38+
**System setup -> System BIOS -> Serial Communication**
39+
40+
![BIOS Settings](../../assets/sol-bios-settings.png)
41+
42+
## Configure SOL Settings on Xeon BMC
43+
44+
Open WebUI of BMC through BMCIP. Navigate to
45+
**iDRAC Settings -> Connectivity -> Serial Over LAN**.
46+
47+
![Xeon BMC Settings](../../assets/sol-xeon-bmc.png)
48+
49+
## Remote Client (ipmi) settings in XEON BMC
50+
51+
Configure the IPMI settings. Navigate to
52+
**iDRAC Settings -> Connectivity -> Network -> IPMI Settings**.
53+
54+
![Xeon BMC Settings](../../assets/sol-ipmi-xeon-bmc.png)
55+
56+
## Set up the remote client
57+
58+
> **Note:** You should run all IPMI commands on the client machine.
59+
60+
To set up the remote client machine, you need to install ipmi:
61+
62+
```bash
63+
sudo apt install ipmi
64+
```
65+
66+
## Manage SOL (Serial Over LAN) session
67+
68+
1. Start a SOL session.
69+
70+
```bash
71+
ipmitool -I lanplus -H <BMC-IP> -U admin -P password sol activate
72+
```
73+
74+
2. Stop the SOL session.
75+
76+
To stop the active SOL session, run the following command:
77+
78+
```bash
79+
~.
80+
```
81+
82+
You can also stop it from another shell on the client machine by running:
83+
84+
```bash
85+
ipmitool -I lanplus -H <BMC-IP> -U admin -P password sol deactivate
86+
```
87+
88+
3. Check the SOL configuration.
89+
90+
```bash
91+
ipmitool -I lanplus -H <BMC-IP> -U admin -P password sol info
92+
```
93+
94+
To learn more about ipmitool commands, refer to the guides at
95+
[linux.die.net](https://linux.die.net/man/1/ipmitool) or
96+
[ibm.com](https://www.ibm.com/docs/en/power9/0000-REF?topic=POWER9_REF/p9eih/p9eih_ipmi_commands.html).
97+
98+
## Verify SOL configuration
99+
100+
> **Note:**
101+
> The settings have been configured and tested on the DELL R760 server.
102+
> They have been executed from a remote client and verified with the
103+
> latest EMT 3.0 ISO image.
104+
105+
1. To verify the configuration, run the following command:
106+
107+
```bash
108+
ipmitool -I lanplus -H <BMC-IP> -U admin -P password sol info
109+
```
110+
111+
![Verify SOL Settings](../../assets/sol-verify-configuration.png)
112+
113+
2. For system status information, run:
114+
115+
```bash
116+
ipmitool -I lanplus -H 10.47.99.78 -U root -P Password chassis status
117+
```
118+
119+
![System Status Information](../../assets/sol-system-status.png)
120+
121+
3. Activate the SOL session on the client and reboot the server.
122+
123+
```bash
124+
vm@edgebuildvm2:~$ ipmitool -I lanplus -H 10.47.99.78 -U root -P Password sol activate
125+
```
126+
127+
Output:
128+
129+
```text
130+
[SOL Session operational. Use ~? for help]
131+
KEY MAPPING FOR CONSOLE REDIRECTION:
132+
133+
Use the <ESC><1> key sequence for <F1>
134+
Use the <ESC><2> key sequence for <F2>
135+
Use the <ESC><3> key sequence for <F3>
136+
Use the <ESC><0> key sequence for <F10>
137+
Use the <ESC><!> key sequence for <F11>
138+
Use the <ESC><@> key sequence for <F12>
139+
140+
Use the <ESC><Ctrl><M> key sequence for <Ctrl><M>
141+
Use the <ESC><Ctrl><H> key sequence for <Ctrl><H>
142+
Use the <ESC><Ctrl><I> key sequence for <Ctrl><I>
143+
Use the <ESC><Ctrl><J> key sequence for <Ctrl><J>
144+
145+
Use the <ESC><X><X> key sequence for <Alt><x>, where x is any letter
146+
key, and X is the upper case of that key
147+
148+
Use the <ESC><R><ESC><r><ESC><R> key sequence for <Ctrl><Alt><Del>
149+
150+
Press the spacebar to pause...
151+
Initializing PCIe, USB, and Video... Done
152+
PowerEdge R760
153+
BIOS Version: 2.2.7
154+
Console Redirection Enabled Requested by iDRAC
155+
156+
F2 = System Setup
157+
F10 = Lifecycle Controller (Config
158+
iDRAC, Update FW, Install OS)
159+
F11 = Boot Manager
160+
F12 = PXE Boot
161+
iDRAC IPV4: 10.47.99.78 [Dedicated]
162+
Initializing Firmware Interfaces...
163+
164+
Enumerating Boot options...
165+
Enumerating Boot options... Done
166+
Loading Lifecycle Controller Drivers...
167+
Loading Lifecycle Controller Drivers...Done
168+
Lifecycle Controller: Collecting System Inventory...
169+
170+
iDRAC IPV4: 10.47.99.78 [Dedicated]
171+
Lifecycle Controller: Done
172+
Booting...
173+
Booting from PCIe SSD in Slot 23 in Bay 1: Edge Microvisor Toolkit
174+
Welcome to GRUB!
175+
Booting `EdgeMicrovisorToolkit GNU/Linux, with Linux 6.12.67-1.emt3'
176+
Loading Linux 6.12.67-1.emt3 ...
177+
Loading initial ramdisk ...
178+
```
179+
180+
4. Exit the SOL session.
181+
182+
Use `~.` in the current session, or `ipmitool sol deactivate`
183+
from another active session.
Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
11
# Install Edge Microvisor Toolkit
22

3-
Edge Microvisor Toolkit can be installed on bare metal, or as a virtual machine. This section
4-
describes in detail how to quickly install and try out Edge Microvisor Toolkit on your system.
3+
Edge Microvisor Toolkit is flexible in how it can be installed. It can be deployed
4+
on bare metal, via serial over LAN, or on a virtual machine, as a guest or host
5+
for virtualization of other operating systems.
6+
This section describes in detail how to try out Edge Microvisor Toolkit in different
7+
deployment environment.
58

69
- [Deploying Edge Microvisor Toolkit on Bare Metal](./deployment/emt-bare-metal.md)
10+
- [Deploying Edge Microvisor Toolkit via Serial over LAN](./deployment/emt-serial-over-lan.md)
711
- [Deploying Edge Microvisor Toolkit on Virtual Machines](./deployment/emt-vm-guest.md)
812
- [Deploying Edge Microvisor Toolkit using EMT VIRT](./deployment/emt-vm-host.md)
913

@@ -15,10 +19,8 @@ describes in detail how to quickly install and try out Edge Microvisor Toolkit o
1519
<!--hide_directive
1620
:::{toctree}
1721
./deployment/emt-bare-metal.md
22+
./deployment/emt-serial-over-lan.md
1823
./deployment/emt-vm-guest.md
1924
./deployment/emt-vm-host.md
20-
./deployment/emt-vm-host-setup.md
21-
./deployment/emt-vm-host-win-guest.md
22-
./deployment/emt-vm-host-ubuntu-guest.md
2325
:::
2426
hide_directive-->

0 commit comments

Comments
 (0)