Skip to main content

GET – BMC serial interface properties

Use the GET method to retrieve properties in the resource of serial interface for Redfish service.

Request URL​

GET https://<BMC_IPADDR>/redfish/v1/Managers/1/SerialInterfaces/1

Request body​

None

Response body​

The response is a JSON object that contains the following parameters:

FieldTypeDescription

id

String

“1”

Name

String

“Serial Interface”

BitRate

String

Bit rate of the serial interface. Valid values include: 9600, 19200, 38400, 57600, 115200

SignalType

String

“Rs232”

Parity

String

Parity information for the serial interface, valid values include: None, Odd, Even.

StopBits

String

Serial interface stop bits .

DataBits

String

8

Description

String

Serial Interface of Redfish

FlowControl

String

“None”

InterfaceEnabled

Boolean

Indicates whether this interfaces is enabled.

Status code​

HTTP Status CodeError Message ID
500InternalError

Response example​

When the request is successful, a message body similar to the following is returned:

{
    "SignalType": "Rs232",
    "BitRate": "115200",
    "@odata.id": "/redfish/v1/Managers/1/SerialInterfaces/1",
    "InterfaceEnabled": true,
    "Description": "Serial port redirection of the host.",
    "Name": "Serial Interface",
    "@odata.context": "/redfish/v1/$metadata#SerialInterface.SerialInterface",
    "StopBits": "1",
    "Oem": {
        "Lenovo": {
            "CLIMode": "UserDefined",
            "@odata.type": "#LenovoSerialInterface.v1_0_0.LenovoSerialInterfaceProperties",
            "EnterCLIKeySequence": "^[(",
            "SerialInterfaceState": "Enabled"
        }
    },
    "@odata.type": "#SerialInterface.v1_1_3.SerialInterface",
    "DataBits": "8",
    "Id": "1",
    "@odata.etag": "\"bc5c2883051b4e001123be789f9c8034\"",
    "Parity": "None",
    "FlowControl": "None"
}