Search Knowledge Base by Keyword

Intel Redfish

< Back

Overview

Redfish is a management specification published by the DMTF, not a product. It defines a JSON over HTTPS interface that a server’s baseboard management controller presents on its own network address, out of band from the operating system, so the server can be inventoried, monitored and controlled whether or not it is running. Resources are addressed as a tree under a fixed service root and cover the system’s processors, memory, storage and network interfaces, the chassis and its power and thermal sensors, the management controller itself, and log services including the System Event Log. Intel server boards implement this interface through their integrated BMC, and that is what this connector talks to.

The ReadyWorks connector is a JSON REST client for a BMC, running on the json_rest_api.php driver. You supply the BMC address as the API Domain, a username and password for a BMC account, and a server-side working path used while responses are parsed. Authentication is a Base64-encoded HTTP Basic header. Unlike the storage connectors in this group, it does ship a working data pull: an inbound template that calls /SEL/Entries and writes System Event Log records into a table called intel_redfish_logs.

Hardware event data is evidence rather than inventory. The System Event Log is where a machine records correctable memory errors, thermal excursions, power events and component failures, and it is usually only read after something has already gone wrong. Landing it in ReadyWorks alongside the device record turns it into a planning input: you can see which machines in a refresh population are already logging faults, prioritise the ones that will fail before their scheduled replacement date, and hold a hardware history against a device that survives an operating system rebuild.

The connector is registered as bidirectional. The outbound side posts a record from ReadyWorks to an endpoint you nominate and captures status, message and record key from the reply, and it ships as an untargeted skeleton.

NOTE: One connection addresses one baseboard management controller. There is no enumeration configured across servers and no shipped inventory job, so collecting the System Event Log across a fleet means creating one ReadyWorks connection per server.

Connector Properties

Property Value
Identifier INTEL REDFISH
Name Intel Redfish
Description Connect to the Intel Servers using the Redfish API
Job Types Both Inbound and Outbound
Order 340
Enabled Yes
Locked Yes
Block Update No
Single Authentication No
Windows Only No
Connector Version 2026-08-10
Hooks None
Additional Job Fields None
Image

Authentication Methods

Intel Redfish offers a single authentication method, using a BMC username and password sent as an HTTP Basic credential.

Method Identifier Base Method Script Order Enabled Config Fields
Basic Authorization: Username / Password INTEL REDFISH_7ce19c90bc INTEL REDFISH_7ce19c90bc json_rest_api.php 70 Yes 4

Method 1: Basic Authorization: Username / Password (INTEL REDFISH_7ce19c90bc)

Connect to a GET method API with a username / password

Joins the connection’s username and password, Base64-encodes them and sends them as an Authorization: Basic header to the management controller. Create a BMC account with a read-only Redfish role: a controller account with operator or administrator rights can power-cycle and reconfigure the server, which is more authority than a collection job requires.

Connection Configuration Fields (4)

Order Label Type Required Default Max Len Tooltip
10 API Domain text Yes 255 Enter API domain of the Connection
10 Server Temporary Working Path text Yes storage/etl5 255 Enter path where temporary files are stored during data processing (exclude starting and ending backslash)
40 Username text No 1024 Tooltip for Username
50 Password password No 64000 Tooltip for Password

Authentication Configuration

Headers sent on the authentication call:

Header Value Base64
Content-Type: application/json Off
Authorization: Basic %user_name%:%user_pass% On

cURL options:

Option Authentication Call Data Calls
USERAGENT Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0 Same
SSL_VERIFYHOST false Same
SSL_VERIFYPEER false Same
RETURNTRANSFER true Same
FOLLOWLOCATION true Same
FAILONERROR true Same

NOTE: SSL peer and host verification are disabled on both the authentication and data calls. Management controllers ship with self-signed certificates, so this is what makes the connection work out of the box, and it also means ReadyWorks does not verify what it is connecting to on the management network.

Inbound Job Fields Enabled (44)

Inbound jobs expose the full REST field set, including three levels of enumeration and all five pagination modes.

