# Platform Console Subcommand

access: All users

For remote management capability, this command provides access to the platform serial console. Used in conjunction with the platform set console command and appropriate BIOS/platform operating system settings, this command enables you to view the platform serial console while logged in to the Service Processor or via the SM Console using Troubleshooting>SP SSH Console.

> platform console

You must configure the BIOS settings using the BIOS Setup utility. To refresh the BIOS Setup screen, press
Control-R. Choose the Advanced tab to set the configuration. Following are common COM1 values:

I/O Device Configuration
Serial port A | Enabled
Base I/O address | 3F8
Interrupt | IRQ 4

Note: You can change these values as long as they are the same for the operating system serial port values. If your operating system supports the COM2-4 values, you can set these for the BIOS settings.

Console Redirection
Com Port Address | On-board COM A
Console connection | Direct
Baud Rate | 19.2K
Flow Control | None
Console Type | ANSI

The serial console settings in the platform operating system should be set to match the BIOS settings.

Enter the following while you are connected to the console:

> ^Ec character

where ^E is Control-E and character is one of the following:

Character | Function
--- | ---
. | Disconnects an attach read/write.
b | Sends a broadcast message.
c | Toggles flow control.
d | Takes down a console.
e | Changes the escape sequence.
f | Forces an attach read/write.
g | Groups information.
i | Information dump.
L | Toggles logging on/off.
l? | Breaks the sequence list.
l0 | Sends a break per configuration file.
l1-9 | Sends a specific break sequence.
o | Re-opens the tty and log file.
p | Replays the last 60 lines.
r | Replays the last 20 lines.
s | Spy read only.
u | Shows the host status.
v | Shows the version information.
w | Shows who is logged on to this console.
x | Shows the console baud information.
z | Suspends the connection.
<cr> | Ignores/aborts the command.
? | Prints this message.
^R | Replays the last line.
\ooo | Sends the character by octal code.

Under certain circumstances it may be necessary to send a serial break sequence to the platform operating system (for example, to simulate the SysRq key when CONFIG_MAGIC_SYSRQ is defined and enabled in a Linux kernel). To perform this operation, use the following sequence:

> ^Ecl0

(Control-E followed by c, l [ell] and 0 [zero])

The platform console command responds by displaying the string [halt sent] confirming that the break sequence has been generated.

In the event that console output becomes corrupted, ^Ecd ^Eco usually restores proper operation (normally due to flow control issues).

Example

Following is an example of the steps you would perform to enable and run the platform console:
1. Check or set the BIOS settings.
2. Run the following command:

> platform set console -s sp -S 19200 -e

3. Run the following command:

> platform set console

Return Codes

Following are the return values for this command:

Code | Numeric Code | Description
--- | --- | ---
NWSE_Success | 0 | Command successfully completed.
NWSE_InvalidUsage | 1 | Invalid usage: bad parameter usage, conflicting options specified.

Related Topics

System Management Commands

Platform Command