Skip to content

Latest commit

 

History

History
1135 lines (841 loc) · 19.9 KB

Redfish.md

File metadata and controls

1135 lines (841 loc) · 19.9 KB
Raw

Redfish

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.

Redfish Schema

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

/redfish/v1/

ServiceRoot

  • AccountService
  • AggregationService
  • Cables
  • CertificateService
  • Chassis
  • EventService
  • JsonSchemas
  • Links/ManagerProvidingService
  • Links/Sessions
  • Managers
  • RedfishVersion
  • Registries
  • SessionService
  • Systems
  • Tasks
  • TelemetryService
  • UUID
  • UpdateService

/redfish/v1/AccountService/

AccountService

  • 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

/redfish/v1/AccountService/MultiFactorAuth/ClientCertificate/Certificates

/redfish/v1/AccountService/MultiFactorAuth/ClientCertificate/Certificates/{Certificate}

  • 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

/redfish/v1/AggregationService/

AggregationService

  • AggregationSources
  • Description
  • ServiceEnabled

/redfish/v1/AggregationService/AggregationSources

AggregationSourceCollection

/redfish/v1/AggregationService/AggregationSources/{AggregationSourceId}

AggregationSource

  • HostName
  • Password

/redfish/v1/AccountService/Accounts/

ManagerAccountCollection

/redfish/v1/AccountService/Accounts/{ManagerAccountId}/

ManagerAccount

  • AccountTypes
  • Description
  • Enabled
  • Links/Role
  • Locked
  • [email protected]
  • Password
  • PasswordChangeRequired
  • RoleId
  • StrictAccountTypes
  • UserName

/redfish/v1/AccountService/LDAP/Certificates/

CertificateCollection

/redfish/v1/AccountService/Roles/

RoleCollection

  • Description
  • Members
    • By default will contain 3 roles, "Administrator", "Operator", and "ReadOnly"
  • [email protected]

/redfish/v1/AccountService/Roles/{RoleId}/

Role

  • 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
  • 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

/redfish/v1/Cables/

CableCollection

/redfish/v1/Cables/{CableId}/

Cable

  • CableType
  • LengthMeters
  • Status

/redfish/v1/CertificateService/

CertificateService

  • Actions
  • CertificateLocations
  • Description

/redfish/v1/CertificateService/CertificateLocations/

CertificateLocations

/redfish/v1/Chassis/

ChassisCollection

/redfish/v1/Chassis/{ChassisId}/

Chassis

  • 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

/redfish/v1/Chassis/{ChassisId}/Drive/

Drive

  • Members (This is dependent on a entity manager association from Chassis to Drives, The name of the association is chassis<->drive)

/redfish/v1/Chassis/{ChassisId}/Drive/{DriveId}/

Drive

  • Drives
  • [email protected]
  • Status (this is dependent on a entity manager association from Chassis to Drives)

/redfish/v1/Chassis/{ChassisId}/EnvironmentMetrics/

EnvironmentMetrics

/redfish/v1/Chassis/{ChassisId}/Power/

Power

  • PowerControl
  • PowerSupplies
  • Redundancy
  • Voltages

/redfish/v1/Chassis/{ChassisId}/Sensors/

SensorCollection

/redfish/v1/Chassis/{ChassisId}/Sensors/{Id}/

Sensor

  • Reading
  • ReadingRangeMax
  • ReadingRangeMin
  • ReadingType
  • ReadingUnits
  • SpeedRPM
  • Status
  • Thresholds

/redfish/v1/Chassis/{ChassisId}/Thermal/

Thermal

  • Fans
  • Redundancy
  • Temperatures

/redfish/v1/Chassis/{ChassisId}/Thermal#/Temperatures/{SensorName}/

Temperature

  • MemberId
  • Status
  • ReadingCelsius
  • UpperThresholdNonCritical
  • UpperThresholdCritical
  • LowerThresholdNonCritical
  • LowerThresholdCritical
  • MinReadingRange
  • MaxReadingRange threshold fields only present if defined for sensor, otherwise absent

/redfish/v1/Chassis/{ChassisId}/Thermal#/Fans/{FanName}/

