bmcweb provides an implementation of the Redfish API. This document details the Redfish schemas supported by bmcweb. This document also discusses some of the details of that implementation and different implementations available for certain areas.
The redfish implementation shall pass the Redfish Service Validator with no warnings or errors
The following redfish schemas and fields are targeted for OpenBMC. This is a living document, and these schemas are subject to change.
The latest Redfish schemas can be found here
If using a previously unused schema, you will need to add it to the included
schema list in scripts/update_schemas.py
and run update_schemas.py
.
Fields common to all schemas
- @odata.id
- @odata.type
- Id
- Name
- AccountService
- AggregationService
- Cables
- CertificateService
- Chassis
- EventService
- JsonSchemas
- Links/ManagerProvidingService
- Links/Sessions
- Managers
- RedfishVersion
- Registries
- SessionService
- Systems
- Tasks
- TelemetryService
- UUID
- UpdateService
- AccountLockoutDuration
- AccountLockoutThreshold
- Accounts
- Description
- HTTPBasicAuth
- LDAP
- MaxPasswordLength
- MinPasswordLength
- MultiFactorAuth/ClientCertificate/Certificates
- MultiFactorAuth/ClientCertificate/CertificateMappingAttribute
- MultiFactorAuth/ClientCertificate/Enabled
- MultiFactorAuth/ClientCertificate/RespondToUnauthenticatedClients
- Oem/OpenBMC/AuthMethods/BasicAuth
- Oem/OpenBMC/AuthMethods/Cookie
- Oem/OpenBMC/AuthMethods/SessionToken
- Oem/OpenBMC/AuthMethods/TLS
- Oem/OpenBMC/AuthMethods/XToken
- Roles
- ServiceEnabled
- Members
[email protected]
- CertificateString
- Id
- Issuer/City
- Issuer/CommonName
- Issuer/Country
- Issuer/Organization
- Issuer/OrganizationalUnit
- Issuer/State
- KeyUsage
- Subject/City
- Subject/Country
- Subject/CommonName
- Subject/Organization
- Subject/OrganizationalUnit
- Subject/State
- ValidNotAfter
- ValidNotBefore
- AggregationSources
- Description
- ServiceEnabled
- Members
[email protected]
- HostName
- Password
- Description
- Members
[email protected]
- AccountTypes
- Description
- Enabled
- Links/Role
- Locked
[email protected]
- Password
- PasswordChangeRequired
- RoleId
- StrictAccountTypes
- UserName
- Description
- Members
[email protected]
- Description
- Members
- By default will contain 3 roles, "Administrator", "Operator", and "ReadOnly"
[email protected]
- AssignedPrivileges
- For the default roles, the following privileges will be assigned by default
- Administrator: Login, ConfigureManager, ConfigureUsers, ConfigureSelf, ConfigureComponents
- Operator: Login, ConfigureComponents, ConfigureSelf
- ReadOnly: Login, ConfigureSelf
- For the default roles, the following privileges will be assigned by default
- Description
- IsPredefined
- Will be set to true for all default roles. If the given role is non-default, or has been modified from default, will be marked as false.
- OemPrivileges
- RoleId
- Description
- Members
[email protected]
- CableType
- LengthMeters
- Status
- Actions
- CertificateLocations
- Description
- Description
- Links/Certificates
- Links/[email protected]
- Members
[email protected]
- Actions
- AssetTag
- ChassisType
- Drives
- HotPluggable
- Links/ComputerSystems
- Links/ManagedBy
- Location/PartLocation/ServiceLabel
- LocationIndicatorActive
- Manufacturer
- Model
- PartNumber
- Power
- PowerSubsystem
- PowerState
- PhysicalSecurity
- Sensors
- SerialNumber
- SparePartNumber
- Status
- Thermal
- ThermalSubsystem
- UUID
- Version
- Members (This is dependent on a entity manager association from Chassis to
Drives, The name of the association is
chassis<->drive
)
- Drives
[email protected]
- Status (this is dependent on a entity manager association from Chassis to Drives)
- PowerControl
- PowerSupplies
- Redundancy
- Voltages
- Description
- Members
[email protected]
- Reading
- ReadingRangeMax
- ReadingRangeMin
- ReadingType
- ReadingUnits
- SpeedRPM
- Status
- Thresholds
- Fans
- Redundancy
- Temperatures
- MemberId
- Status
- ReadingCelsius
- UpperThresholdNonCritical
- UpperThresholdCritical
- LowerThresholdNonCritical
- LowerThresholdCritical
- MinReadingRange
- MaxReadingRange threshold fields only present if defined for sensor, otherwise absent
- MemberId
- Status
- Reading
- ReadingUnits
- UpperThresholdNonCritical
- UpperThresholdCritical
- LowerThresholdNonCritical
- LowerThresholdCritical
- MinReadingRange
- MaxReadingRange
- Redundancy threshold fields only present if defined for sensor, otherwise absent
- MemberId
- RedundancySet
- Mode
- Status
- MinNumNeeded
- MaxNumSupported
- Status
- ThermalMetrics
- TemperatureReadingsCelsius[]/DataSourceUri
- TemperatureReadingsCelsius[]/Reading
- [email protected]
- Description
- Members
[email protected]
- Location
- Manufacturer
- Model
- PartNumber
- SerialNumber
- SparePartNumber
- Status
- MemberId
- PowerConsumedWatts
- PowerMetrics/IntervalInMin
- PowerMetrics/MinConsumedWatts
- PowerMetrics/MaxConsumedWatts
- PowerMetrics/AverageConsumedWatts
- RelatedItem
- Should list systems and related chassis
- MemberId
- Status
- ReadingVolts
- UpperThresholdNonCritical
- UpperThresholdCritical
- LowerThresholdNonCritical
- LowerThresholdCritical
- MinReadingRange
- MaxReadingRange
- PhysicalContext
- RelatedItem
- MemberId
- Status
- LininputVoltage
- Model
- manufacturer
- FirmwareVersion
- SerialNumber
- PartNumber
- RelatedItem
- Redundancy
- MemberId
- RedundancySet
- Mode
- Status
- MinNumNeeded
- MaxNumSupported
- Description
- Members
[email protected]
- EfficiencyRatings
- EfficiencyPercent
- FirmwareVersion
- Location
- Manufacturer
- Model
- PartNumber
- SerialNumber
- SparePartNumber
- Status
- Actions
- DeliveryRetryAttempts
- Defaults to 3
- DeliveryRetryIntervalSeconds
- EventFormatTypes
- RegistryPrefixes
- ResourceTypes
- SSEFilterPropertiesSupported
- ServiceEnabled
- Status
- Subscriptions
- Members
[email protected]
- Id
- Destination
- EventTypes
- Context
- HeartbeatIntervalMinutes
- OriginResources
- RegistryPrefixes
- Protocol
- SendHeartbeat
- Description
[email protected]
- Members
- Schema
- Description
- Languages
[email protected]
- Location
[email protected]
- Members
[email protected]
- Actions
- DateTime
- DateTimeLocalOffset
- Description
- EthernetInterfaces
- FirmwareVersion
- GraphicalConsole
- LastResetTime
- Links/ActiveSoftwareImage
- Links/ManagerForChassis
- Links/[email protected]
- Links/ManagerForServers
- Links/[email protected]
- Links/ManagerInChassis
- Links/SoftwareImages
- Links/[email protected]
- LogServices
- ManagerType
- Manufacturer
- Model
- NetworkProtocol
- Oem
- PartNumber
- PowerState
- SerialNumber
- ServiceEntryPointUUID
- SparePartNumber
- Status
- UUID
- Description
- Members
[email protected]
- DHCPv4
- DHCPv6
- Description
- EthernetInterfaceType
- FQDN
- HostName
- IPv4Addresses
- IPv4StaticAddresses
- IPv6AddressPolicyTable
- IPv6Addresses
- IPv6DefaultGateway
- IPv6StaticAddresses
- IPv6StaticDefaultGateways
- InterfaceEnabled
- Links/RelatedInterfaces
- LinkStatus
- MACAddress
- NameServers
- SpeedMbps
- StatelessAddressAutoConfig
- StaticNameServers
- Status
- VLAN/VLANEnable
- VLAN/VLANId
- VLAN/Tagged
The LogService resource provides properties for monitoring and configuring events for the service or resource to which it is associated.
Within bmcweb, the LogService object resides under the System resource. It tracks all events for the system.
The LogService supports multiple log entry types. bmcweb has support for the
Event
type. This is the new Redfish-defined type.
bmcweb supports two different implementations of the
LogService/EventLog/Entries
URI.
The default implementation uses rsyslog to write Redfish events from the journal to the persistent /var/log/ filesystem. The bmcweb software then looks for these files in /var/log/ and returns the appropriate Redfish EventLog Entries for these. More details on adding events can be found here
The other implementation of EventLog Entries can be enabled by compiling bmcweb
with the -DBMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES=ON
option. This will cause
bmcweb to look to phosphor-logging for any D-Bus log entries. These will
then be translated to Redfish EventLog Entries.
These two implementations do not work together, so choosing one will disable the other.
- Description
- Members
[email protected]
- Entries
- OverWritePolicy
- Actions
- Status
- DateTime
- MaxNumberOfRecords
- Message
- Created
- EntryType
- ServiceRootUptimeSeconds
- FreeStorageSpaceKiB
- MemoryStatistics/AvailableBytes
- MemoryStatistics/BuffersAndCacheBytes
- MemoryStatistics/FreeBytes
- MemoryStatistics/SharedBytes
- MemoryStatistics/TotalBytes
- ProcessorStatistics/KernelPercent
- ProcessorStatistics/UserPercent
- Description
- FQDN
- HTTP
- HTTPS
- HostName
- IPMI
- NTP
- SSH
- Status
- Description
- Members
[email protected]
- CertificateString
- Description
- Issuer
- KeyUsage
- Subject
- ValidNotAfter
- ValidNotBefore
- Description
- error
- Description
- Members
- Should support Base, CommonMessages, and EventingMessages
[email protected]
- Description
- Languages
[email protected]
- Location
[email protected]
- Registry
- Description
- ServiceEnabled
- SessionTimeout
- Sessions
- Description
- Members
[email protected]
- ClientOriginIPAddress
- Description
- Roles
- UserName
- Members
- Should support one system
[email protected]
- Actions
- Description
- Links/ActiveSoftwareImage
- Links/SoftwareImages
- Links/[email protected]
- Actions
- AssetTag
- Bios
- BiosVersion
- Boot
- BootProgress
- Description
- FabricAdapters
- HostWatchdogTimer
- IdlePowerSaver/Enable
- IdlePowerSaver/EnterUtilizationPercent
- IdlePowerSaver/EnterDwellTimeSeconds
- IdlePowerSaver/ExitUtilizationPercent
- IdlePowerSaver/ExitDwellTimeSeconds
- IndicatorLED
- LastResetTime
- Links/Chassis
- Links/ManagedBy
- LocationIndicatorActive
- LogServices
- Manufacturer
- Memory
- MemorySummary
- Model
- PCIeDevices
- PartNumber
- PowerMode
- PowerRestorePolicy
- PowerState
- ProcessorSummary
- Processors
- SerialConsole/IPMI/ServiceEnabled
- SerialConsole/MaxConcurrentSessions
- SerialConsole/SSH/HotKeySequenceDisplay
- SerialConsole/SSH/Port
- SerialConsole/SSH/ServiceEnabled
- SerialNumber
- Status
- Storage
- SubModel
- SystemType
- Members
[email protected]
- Description
- Members
[email protected]
- Location
- Model
- PartNumber
- SerialNumber
- SparePartNumber
- Status
- Description
- Members
- Should default to one member, named SEL
[email protected]
- Actions
- DateTime
- DateTimeLocalOffset
- Description
- Entries
- OverWritePolicy
- Description
- Members
[email protected]
- AdditionalDataURI
- Created
- EntryType
- Message
- Modified
- Resolved
- Severity
- Members
[email protected]
- Description
- @odata.nextLink
- MessageArgs
- Severity
- SensorType
- Message
- MessageId
- Created
- EntryCode
- EntryType
- Members
[email protected]
- AllowedSpeedsMHz
- BaseModuleType
- BusWidthBits
- CapacityMiB
- DataWidthBits
- ErrorCorrection
- FirmwareRevision
- Manufacturer
- Model
- OperatingSpeedMhz
- PartNumber
- RankCount
- SerialNumber
- SparePartNumber
- Status
- Description
- HealthData
- Description
- Members
[email protected]
- Manufacturer
- Model
- PartNumber
- PCIeInterface
- LanesInUse
- MaxLanes
- MaxPCIeType
- PCIeType
- SerialNumber
- Slot
- Lanes
- PCIeType
- SlotType
- SparePartNumber
- Status
- Members
- Should Support CPU1 and CPU2 for dual socket systems
[email protected]
- InstructionSet
- Manufacturer
- MaxSpeedMHz
- PartNumber
- ProcessorArchitecture
- ProcessorId
- ProcessorType
- SerialNumber
- Socket
- SparePartNumber
- Status
- ThrottleCauses
- Throttled
- TotalCores
- TotalThreads
- Version
- Parameters/AllowableValues
- Parameters/DataType
- Parameters/Required
- Members
[email protected]
- Drives
[email protected]
- Status
- CapacityBytes
- EncryptionStatus
- Links
- Status
- CompletedTaskOverWritePolicy
- DateTime
- LifeCycleEventOnTaskStateChange
- ServiceEnabled
- Status
- Tasks
- Members
[email protected]
- MaxReports
- MetricReportDefinitions
- MetricReports
- MinCollectionInterval
- Status
- Triggers
- SupportedCollectionFunctions
- Members
[email protected]
- AppendLimit
- Id
- MetricReport
- MetricReportDefinitionEnabled
- MetricReportDefinitionType
- Metrics
- Name
- ReportActions
- ReportUpdates
- Schedule
- Status
- Members
[email protected]
- Id
- MetricReportDefinition
- MetricValues
- Name
- Timestamp
- Members
[email protected]
- Actions
- Description
- FirmwareInventory
- HttpPushUri
- HttpPushUriOptions
- MaxImageSizeBytes
- ServiceEnabled
- Members
- Should Support BMC, ME, CPLD and BIOS
[email protected]
- Description
[email protected]
- RelatedItem
- Status
- Updateable
- Version