summaryrefslogtreecommitdiff
path: root/Redfish.md
diff options
context:
space:
mode:
authorPatrick Williams <patrick@stwcx.xyz>2022-12-07 16:14:21 +0300
committerPatrick Williams <patrick@stwcx.xyz>2022-12-07 16:14:26 +0300
commitdfa3fdc3dc1045babc67ecd7974c4d997006d9c4 (patch)
treee2b076f0b29cf031dbada80cb9cc265e657ad7e9 /Redfish.md
parent6f284d244124c54db4d6fad6063b2aced18a844b (diff)
downloadbmcweb-dfa3fdc3dc1045babc67ecd7974c4d997006d9c4.tar.xz
format: reformat with latest openbmc-build-scripts
Reformat the repository using the latest from openbmc-build-scripts. Add the `static/redfish` directory to be ignored by prettier since these files come from elsewhere and having the ability to do a direct diff is handy. Signed-off-by: Patrick Williams <patrick@stwcx.xyz> Change-Id: I74464d6f97047b4888a591e0d8a4f5ca970ac69e
Diffstat (limited to 'Redfish.md')
-rw-r--r--Redfish.md226
1 files changed, 188 insertions, 38 deletions
diff --git a/Redfish.md b/Redfish.md
index 3d36a57089..d302f78150 100644
--- a/Redfish.md
+++ b/Redfish.md
@@ -1,20 +1,21 @@
-# Redfish #
+# Redfish
-bmcweb provides an implementation of the [Redfish][1] 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.
+bmcweb provides an implementation of the [Redfish][1] 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](https://github.com/DMTF/Redfish-Service-Validator "Validator") with
-no warnings or errors
+The redfish implementation shall pass the
+[Redfish Service Validator](https://github.com/DMTF/Redfish-Service-Validator "Validator")
+with no warnings or errors
-The following redfish schemas and fields are targeted for OpenBMC. This is a
+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](https://redfish.dmtf.org/schemas/)
+The latest Redfish schemas can be found
+[here](https://redfish.dmtf.org/schemas/)
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.
@@ -26,9 +27,10 @@ Fields common to all schemas
- Id
- Name
-
#### /redfish/v1/
+
##### ServiceRoot
+
- AccountService
- CertificateService
- Chassis
@@ -46,7 +48,9 @@ Fields common to all schemas
- UpdateService
#### /redfish/v1/AccountService/
+
##### AccountService
+
- AccountLockoutDuration
- AccountLockoutThreshold
- Accounts
@@ -63,13 +67,17 @@ Fields common to all schemas
- ServiceEnabled
#### /redfish/v1/AccountService/Accounts/
+
##### ManagerAccountCollection
+
- Description
- Members
- Members@odata.count
#### /redfish/v1/AccountService/Accounts/{ManagerAccountId}/
+
##### ManagerAccount
+
- AccountTypes
- Description
- Enabled
@@ -82,99 +90,122 @@ Fields common to all schemas
- UserName
#### /redfish/v1/AccountService/LDAP/Certificates/
+
##### CertificateCollection
+
- Description
- Members
- Members@odata.count
#### /redfish/v1/AccountService/Roles/
+
##### RoleCollection
+
- Description
- Members
- By default will contain 3 roles, "Administrator", "Operator", and "ReadOnly"
- Members@odata.count
#### /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
+ - 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.
+ - 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/CertificateService/
+
##### CertificateService
+
- Actions
- CertificateLocations
- Description
#### /redfish/v1/CertificateService/CertificateLocations/
+
##### CertificateLocations
+
- Description
- Links/Certificates
- Links/Certificates@odata.count
#### /redfish/v1/Chassis/
+
##### ChassisCollection
+
- Members
- Members@odata.count
#### /redfish/v1/Chassis/{ChassisId}/
+
##### Chassis
+
- Actions
- ChassisType
- Links/ComputerSystems
- Links/ManagedBy
- PCIeDevices
- Power
- - Shall be included if component contains voltage/current sensing
- components, otherwise will be omitted.
+ - Shall be included if component contains voltage/current sensing components,
+ otherwise will be omitted.
- PowerState
- Sensors
- Status
- Thermal
- - Shall be included if component contains temperature sensors, otherwise
- shall be omitted.
+ - Shall be included if component contains temperature sensors, otherwise shall
+ be omitted.
#### /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")
+
+- 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
- Drives@odata.count
-- Status
-(this is dependant on a entity manager association from Chassis to Drives)
+- Status (this is dependant 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
+
- Description
- Members
- Members@odata.count
#### /redfish/v1/Chassis/{ChassisId}/Sensors/{Id}/
+
##### Sensor
+
- Reading
- ReadingRangeMax
- ReadingRangeMin
@@ -184,13 +215,17 @@ Chassis to Drives, The name of the association is "chassis<->drive")
- Thresholds
#### /redfish/v1/Chassis/{ChassisId}/Thermal/
+
##### Thermal
+
- Fans
- Redundancy
- Temperatures
#### /redfish/v1/Chassis/{ChassisId}/Thermal#/Temperatures/{SensorName}/
+
##### Temperature
+
- MemberId
- Status
- ReadingCelsius
@@ -199,11 +234,13 @@ Chassis to Drives, The name of the association is "chassis<->drive")
- LowerThresholdNonCritical
- LowerThresholdCritical
- MinReadingRange
-- MaxReadingRange
-*threshold fields only present if defined for sensor, otherwise absent*
+- MaxReadingRange _threshold fields only present if defined for sensor,
+ otherwise absent_
#### /redfish/v1/Chassis/{ChassisId}/Thermal#/Fans/{FanName}/
+
##### Fan
+
- MemberId
- Status
- Reading
@@ -214,11 +251,13 @@ Chassis to Drives, The name of the association is "chassis<->drive")
- LowerThresholdCritical
- MinReadingRange
- MaxReadingRange
-- Redundancy
-*threshold fields only present if defined for sensor, otherwise absent*
+- Redundancy _threshold fields only present if defined for sensor, otherwise
+ absent_
#### /redfish/v1/Chassis/{ChassisId}/Thermal#/Redundancy/{RedundancyName}/
+
##### Redundancy
+
- MemberId
- RedundancySet
- Mode
@@ -229,14 +268,19 @@ Chassis to Drives, The name of the association is "chassis<->drive")
#### /redfish/v1/Chassis/{ChassisId}/ThermalSubsystem
##### ThermalSubsystem
+
- Status
#### /redfish/v1/Chassis/{ChassisId}/Power/
+
##### Power
+
PowerControl Voltages PowerSupplies Redundancy
#### /redfish/v1/Chassis/{ChassisId}/Power#/PowerControl/{ControlName}/
+
##### PowerControl
+
- MemberId
- PowerConsumedWatts
- PowerMetrics/IntervalInMin
@@ -247,7 +291,9 @@ PowerControl Voltages PowerSupplies Redundancy
- Should list systems and related chassis
#### /redfish/v1/Chassis/{ChassisId}/Power#/Voltages/{VoltageName}/
+
##### Voltage
+
- MemberId
- Status
- ReadingVolts
@@ -261,7 +307,9 @@ PowerControl Voltages PowerSupplies Redundancy
- RelatedItem
#### /redfish/v1/Chassis/{ChassisId}/Power#/PowerSupplies/{PSUName}/
+
##### PowerSupply
+
- MemberId
- Status
- LininputVoltage
@@ -274,7 +322,9 @@ PowerControl Voltages PowerSupplies Redundancy
- Redundancy
#### /redfish/v1/Chassis/{ChassisId}/Power#/Redundancy/{RedundancyName}/
+
##### Redundancy
+
- MemberId
- RedundancySet
- Mode
@@ -283,7 +333,9 @@ PowerControl Voltages PowerSupplies Redundancy
- MaxNumSupported
#### /redfish/v1/EventService/
+
##### EventService
+
- Actions
- DeliveryRetryAttempts
- Defaults to 3
@@ -297,12 +349,16 @@ PowerControl Voltages PowerSupplies Redundancy
- Subscriptions
#### /redfish/v1/EventService/Subscriptions/
+
##### EventDestinationCollection
+
- Members
- Members@odata.count
#### /redfish/v1/EventService/Subscriptions/{EventName}/
+
##### EventDestination
+
- Id
- Destination
- EventTypes
@@ -311,13 +367,17 @@ PowerControl Voltages PowerSupplies Redundancy
- Protocol
#### /redfish/v1/JsonSchemas/
+
##### JsonSchemaFileCollection
+
- Description
- Members@odata.count
- Members
#### /redfish/v1/JsonSchemas/{Id}/
+
##### JsonSchemaFile
+
- Schema
- Description
- Languages
@@ -326,12 +386,16 @@ PowerControl Voltages PowerSupplies Redundancy
- Location@odata.count
#### /redfish/v1/Managers/
+
##### ManagerCollection
+
- Members
- Members@odata.count
#### /redfish/v1/Managers/bmc/
+
##### Manager
+
- Actions
- DateTime
- DateTimeLocalOffset
@@ -364,13 +428,17 @@ PowerControl Voltages PowerSupplies Redundancy
- UUID
#### /redfish/v1/Managers/bmc/EthernetInterfaces/
+
##### EthernetInterfaceCollection
+
- Description
- Members
- Members@odata.count
#### /redfish/v1/Managers/bmc/EthernetInterfaces/{EthernetInterfaceId}/
+
##### EthernetInterface
+
- DHCPv4
- DHCPv6
- Description
@@ -392,7 +460,9 @@ PowerControl Voltages PowerSupplies Redundancy
- VLANs
#### /redfish/v1/Managers/bmc/EthernetInterfaces/{EthernetInterfaceId}/VLANs/
+
##### VLanNetworkInterfaceCollection
+
- Members
- Members@odata.count
@@ -404,8 +474,8 @@ 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.
+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.
@@ -420,17 +490,21 @@ with the `-DBMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES=ON` option. This will cause
bmcweb to look to [phosphor-logging][4] 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.
+These two implementations do not work together, so choosing one will disable the
+other.
#### /redfish/v1/Managers/bmc/LogServices/
+
##### LogServiceCollection
+
- Description
- Members
- Members@odata.count
#### /redfish/v1/Managers/bmc/LogServices/RedfishLog/
+
##### LogService
+
- Entries
- OverWritePolicy
- Actions
@@ -439,13 +513,17 @@ the other.
- MaxNumberOfRecords
#### /redfish/v1/Managers/bmc/LogServices/RedfishLog/Entries/{LogEntryId}/
+
##### LogEntry
+
- Message
- Created
- EntryType
#### /redfish/v1/Managers/bmc/NetworkProtocol/
+
##### ManagerNetworkProtocol
+
- Description
- FQDN
- HTTP
@@ -457,13 +535,17 @@ the other.
- Status
#### /redfish/v1/Managers/bmc/NetworkProtocol/HTTPS/Certificates/
+
##### CertificateCollection
+
- Description
- Members
- Members@odata.count
#### /redfish/v1/Managers/bmc/NetworkProtocol/HTTPS/Certificates/{CertificateId}/
+
##### Certificate
+
- CertificateString
- Description
- Issuer
@@ -473,20 +555,25 @@ the other.
- ValidNotBefore
#### /redfish/v1/Managers/bmc/Truststore/Certificates/
+
##### CertificateCollection
+
- Description
- error
-
#### /redfish/v1/Registries/
+
##### MessageRegistryFileCollection
+
- Description
- Members
- Should support Base, CommonMessages, and EventingMessages
- Members@odata.count
#### /redfish/v1/Registries/{MessageRegistryFileId}/
+
##### MessageRegistryFile
+
- Description
- Languages
- Languages@odata.count
@@ -495,33 +582,43 @@ the other.
- Registry
#### /redfish/v1/SessionService/
+
##### SessionService
+
- Description
- ServiceEnabled
- SessionTimeout
- Sessions
#### /redfish/v1/SessionService/Sessions/
+
##### SessionCollection
+
- Description
- Members
- Members@odata.count
#### /redfish/v1/SessionService/Sessions/{SessionId}/
+
##### Session
+
- ClientOriginIPAddress
- Description
- Oem
- UserName
#### /redfish/v1/Systems/
+
##### ComputerSystemCollection
+
- Members
- Should support one system
- Members@odata.count
#### /redfish/v1/Systems/system/Bios/
+
##### Bios
+
- Actions
- Description
- Links/ActiveSoftwareImage
@@ -529,7 +626,9 @@ the other.
- Links/SoftwareImages@odata.count
#### /redfish/v1/Systems/system/
+
##### ComputerSystem
+
- Actions
- AssetTag
- Bios
@@ -566,20 +665,26 @@ the other.
- SystemType
#### /redfish/v1/Systems/system/EthernetInterfaces/
+
##### EthernetInterfaceCollection
+
- Members
- Members@odata.count
- Description
#### /redfish/v1/Systems/system/LogServices/
+
##### LogServiceCollection
+
- Description
- Members
- Should default to one member, named SEL
- Members@odata.count
#### /redfish/v1/Systems/system/LogServices/EventLog/
+
##### LogService
+
- Actions
- DateTime
- DateTimeLocalOffset
@@ -588,13 +693,17 @@ the other.
- OverWritePolicy
#### /redfish/v1/Systems/system/LogServices/EventLog/Entries/
+
##### LogEntryCollection
+
- Description
- Members
- Members@odata.count
#### /redfish/v1/Systems/system/LogServices/EventLog/Entries/{LogEntryId}/
+
##### LogEntry
+
- AdditionalDataURI
- Created
- EntryType
@@ -604,14 +713,18 @@ the other.
- Severity
#### /redfish/v1/Systems/system/LogServices/SEL/Entries/
+
##### LogEntryCollection
+
- Members
- Members@odata.count
- Description
- @odata.nextLink
#### /redfish/v1/Systems/system/LogServices/SEL/Entries/{LogEntryId}/
+
##### LogEntry
+
- MessageArgs
- Severity
- SensorType
@@ -622,12 +735,16 @@ the other.
- EntryType
#### /redfish/v1/Systems/system/Memory/
+
##### MemoryCollection
+
- Members
- Members@odata.count
#### /redfish/v1/Systems/system/Memory/{MemoryId}/
+
##### Memory
+
- AllowedSpeedsMHz
- BaseModuleType
- BusWidthBits
@@ -645,24 +762,32 @@ the other.
- Status
#### /redfish/v1/Systems/system/Memory/{MemoryId}/MemoryMetrics/
+
##### MemoryMetrics
+
- Description
- HealthData
#### /redfish/v1/Systems/system/PCIeDevices/
+
##### PCIeDeviceCollection
+
- Description
- Members
- Members@odata.count
#### /redfish/v1/Systems/system/Processors/
+
##### ProcessorCollection
+
- Members
- Should Support CPU1 and CPU2 for dual socket systems
- Members@odata.count
#### /redfish/v1/Systems/system/Processors/{ProcessorId}/
+
##### Processor
+
- InstructionSet
- Manufacturer
- MaxSpeedMHz
@@ -679,24 +804,32 @@ the other.
- Version
#### /redfish/v1/Systems/system/Storage/
+
##### StorageCollection
+
- Members
- Members@odata.count
#### /redfish/v1/Systems/system/Storage/{StorageId}/
+
##### Storage
+
- Drives
- Drives@odata.count
- Status
#### /redfish/v1/Systems/system/Storage/{StorageId}/Drive/{DriveId}/
+
##### Storage
+
- CapacityBytes
- Links
- Status
#### /redfish/v1/TaskService/
+
##### TaskService
+
- CompletedTaskOverWritePolicy
- DateTime
- LifeCycleEventOnTaskStateChange
@@ -705,12 +838,16 @@ the other.
- Tasks
#### /redfish/v1/TaskService/Tasks/
+
##### TaskCollection
+
- Members
- Members@odata.count
#### /redfish/v1/TelemetryService/
+
##### TelemetryService
+
- MaxReports
- MetricReportDefinitions
- MetricReports
@@ -719,22 +856,30 @@ the other.
- Triggers
#### /redfish/v1/TelemetryService/MetricReportDefinitions/
+
##### MetricReportDefinitionCollection
+
- Members
- Members@odata.count
#### /redfish/v1/TelemetryService/MetricReports/
+
##### MetricReportCollection
+
- Members
- Members@odata.count
#### /redfish/v1/TelemetryService/Triggers/
+
##### TriggersCollection
+
- Members
- Members@odata.count
#### /redfish/v1/UpdateService/
+
##### UpdateService
+
- Actions
- Description
- FirmwareInventory
@@ -744,13 +889,17 @@ the other.
- ServiceEnabled
#### /redfish/v1/UpdateService/FirmwareInventory/
+
##### SoftwareInventoryCollection
+
- Members
- Should Support BMC, ME, CPLD and BIOS
- Members@odata.count
#### /redfish/v1/UpdateService/FirmwareInventory/{SoftwareInventoryId}/
+
##### SoftwareInventory
+
- Description
- RelatedItem@odata.count
- RelatedItem
@@ -760,5 +909,6 @@ the other.
[1]: https://www.dmtf.org/standards/redfish
[2]: https://redfish.dmtf.org/schemas/v1/LogService.json
-[3]: https://github.com/openbmc/docs/blob/master/architecture/redfish-logging-in-bmcweb.md
+[3]:
+ https://github.com/openbmc/docs/blob/master/architecture/redfish-logging-in-bmcweb.md
[4]: https://github.com/openbmc/phosphor-logging