Fan

  • MemberId
  • Status
  • Reading
  • ReadingUnits
  • UpperThresholdNonCritical
  • UpperThresholdCritical
  • LowerThresholdNonCritical
  • LowerThresholdCritical
  • MinReadingRange
  • MaxReadingRange
  • Redundancy threshold fields only present if defined for sensor, otherwise absent

/redfish/v1/Chassis/{ChassisId}/Thermal#/Redundancy/{RedundancyName}/

Redundancy

  • MemberId
  • RedundancySet
  • Mode
  • Status
  • MinNumNeeded
  • MaxNumSupported

/redfish/v1/Chassis/{ChassisId}/ThermalSubsystem

ThermalSubsystem

  • Status
  • ThermalMetrics

/redfish/v1/Chassis/{ChassisId}/ThermalSubsystem/ThermalMetrics/

ThermalMetrics
  • TemperatureReadingsCelsius[]/DataSourceUri
  • TemperatureReadingsCelsius[]/Reading
  • [email protected]

/redfish/v1/Chassis/{ChassisId}/ThermalSubsystem/Fans

FansCollection

/redfish/v1/Chassis/{ChassisId}/ThermalSubsystem/Fans/{FanName}/

Fan

  • Location
  • Manufacturer
  • Model
  • PartNumber
  • SerialNumber
  • SparePartNumber
  • Status

/redfish/v1/Chassis/{ChassisId}/Power#/PowerControl/{ControlName}/

PowerControl

  • MemberId
  • PowerConsumedWatts
  • PowerMetrics/IntervalInMin
  • PowerMetrics/MinConsumedWatts
  • PowerMetrics/MaxConsumedWatts
  • PowerMetrics/AverageConsumedWatts
  • RelatedItem
    • Should list systems and related chassis

/redfish/v1/Chassis/{ChassisId}/Power#/Voltages/{VoltageName}/

Voltage

  • MemberId
  • Status
  • ReadingVolts
  • UpperThresholdNonCritical
  • UpperThresholdCritical
  • LowerThresholdNonCritical
  • LowerThresholdCritical
  • MinReadingRange
  • MaxReadingRange
  • PhysicalContext
  • RelatedItem

/redfish/v1/Chassis/{ChassisId}/Power#/PowerSupplies/{PSUName}/

PowerSupply

  • MemberId
  • Status
  • LininputVoltage
  • Model
  • manufacturer
  • FirmwareVersion
  • SerialNumber
  • PartNumber
  • RelatedItem
  • Redundancy

/redfish/v1/Chassis/{ChassisId}/Power#/Redundancy/{RedundancyName}/

Redundancy

  • MemberId
  • RedundancySet
  • Mode
  • Status
  • MinNumNeeded
  • MaxNumSupported

/redfish/v1/Chassis/{ChassisId}/PowerSubsystem/PowerSupplies

PowerSupplies

/redfish/v1/Chassis/{ChassisId}/PowerSubsystem/PowerSupplies/{PowerSupplyId}

PowerSupply
  • EfficiencyRatings
    • EfficiencyPercent
  • FirmwareVersion
  • Location
  • Manufacturer
  • Model
  • PartNumber
  • SerialNumber
  • SparePartNumber
  • Status

/redfish/v1/EventService/

EventService

  • Actions
  • DeliveryRetryAttempts
    • Defaults to 3
  • DeliveryRetryIntervalSeconds
  • EventFormatTypes
  • RegistryPrefixes
  • ResourceTypes
  • SSEFilterPropertiesSupported
  • ServiceEnabled
  • Status
  • Subscriptions

/redfish/v1/EventService/Subscriptions/

EventDestinationCollection

/redfish/v1/EventService/Subscriptions/{EventName}/

EventDestination

  • Id
  • Destination
  • EventTypes
  • Context
  • OriginResources
  • RegistryPrefixes
  • Protocol

/redfish/v1/JsonSchemas/

JsonSchemaFileCollection

/redfish/v1/JsonSchemas/{Id}/

JsonSchemaFile

/redfish/v1/Managers/

