Christian Manivong
5f8a4ef975
No code yet. The README explains why one Redfish driver with vendor quirk modules beats a Supermicro-only IPMI driver, and keeps IPMI over LAN as a read-only fallback. docs/ holds a draft for a new ManagementController role base in napalm-device-types, the getter-to-resource map, the first test device (Supermicro X10DRL-i, Redfish firmware 3.91), the security points (IPMI RAKP hash disclosure, power control, credentials) and the test plan with DMTF mockups and fixtures to record.
3.1 KiB
3.1 KiB
Getters mapped to Redfish resources
Paths use the usual single-member IDs (Systems/1, Managers/1, Chassis/1); the driver
must follow the collections instead of assuming IDs, because vendors differ (Dell uses
System.Embedded.1, HPE uses 1, Supermicro uses 1).
Authentication
- Session:
POST /redfish/v1/SessionService/Sessionswith user and password returns anX-Auth-Tokenheader and the session's URI. Use the token,DELETEthe session on close. BMCs allow few concurrent sessions, so leaking them locks out the web UI. - Basic auth works on most services and is the fallback.
- Self-signed certificates are the norm; verification is configurable per device.
NAPALM getters
| Getter | Resource | Fields |
|---|---|---|
get_facts |
Systems/{id}, Managers/{id} |
Manufacturer, Model, SerialNumber, HostName; BMC FirmwareVersion as os_version. uptime is not in Redfish (return -1). interface_list from Managers/{id}/EthernetInterfaces |
get_interfaces |
Managers/{id}/EthernetInterfaces/* |
BMC ports: MACAddress, SpeedMbps, LinkStatus, InterfaceEnabled |
get_interfaces_ip |
same | IPv4Addresses, IPv6Addresses |
get_environment |
Chassis/{id}/Thermal (Temperatures[], Fans[]), Chassis/{id}/Power (PowerSupplies[], PowerControl[].PowerConsumedWatts) |
Newer services move these to ThermalSubsystem, PowerSubsystem and Sensors; read whichever exists. CPU and memory of the host OS are unknown to a BMC |
get_users |
AccountService/Accounts/* |
UserName, RoleId, Enabled |
get_ntp_servers |
Managers/{id}/NetworkProtocol |
NTP.NTPServers (newer schema versions only) |
get_snmp_information |
Managers/{id}/NetworkProtocol |
SNMP.ProtocolEnabled (details vary) |
get_config |
n/a | A BMC has no configuration file. Not implemented |
Role methods (draft, see role.md)
| Method | Resource |
|---|---|
get_power_state |
Systems/{id}: PowerState |
set_power_state |
POST Systems/{id}/Actions/ComputerSystem.Reset with ResetType; allowed values from ResetType@Redfish.AllowableValues (or the ActionInfo resource) |
reboot_host (the BMC) |
POST Managers/{id}/Actions/Manager.Reset |
get_hardware_inventory |
Systems/{id} (ProcessorSummary, MemorySummary), Systems/{id}/Processors/*, Systems/{id}/Memory/*, Systems/{id}/Storage/* (older: SimpleStorage), Chassis/{id}/Power PSUs, Systems/{id}/EthernetInterfaces/* |
get_event_log |
Systems/{id}/LogServices/*/Entries or Managers/{id}/LogServices/*/Entries (where the SEL lives varies by vendor) |
get_firmware_inventory |
UpdateService/FirmwareInventory/*: Name, Version, Updateable |
get_management_protocols |
Managers/{id}/NetworkProtocol: HTTP, HTTPS, SSH, IPMI, SNMP, KVMIP, VirtualMedia, SSDP, each with ProtocolEnabled and Port |
IPMI fallback (ipmi entry point)
Read-only, via pyghmi: device ID and FRU data for get_facts, sensor data repository for
get_environment, chassis status for get_power_state, SEL for get_event_log. No power
control over IPMI.