Redfish Endpoints Reference

This page documents all Redfish endpoints used by NCX Infra Controller (NICo), organized by resource group. Each section includes endpoint tables, required response fields with their importance to NICo, and vendor-specific notes.

Field importance levels:

• Critical — NICo cannot function correctly without this field. Pairing, identification, or core workflows fail.
• Required — Expected by NICo and used in normal operation. Missing values cause degraded behavior.
• Recommended — Used when available, with graceful fallback if absent.
• Optional — Informational or used only in specific configurations.

For the manually-maintained tracker with full vendor coverage and response payload examples, see the DSX OEM Redfish APIs spreadsheet.

Service Root

Code: get_service_root() in libredfish; probe_redfish_endpoint() in site_explorer/redfish.rs

Key Response Fields

Systems

Code: get_systems(), get_system() in libredfish; exploration in site_explorer/redfish.rs

Key Response Fields

Sample response (GET /redfish/v1/Systems/{id}):

1
{
2
  "Id": "System.Embedded.1",
3
  "SerialNumber": "J1234XY",
4
  "PowerState": "On",
5
  "Manufacturer": "Dell Inc.",
6
  "Model": "PowerEdge R750",
7
  "Boot": {
8
    "BootOrder": ["NIC.Slot.3-1", "HardDisk.Direct.0-0:AHCI"],
9
    "BootOptions": { "@odata.id": "/redfish/v1/Systems/System.Embedded.1/BootOptions" }
10
  },
11
  "PCIeDevices": [
12
    { "@odata.id": "/redfish/v1/Systems/System.Embedded.1/PCIeDevices/236-0" }
13
  ],
14
  "EthernetInterfaces": { "@odata.id": "/redfish/v1/Systems/System.Embedded.1/EthernetInterfaces" }
15
}

Vendor-specific notes: Dell/Supermicro/HPE have system info overrides. NVIDIA DPU uses Oem.Nvidia for mode set/rshim. NVIDIA GBx00 uses Oem.Nvidia for machine setup.

System Ethernet Interfaces

Code: get_system_ethernet_interfaces(), get_system_ethernet_interface() in libredfish

Key Response Fields

Chassis

Code: get_chassis_all(), get_chassis(), get_chassis_assembly() in libredfish

Key Response Fields

Sample response (GET /redfish/v1/Chassis/{id}):

1
{
2
  "Id": "Card1",
3
  "SerialNumber": "MBF2M516A-CECA_Ax_SN123456",
4
  "PartNumber": "900-9D3B6-00CV-AA0",
5
  "Model": "BlueField-2 DPU 25GbE",
6
  "Manufacturer": "NVIDIA",
7
  "NetworkAdapters": { "@odata.id": "/redfish/v1/Chassis/Card1/NetworkAdapters" }
8
}

Network Adapters

Code: get_chassis_network_adapters(), get_chassis_network_adapter() in libredfish

Key Response Fields

Sample response (GET /redfish/v1/Chassis/{id}/NetworkAdapters/{id}):

1
{
2
  "Id": "ConnectX6_1",
3
  "SerialNumber": "MT2243X01234",
4
  "PartNumber": "MCX653106A-HDAT_Ax",
5
  "Controllers": [
6
    {
7
      "FirmwarePackageVersion": "24.37.1014",
8
      "Links": { "PCIeDevices": [{ "@odata.id": "/redfish/v1/Systems/System.Embedded.1/PCIeDevices/236-0" }] }
9
    }
10
  ]
11
}

PCIe Devices

Code: pcie_devices() in libredfish; site_explorer exploration

Key Response Fields

Vendor-specific note: Supermicro uses Chassis/{id}/PCIeDevices; others embed PCIeDevices links in Systems/{id} response.

Managers

Code: get_managers(), get_manager() in libredfish

Key Response Fields

Vendor-specific notes: HPE has lockdown status override. Dell uses Managers/{id}/Attributes for lockdown/remote access. Supermicro uses Oem/Supermicro/SysLockdown.

Manager Ethernet Interfaces

Code: get_manager_ethernet_interfaces(), get_manager_ethernet_interface() in libredfish

Key Response Fields

Sample response (GET /redfish/v1/Managers/{id}/EthernetInterfaces/{id}):

1
{
2
  "Id": "1",
3
  "MACAddress": "B8:3F:D2:90:95:82",
4
  "IPv4Addresses": [{ "Address": "10.0.1.100" }]
5
}

Boot Options

Code: get_boot_options(), get_boot_option() in libredfish

Key Response Fields

Sample response (GET /redfish/v1/Systems/{id}/BootOptions/{id}):

1
{
2
  "Id": "NIC.Slot.3-1",
3
  "DisplayName": "PXE OOB NIC Slot 3 Port 1",
4
  "UefiDevicePath": "PciRoot(0x2)/Pci(0x1,0x0)/Pci(0x0,0x0)/MAC(B83FD2909582,0x1)",
5
  "BootOptionEnabled": true,
6
  "BootOptionReference": "NIC.Slot.3-1"
7
}

BIOS

Code: bios(), set_bios(), pending(), clear_pending(), reset_bios(), change_bios_password() in libredfish

Key Response Fields

Vendor-specific paths: HPE uses /Bios/settings (lowercase). Lenovo uses /Bios/Pending. Viking uses /Bios/SD. Dell/NVIDIA DPU/GBx00/Supermicro have attribute-specific overrides.

Secure Boot

Code: get_secure_boot(), enable_secure_boot(), disable_secure_boot(), get_secure_boot_certificates(), add_secure_boot_certificate() in libredfish

Key Response Fields

Account Service

Code: get_accounts(), change_password_by_id(), create_user(), delete_user(), set_machine_password_policy() in libredfish

Key Response Fields

Firmware Inventory

Code: get_software_inventories(), get_firmware() in libredfish; FirmwareCollector in health crate via nv-redfish

Key Response Fields

Sample response (GET /redfish/v1/UpdateService/FirmwareInventory/{id}):

1
{
2
  "Id": "BMC_Firmware",
3
  "Name": "BMC Firmware",
4
  "Version": "7.00.00.171",
5
  "ReleaseDate": "2024-06-15T00:00:00Z",
6
  "Updateable": true
7
}

Sensors and Thermal (Health Monitoring)

Code: monitor.rs in health crate; get_thermal_metrics(), get_power_metrics() in libredfish

All endpoints below are polled at the configured sensor_fetch_interval (default 60 seconds).

Key Response Fields

Log Services

Code: logs_collector.rs in health crate; get_bmc_event_log(), get_system_event_log() in libredfish

Log collection runs at 5-minute intervals and uses incremental fetching: ?$filter=Id gt '{last_id}'

Discovery endpoints (all vendors)

BMC event log entries (vendor-specific)

System event log entries (vendor-specific)

Key Response Fields

Task Service

Code: get_tasks(), get_task() in libredfish

Dell also uses Managers/{id}/Jobs/{id} (converted to Task internally).

Component Integrity

Code: get_component_integrities(), get_component_ca_certificate(), trigger_evidence_collection(), get_evidence() in libredfish

Manager Network Protocol

Code: get_manager_network_protocol() in libredfish

Storage

Code: get_drives_metrics() in libredfish; discover_drive_entities() in health monitor

NVIDIA OEM Extensions

Code: Various methods in libredfish nvidia_dpu.rs, nvidia_gh200.rs, nvidia_gb200.rs, nvidia_gbswitch.rs

CI/CD Pipeline Endpoints

These endpoints are used by the CI/CD tooling (cicd/redfish_cli.py, cicd/install_wrapper.py) and are not part of core NICo.