Order Label Type Required Default Tooltip
10 Job Description text Yes Enter description of the Job
20 Job Schedule lookup Yes Daily Select frequency Job should run
30 Enabled radio Yes Yes Choose if Job is enabled
40 Use Unparsed Data radio No No Choose if you wish to parse the incoming data, or leave it in its raw format
50 Log Raw API Calls radio Yes No Choose if raw API calls are logged
70 Destination Table text Yes Enter name of the destination table
80 Data Identity text No Enter identity of the Job
120 Append New Data to Existing Tables radio No No Choose if new data will append to the existing destination table, or will create a new destination table
130 Fields to Index text No Enter fields to index
170 Method Type select Yes GET Select method type of the Job
190 API End Point text No Enter API end point of the Job
200 API Data Parameters fields_list No Enter API data parameters of the Job
210 Body Data Sending Method select Yes JSON Encoded Data Select method for sending the body data
220 Raw JSON Body Data textarea No Enter the raw JSON body to send. Do not use body selections in the API Parameters if this is used.
230 API Return Data Node text No Enter API return data node of the Job
250 Pagination Type select No None Select request paging type of the Job
270 API Pagination Node text No Enter API pagination node of the Job
280 Pagination Offset Start text No Enter request paging offset start of the Job
290 Pagination Limit text No Enter request pagination limit of the Job
300 Pagination Termination Node text No Enter request paging termination node and value of the Job
310 Maximum API Calls text No Enter maximum number of API calls for the Job to make
320 Enumeration 1 Type select No None Enter enumeration level 1 type
330 Enumeration 1 ETL Job lookup No Select ETL job for the enumeration values
340 Enumeration 1 Data Type data_type No Select the data type and fields for enumeration 1 values
350 Enumeration 1 Keys End Point text No Enter enumeration 1 keys end point of the Job
360 Enumeration 1 Node text No Enter enumeration 1 node of the Job
370 Enumeration 1 Fields fields_list No Enter enumeration 1 fields of the Job
380 Enumeration 2 Type select No None Enter enumeration level 2 type
390 Enumeration 2 ETL Job lookup No Select ETL job for the enumeration 2 values
400 Enumeration 2 Data Type data_type No Select the data type and fields for enumeration 2 values
410 Enumeration 2 Keys End Point text No Enter enumeration 2 keys end point of the Job
420 Enumeration 2 Node text No Enter enumeration 2 node of the Job
430 Enumeration 2 Fields fields_list No Enter enumeration 2 fields of the Job
440 Enumeration 3 Type select No None Enter enumeration level 3 type
450 Enumeration 3 ETL Job lookup No Select ETL job for the enumeration 3 values
460 Enumeration 3 Data Type data_type No Select the data type and fields for enumeration 3 values
470 Enumeration 3 Keys End Point text No Enter enumeration 3 keys end point of the Job
480 Enumeration 3 Node text No Enter enumeration 3 node of the Job
490 Enumeration 3 Fields fields_list No Enter enumeration 3 fields of the Job
500 Pause Enumeration text No Enter values for pausing enumeration every X calls for Y seconds
510 Kill Enumeration on Error radio No No Choose to stop the enumeration loop on an error or continue processing the loop
520 Additional Fields fields_list No Enter list of additional fields to add to staging data
550 Retry Pause text No Enter values for retrying a failed API connection. Retry X times, waiting Y seconds between each try, with an API timeout of Z seconds.
560 Order text Yes Enter order of the Job

NOTE: Several labels and tooltips in this form carry defects inherited from the shared ETL5 field templates: the Enumeration 1 Node label reads “Enumaration”, the Append New Data label reads “Exisiting”, and the help text on Enumeration 1 Keys End Point and Enumeration 3 Fields both refer to enumeration 2. The underlying fields behave as their labels say.

Outbound Job Fields Enabled (13)

Outbound jobs expose the REST posting field set, including the outbound field list, the return data mapping and an optional raw JSON body template.

Order Label Type Required Default Tooltip
10 Job Description text Yes Enter description of the Job
30 Enabled radio Yes Yes Choose if Job is enabled
50 Log Raw API Calls radio Yes No Choose if raw API calls are logged
170 Method Type select Yes GET Select method type of the Job
180 Data Sending Method select Yes JSON Encoded Data Select method for sending the outbound data
190 API End Point text No Enter API end point of the Job
200 API Data Parameters fields_list No Enter API data parameters of the Job
210 Body Data Sending Method select Yes JSON Encoded Data Select method for sending the body data
260 Return Data Fields List fields_list Yes Enter return data fields of the Job
530 Outbound Fields List fields_list Yes Enter outbound fields of the Job
540 Ignore Empty Outbound Fields radio No Yes Ignore, and do not include, any outbound fields that are empty and have no data
550 Raw JSON Outbound Template textarea No Enter the raw JSON outbound template to send. This will replace any automated structures defined in the outbound fields.
560 Order text Yes Enter order of the Job

Inbound Job Templates (1)

One inbound template ships, and it is the only template in this group of connectors that is enabled by default.

# Job Description Destination Table API End Point Enabled What It Pulls
1 Intel Redfish GET Logs intel_redfish_logs /SEL/Entries Yes A GET against /SEL/Entries that collects System Event Log records from the management controller: the hardware events the BMC has recorded, such as correctable and uncorrectable memory errors, thermal and voltage excursions, power events and component insertion or removal. Rows land in intel_redfish_logs on the Daily schedule.

Job Template Configuration

Settings

Setting Value
Order 10
Enabled Yes
Job Schedule Daily (15 1 * * *)
Destination Table intel_redfish_logs
Data Identity intel_redfish_logs
Allow Empty Table Yes
Append Files to Same Destination Table No
Append New Data to Existing Tables No
Use Unparsed Data No
Convert UUID-Keyed Objects to Rows No
Ignore XML Attributes No
Log Raw API Calls No
Method Type GET
API End Point /SEL/Entries
Body Data Sending Method JSON Encoded Data

NOTE: The end point is the relative fragment /SEL/Entries. Redfish resources live under a versioned service root and the log service sits below a system or manager resource, so the API Domain on the connection has to carry the rest of that path for the call to resolve.

Outbound Job Templates (1)

One outbound template ships, and it is the generic REST skeleton.

# Job Description Method API End Point Enabled What It Does
1 Rest POST API POST Not set No An empty POST job. It sends a single required string field named record_key as a JSON body to an endpoint you supply, and reads status, message and data.record_key back out of the response.

Job Template Configuration

Settings

Setting Value
Order 10
Enabled No
Log Raw API Calls No
Method Type POST
Body Data Sending Method JSON Encoded Data
Data Sending Method JSON Encoded Data
Ignore Empty Outbound Fields Yes

Job Parameters and Enumeration

Rest POST API

Outbound fields list:

Label Name Type Required Pattern
Record Key record_key String on

Return data fields:

Label Name
Return Status status
Return Message message
Record Key data.record_key
Tags: