Skip to main content

GET – Serial Interface Instance

Request

GET https://{{ip}}/redfish/v1/Managers/{{manager_instance}}/SerialInterfaces/{{manager_serialifc_instance}}
Content-Type: application/json

Response

The response of the request will be in JSON format. The properties are mentioned in the following tables.

Table 1. Serial Interface Properties

Name

Type

Read Only

Description

(OData Attributes)  

Refer to OData Support

OemObject 

OEM Extension (Optional), Refer to Resource Complex Types

Id(M)

String

True

Refer to Resource Type Definitions

Name(M)

String

True

Description

String

True

InterfaceEnabled

Boolean

True

The “read-only” is false only for IPMI-SOL

This indicates whether this interface is enabled.

BitRate

String

True

The “read-only” is false only for IPMI-SOL

The receive and transmit rate of data flow, typically in bits-per-second (bps), over the serial connection and can take any one of the following enum values.

"enum": [

"9600",

"19200",

"38400",

"57600",

"115200

]

Note
BitRate property for Serial Interface in Redfish maps the non-volatile bit rate setting of IPMI SOL.

Parity

String

True

The type of parity used by the sender and receiver in order to detect errors over the serial connection. It can take any one of the following enum values :

"enum": [ "None", "Even", "Odd", "Mark", "Space" ]

SignalType(C)

(Not Supported)

String

True

The type of signal used for the communication connection- RS232 or RS485.

"enum": ["Rs232","Rs485"]

ConnectorType(C)

(Not Supported)

String

True

The type of connector used for this interface.

"enum": [

"RJ45.",

"RJ11.",

"DB9 Female.",

"DB9 Male.",

"DB25 Female.",

"DB25 Male.",

"USB.",

"mUSB.",

"uUSB."

]

PinOut(C)

(Not Supported)

String

True

The physical pin configuration needed for a serial connector.

"enum": [

"Cisco",

"Cyclades",

"Digi"

]

DataBits

String

True

The number of data bits that will follow the start bit over the serial connection.

"enum": [ "5","6", "7", "8" ]

StopBits

String

True

The period of time before the next start bit is transmitted.

"enum": [ "1", "2" ]

Actions

(Not Supported)

Object

True

This object will contain the actions for this resource under Oem property if any.

FlowControl

String

True

The type of flow control, if any, that will be imposed on the serial connection.

Enum

Description

None

No flow control imposed

Software

XON/XOFF in-band flow control imposed

Hardware

Out of band flow control imposed