Platform Set Console Subcommand

access: Administrators, Managers

Enables configuration of Service Processor access to the platform serial console, sets the speed of the connection, and limits the size of the log files created.

Two options are available:


Following is the syntax for configuring the external serial port so that it is connected to the platform serial console. This is the default setting.

platform set console {--serial|-s} platform

Following is the syntax for configuring the external serial port so that it is connected to the Service Processor serial console. You can then access the platform serial console via the Service Processor command line or SM Console using the platform console command.

platform set console {--serial|-s} sp
[{{--enable|-e}|{--disable|-d}}]
[{{--prune|-p}|{--noprune|-n}}] [{--speed|-S}
{1200|2400|4800|9600|19200|38400|115200}] [{--log|-l} size]

None of the following arguments can be used with -s set to platform.

Arguments Description

{-S|--speed}

{1200|2400|4800|9600|19200|38400|115200}

Select the port speed for the platform console. BIOS, the platform operating system, and the console must all be configured for the same speed.
{-d|--disable} Indicates that the platform console monitor is inactive. Cannot be used with: -e.
{-e|--enable} Indicates that the platform console monitor is active. Cannot be used with: -d.
{-l|--log} size

Select the trigger size in KB for console log rotation.

{-n|--noprune}

Indicates that the platform console log should be the raw console data. Cannot be used with: -p

{-p|--prune}

Indicates that the platform console log is to be cleaned of ANSI sequences and pruned of duplicated information. Cannot be used with: -n


{-s|--serial} {sp|platform}

Specify whether the serial port is connected to the platform COMA port, or the Service Processor serial console.
Cannot be used with: -e [platform] -d [platform] -p [platform] -n [platform] -S [platform] -l [platform].

The acceptable values for log size are between 64 and 1024 inclusive.

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.
NWSE_RPCTimeout 2 Request was issued, but was not serviced by the server. RPC procedure timed out and the request may or may not have been serviced by the server.
NWSE_RPCNotConnected 3 Unable to connect to the RPC server.
NWSE_InvalidArgument 4 One or more arguments were incorrect or invalid.
NWSE_NoPermission 6 Not authorized to perform this operation.
NWSE_NoMemory 8 Insufficient memory.
NWSE_DeviceError 25 Unable to read or write to the device.

Related Topics

System Management Commands

Platform Command