ManagerCollection

/redfish/v1/Managers/bmc/

Manager

  • 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

/redfish/v1/Managers/bmc/EthernetInterfaces/

EthernetInterfaceCollection

/redfish/v1/Managers/bmc/EthernetInterfaces/{EthernetInterfaceId}/

EthernetInterface

  • 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

/redfish/v1/Managers/bmc/LogServices/

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.

LogServiceCollection

/redfish/v1/Managers/bmc/LogServices/RedfishLog/

LogService

  • Entries
  • OverWritePolicy
  • Actions
  • Status
  • DateTime
  • MaxNumberOfRecords

/redfish/v1/Managers/bmc/LogServices/RedfishLog/Entries/{LogEntryId}/

LogEntry

  • Message
  • Created
  • EntryType

/redfish/v1/Managers/bmc/ManagerDiagnosticData/

ManagerDiagnosticData

  • ServiceRootUptimeSeconds
  • FreeStorageSpaceKiB
  • MemoryStatistics/AvailableBytes
  • MemoryStatistics/BuffersAndCacheBytes
  • MemoryStatistics/FreeBytes
  • MemoryStatistics/SharedBytes
  • MemoryStatistics/TotalBytes
  • ProcessorStatistics/KernelPercent
  • ProcessorStatistics/UserPercent

/redfish/v1/Managers/bmc/NetworkProtocol/

ManagerNetworkProtocol

  • Description
  • FQDN
  • HTTP
  • HTTPS
  • HostName
  • IPMI
  • NTP
  • SSH
  • Status

/redfish/v1/Managers/bmc/NetworkProtocol/HTTPS/Certificates/

CertificateCollection

/redfish/v1/Managers/bmc/NetworkProtocol/HTTPS/Certificates/{CertificateId}/

Certificate

  • CertificateString
  • Description
  • Issuer
  • KeyUsage
  • Subject
  • ValidNotAfter
  • ValidNotBefore

/redfish/v1/Managers/bmc/Truststore/Certificates/

CertificateCollection

  • Description
  • error

/redfish/v1/Registries/

MessageRegistryFileCollection

  • Description
  • Members
    • Should support Base, CommonMessages, and EventingMessages
  • [email protected]

/redfish/v1/Registries/{MessageRegistryFileId}/

MessageRegistryFile

/redfish/v1/SessionService/

SessionService

  • Description
  • ServiceEnabled
  • SessionTimeout
  • Sessions

/redfish/v1/SessionService/Sessions/

SessionCollection

/redfish/v1/SessionService/Sessions/{SessionId}/

Session

  • ClientOriginIPAddress
  • Description
  • Roles
  • UserName

/redfish/v1/Systems/

ComputerSystemCollection

/redfish/v1/Systems/system/Bios/

Bios

  • Actions
  • Description
  • Links/ActiveSoftwareImage
  • Links/SoftwareImages
  • Links/[email protected]

/redfish/v1/Systems/system/

ComputerSystem

  • 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

/redfish/v1/Systems/system/EthernetInterfaces/

EthernetInterfaceCollection

/redfish/v1/Systems/system/FabricAdapters/

FabricAdapterCollection

/redfish/v1/Systems/system/FabricAdapters/{FabricAdapterId}/

FabricAdapter

  • Location
  • Model
  • PartNumber
  • SerialNumber
  • SparePartNumber
  • Status

/redfish/v1/Systems/system/LogServices/

LogServiceCollection

/redfish/v1/Systems/system/LogServices/EventLog/

LogService

  • Actions
  • DateTime
  • DateTimeLocalOffset
  • Description
  • Entries
  • OverWritePolicy

/redfish/v1/Systems/system/LogServices/EventLog/Entries/

LogEntryCollection

/redfish/v1/Systems/system/LogServices/EventLog/Entries/{LogEntryId}/

LogEntry

  • AdditionalDataURI
  • Created
  • EntryType
  • Message
  • Modified
  • Resolved
  • Severity

/redfish/v1/Systems/system/LogServices/SEL/Entries/

LogEntryCollection

/redfish/v1/Systems/system/LogServices/SEL/Entries/{LogEntryId}/

LogEntry

  • MessageArgs
  • Severity
  • SensorType
  • Message
  • MessageId
  • Created
  • EntryCode
  • EntryType

/redfish/v1/Systems/system/Memory/

MemoryCollection

/redfish/v1/Systems/system/Memory/{MemoryId}/

Memory

  • AllowedSpeedsMHz
  • BaseModuleType
  • BusWidthBits
  • CapacityMiB
  • DataWidthBits
  • ErrorCorrection
  • FirmwareRevision
  • Manufacturer
  • Model
  • OperatingSpeedMhz
  • PartNumber
  • RankCount
  • SerialNumber
  • SparePartNumber
  • Status

/redfish/v1/Systems/system/Memory/{MemoryId}/MemoryMetrics/

MemoryMetrics

  • Description
  • HealthData

/redfish/v1/Systems/system/PCIeDevices/

PCIeDeviceCollection

/redfish/v1/Systems/system/PCIeDevices/{PCIeDevice}/

  • Manufacturer
  • Model
  • PartNumber
  • PCIeInterface
    • LanesInUse
    • MaxLanes
    • MaxPCIeType
    • PCIeType
  • SerialNumber
  • Slot
    • Lanes
    • PCIeType
    • SlotType
  • SparePartNumber
  • Status

/redfish/v1/Systems/system/Processors/

ProcessorCollection

/redfish/v1/Systems/system/Processors/{ProcessorId}/

Processor

  • InstructionSet
  • Manufacturer
  • MaxSpeedMHz
  • PartNumber
  • ProcessorArchitecture
  • ProcessorId
  • ProcessorType
  • SerialNumber
  • Socket
  • SparePartNumber
  • Status
  • ThrottleCauses
  • Throttled
  • TotalCores
  • TotalThreads
  • Version

/redfish/v1/Systems/system/ResetActionInfo/

ActionInfo

  • Parameters/AllowableValues
  • Parameters/DataType
  • Parameters/Required

/redfish/v1/Systems/system/Storage/

StorageCollection

/redfish/v1/Systems/system/Storage/{StorageId}/

Storage

/redfish/v1/Systems/system/Storage/{StorageId}/Drive/{DriveId}/

Storage

  • CapacityBytes
  • EncryptionStatus
  • Links
  • Status

/redfish/v1/TaskService/

TaskService

  • CompletedTaskOverWritePolicy
  • DateTime
  • LifeCycleEventOnTaskStateChange
  • ServiceEnabled
  • Status
  • Tasks

/redfish/v1/TaskService/Tasks/

TaskCollection

/redfish/v1/TelemetryService/

TelemetryService

  • MaxReports
  • MetricReportDefinitions
  • MetricReports
  • MinCollectionInterval
  • Status
  • Triggers
  • SupportedCollectionFunctions

/redfish/v1/TelemetryService/MetricReportDefinitions/

MetricReportDefinitionCollection

/redfish/v1/TelemetryService/MetricReportDefinitions/{MetricReportDefinitionId}/

MetricReportDefinition

  • AppendLimit
  • Id
  • MetricReport
  • MetricReportDefinitionEnabled
  • MetricReportDefinitionType
  • Metrics
  • Name
  • ReportActions
  • ReportUpdates
  • Schedule
  • Status

/redfish/v1/TelemetryService/MetricReports/

MetricReportCollection

/redfish/v1/TelemetryService/MetricReports/{MetricReportId}/

MetricReport

  • Id
  • MetricReportDefinition
  • MetricValues
  • Name
  • Timestamp

/redfish/v1/TelemetryService/Triggers/

TriggersCollection

/redfish/v1/UpdateService/

UpdateService

  • Actions
  • Description
  • FirmwareInventory
  • HttpPushUri
  • HttpPushUriOptions
  • MaxImageSizeBytes
  • ServiceEnabled

/redfish/v1/UpdateService/FirmwareInventory/

SoftwareInventoryCollection

/redfish/v1/UpdateService/FirmwareInventory/{SoftwareInventoryId}/

SoftwareInventory