bmcweb/docs/Redfish.md

3 bmcweb provides an implementation of the [Redfish][1] API. This document details
5 the details of that implementation and different implementations available for
10 The redfish implementation shall pass the [Redfish Service Validator][2] with no
23 - @odata.id
24 - @odata.type
25 - Id
26 - Name
32 - AccountService
33 - AggregationService
34 - Cables
35 - CertificateService
36 - Chassis
37 - EventService
38 - JsonSchemas
39 - Links/ManagerProvidingService
40 - Links/Sessions
41 - Managers
42 - RedfishVersion
43 - Registries
44 - ServiceIdentification
45 - SessionService
46 - Systems
47 - Tasks
48 - TelemetryService
49 - UUID
50 - UpdateService
56 - AccountLockoutDuration
57 - AccountLockoutThreshold
58 - Accounts
59 - Description
60 - HTTPBasicAuth
61 - LDAP
62 - MaxPasswordLength
63 - MinPasswordLength
64 - MultiFactorAuth/ClientCertificate/Certificates
65 - MultiFactorAuth/ClientCertificate/CertificateMappingAttribute
66 - MultiFactorAuth/ClientCertificate/Enabled
67 - MultiFactorAuth/ClientCertificate/RespondToUnauthenticatedClients
68 - Oem/OpenBMC/AuthMethods/BasicAuth
69 - Oem/OpenBMC/AuthMethods/Cookie
70 - Oem/OpenBMC/AuthMethods/SessionToken
71 - Oem/OpenBMC/AuthMethods/TLS
72 - Oem/OpenBMC/AuthMethods/XToken
73 - Roles
74 - ServiceEnabled
78 - Members
79 - `Members@odata.count`
83 - CertificateString
84 - Id
85 - Issuer/City
86 - Issuer/CommonName
87 - Issuer/Country
88 - Issuer/Organization
89 - Issuer/OrganizationalUnit
90 - Issuer/State
91 - KeyUsage
92 - Subject/City
93 - Subject/Country
94 - Subject/CommonName
95 - Subject/Organization
96 - Subject/OrganizationalUnit
97 - Subject/State
98 - ValidNotAfter
99 - ValidNotBefore
105 - AggregationSources
106 - Description
107 - ServiceEnabled
113 - Members
114 - `Members@odata.count`
120 - HostName
121 - Password
127 - Description
128 - Members
129 - `Members@odata.count`
135 - AccountTypes
136 - Description
137 - Enabled
138 - Links/Role
139 - Locked
140 - `Locked@Redfish.AllowableValues`
141 - Password
142 - PasswordChangeRequired
143 - RoleId
144 - StrictAccountTypes
145 - UserName
151 - Description
152 - Members
153 - `Members@odata.count`
159 - Description
160 - Members
161   - By default will contain 3 roles, "Administrator", "Operator", and "ReadOnly"
162 - `Members@odata.count`
168 - AssignedPrivileges
169   - For the default roles, the following privileges will be assigned by default
170     - Administrator: Login, ConfigureManager, ConfigureUsers, ConfigureSelf,
172     - Operator: Login, ConfigureComponents, ConfigureSelf
173     - ReadOnly: Login, ConfigureSelf
174 - Description
175 - IsPredefined
176   - Will be set to true for all default roles. If the given role is non-default,
178 - OemPrivileges
179 - RoleId
185 - Description
186 - Members
187 - `Members@odata.count`
193 - CableType
194 - LengthMeters
195 - Status
201 - Actions
202 - CertificateLocations
203 - Description
209 - Description
210 - Links/Certificates
211 - Links/Certificates@odata.count
217 - Members
218 - `Members@odata.count`
224 - Actions
225 - AssetTag
226 - ChassisType
227 - Drives
228 - HotPluggable
229 - Links/ComputerSystems
230 - Links/ManagedBy
231 - Location/PartLocation/ServiceLabel
232 - LocationIndicatorActive
233 - Manufacturer
234 - Model
235 - PartNumber
236 - Power
237 - PowerSubsystem
238 - PowerState
239 - PhysicalSecurity
240 - Sensors
241 - SerialNumber
242 - SparePartNumber
243 - Status
244 - Thermal
245 - ThermalSubsystem
246 - UUID
247 - Version
253 - Members (This is dependent on a entity manager association from Chassis to
254   Drives, The name of the association is `chassis<->drive`)
260 - Drives
261 - `Drives@odata.count`
262 - Status (this is dependent on a entity manager association from Chassis to
269 - PowerWatts/DataSourceUri
270 - PowerWatts/Reading
276 - PowerControl
277 - PowerSupplies
278 - Redundancy
279 - Voltages
285 - Description
286 - Members
287 - `Members@odata.count`
293 - Implementation
294 - Reading
295 - ReadingBasis
296 - ReadingRangeMax
297 - ReadingRangeMin
298 - ReadingType
299 - ReadingUnits
300 - SpeedRPM
301 - Status
302 - Thresholds
308 - Fans
309 - Redundancy
310 - Temperatures
316 - MemberId
317 - Status
318 - ReadingCelsius
319 - UpperThresholdNonCritical
320 - UpperThresholdCritical
321 - LowerThresholdNonCritical
322 - LowerThresholdCritical
323 - MinReadingRange
324 - MaxReadingRange _threshold fields only present if defined for sensor,
331 - MemberId
332 - Status
333 - Reading
334 - ReadingUnits
335 - UpperThresholdNonCritical
336 - UpperThresholdCritical
337 - LowerThresholdNonCritical
338 - LowerThresholdCritical
339 - MinReadingRange
340 - MaxReadingRange
341 - Redundancy _threshold fields only present if defined for sensor, otherwise
348 - MemberId
349 - RedundancySet
350 - Mode
351 - Status
352 - MinNumNeeded
353 - MaxNumSupported
359 - Status
360 - ThermalMetrics
366 - TemperatureReadingsCelsius[]/DataSourceUri
367 - TemperatureReadingsCelsius[]/Reading
368 - `TemperatureReadingsCelsius@odata.count`
374 - Description
375 - Members
376 - `Members@odata.count`
382 - Location
383 - LocationIndicatorActive
384 - Manufacturer
385 - Model
386 - PartNumber
387 - SerialNumber
388 - SparePartNumber
389 - Status
395 - MemberId
396 - PowerConsumedWatts
397 - PowerMetrics/IntervalInMin
398 - PowerMetrics/MinConsumedWatts
399 - PowerMetrics/MaxConsumedWatts
400 - PowerMetrics/AverageConsumedWatts
401 - RelatedItem
402   - Should list systems and related chassis
408 - MemberId
409 - Status
410 - ReadingVolts
411 - UpperThresholdNonCritical
412 - UpperThresholdCritical
413 - LowerThresholdNonCritical
414 - LowerThresholdCritical
415 - MinReadingRange
416 - MaxReadingRange
417 - PhysicalContext
418 - RelatedItem
424 - MemberId
425 - Status
426 - LininputVoltage
427 - Model
428 - manufacturer
429 - FirmwareVersion
430 - SerialNumber
431 - PartNumber
432 - RelatedItem
433 - Redundancy
439 - MemberId
440 - RedundancySet
441 - Mode
442 - Status
443 - MinNumNeeded
444 - MaxNumSupported
450 - Description
451 - Members
452 - `Members@odata.count`
458 - EfficiencyRatings
459   - EfficiencyPercent
460 - FirmwareVersion
461 - Location
462 - LocationIndicatorActive
463 - Manufacturer
464 - Model
465 - PartNumber
466 - SerialNumber
467 - SparePartNumber
468 - Status
474 - Assemblies
475 - `Assemblies@odata.count`
479 - Model
480 - PartNumber
481 - SerialNumber
482 - SparePartNumber
488 - Actions
489 - SubmitTestEvent
490   - eventGroupId
491   - eventId
492   - eventTimestamp
493   - message
494   - messageArgs
495   - messageId
496   - originOfCondition
497   - resolution
498   - severity
499 - DeliveryRetryAttempts
500   - Defaults to 3
501 - DeliveryRetryIntervalSeconds
502 - EventFormatTypes
503 - RegistryPrefixes
504 - ResourceTypes
505 - SSEFilterPropertiesSupported
506 - ServiceEnabled
507 - Status
508 - Subscriptions
514 - Members
515 - `Members@odata.count`
521 - Id
522 - Destination
523 - EventTypes
524 - Context
525 - HeartbeatIntervalMinutes
526 - OriginResources
527 - RegistryPrefixes
528 - Protocol
529 - SendHeartbeat
535 - Description
536 - `Members@odata.count`
537 - Members
543 - Schema
544 - Description
545 - Languages
546 - `Languages@odata.count`
547 - Location
548 - `Location@odata.count`
554 - Members
555 - `Members@odata.count`
561 - Actions
562 - DateTime
563 - DateTimeLocalOffset
564 - Description
565 - EthernetInterfaces
566 - FirmwareVersion
567 - GraphicalConsole
568 - LastResetTime
569 - Links/ActiveSoftwareImage
570 - Links/ManagerForChassis
571 - Links/ManagerForChassis@odata.count
572 - Links/ManagerForServers
573 - Links/ManagerForServers@odata.count
574 - Links/ManagerInChassis
575 - Links/SoftwareImages
576 - Links/SoftwareImages@odata.count
577 - LocationIndicatorActive
578 - LogServices
579 - ManagerType
580 - Manufacturer
581 - Model
582 - NetworkProtocol
583 - Oem
584 - PartNumber
585 - PowerState
586 - SerialNumber
587 - ServiceEntryPointUUID
588 - ServiceIdentification
589 - SparePartNumber
590 - Status
591 - UUID
597 - Description
598 - Members
599 - `Members@odata.count`
605 - DHCPv4
606 - DHCPv6
607 - Description
608 - EthernetInterfaceType
609 - FQDN
610 - HostName
611 - IPv4Addresses
612 - IPv4StaticAddresses
613 - IPv6AddressPolicyTable
614 - IPv6Addresses
615 - IPv6DefaultGateway
616 - IPv6StaticAddresses
617 - IPv6StaticDefaultGateways
618 - InterfaceEnabled
619 - Links/RelatedInterfaces
620 - LinkStatus
621 - MACAddress
622 - NameServers
623 - SpeedMbps
624 - StatelessAddressAutoConfig
625 - StaticNameServers
626 - Status
627 - VLAN/VLANEnable
628 - VLAN/VLANId
629 - VLAN/Tagged
640 `Event` type. This is the new Redfish-defined type.
645 The default implementation uses rsyslog to write Redfish events from the journal
650 The other implementation of EventLog Entries can be enabled by compiling bmcweb
651 with the `-DBMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES=ON` option. This will cause
652 bmcweb to look to [phosphor-logging][6] for any D-Bus log entries. These will
660 `-DBMCWEB_REDFISH_EVENTLOG_LOCATION=managers` option flag. Apart from the
662 functions the same like the default implementation under the System resource.
666 - Description
667 - Members
668 - `Members@odata.count`
674 - Entries
675 - OverWritePolicy
676 - Actions
677 - Status
678 - DateTime
679 - MaxNumberOfRecords
685 - Message
686 - Created
687 - EntryType
693 - ServiceRootUptimeSeconds
694 - FreeStorageSpaceKiB
695 - MemoryStatistics/AvailableBytes
696 - MemoryStatistics/BuffersAndCacheBytes
697 - MemoryStatistics/FreeBytes
698 - MemoryStatistics/SharedBytes
699 - MemoryStatistics/TotalBytes
700 - ProcessorStatistics/KernelPercent
701 - ProcessorStatistics/UserPercent
707 - Description
708 - FQDN
709 - HTTP
710 - HTTPS
711 - HostName
712 - IPMI
713 - NTP
714 - SSH
715 - Status
721 - Description
722 - Members
723 - `Members@odata.count`
729 - CertificateString
730 - Description
731 - Issuer
732 - KeyUsage
733 - Subject
734 - ValidNotAfter
735 - ValidNotBefore
741 - Description
742 - error
748 - Description
749 - Members
750   - Should support Base, CommonMessages, and EventingMessages
751 - `Members@odata.count`
757 - Description
758 - Languages
759 - `Languages@odata.count`
760 - Location
761 - `Location@odata.count`
762 - Registry
768 - Description
769 - ServiceEnabled
770 - SessionTimeout
771 - Sessions
777 - Description
778 - Members
779 - `Members@odata.count`
785 - ClientOriginIPAddress
786 - Description
787 - Roles
788 - UserName
794 - Members
795   - Should support one system
796 - `Members@odata.count`
802 - Actions
803 - Description
804 - Links/ActiveSoftwareImage
805 - Links/SoftwareImages
806 - Links/SoftwareImages@odata.count
812 - Actions
813 - AssetTag
814 - Bios
815 - BiosVersion
816 - Boot
817 - BootProgress
818 - Description
819 - FabricAdapters
820 - HostWatchdogTimer
821 - IdlePowerSaver/Enable
822 - IdlePowerSaver/EnterUtilizationPercent
823 - IdlePowerSaver/EnterDwellTimeSeconds
824 - IdlePowerSaver/ExitUtilizationPercent
825 - IdlePowerSaver/ExitDwellTimeSeconds
826 - IndicatorLED
827 - LastResetTime
828 - Links/Chassis
829 - Links/ManagedBy
830 - LocationIndicatorActive
831 - LogServices
832 - Manufacturer
833 - Memory
834 - MemorySummary
835 - Model
836 - PCIeDevices
837 - PartNumber
838 - PowerMode
839 - PowerRestorePolicy
840 - PowerState
841 - ProcessorSummary
842 - Processors
843 - SerialConsole/IPMI/ServiceEnabled
844 - SerialConsole/MaxConcurrentSessions
845 - SerialConsole/SSH/HotKeySequenceDisplay
846 - SerialConsole/SSH/Port
847 - SerialConsole/SSH/ServiceEnabled
848 - SerialNumber
849 - Status
850 - Storage
851 - SubModel
852 - SystemType
858 - Members
859 - `Members@odata.count`
860 - Description
866 - Members
867 - `Members@odata.count`
873 - Location
874 - LocationIndicatorActive
875 - Model
876 - PartNumber
877 - Ports
878 - SerialNumber
879 - SparePartNumber
880 - Status
886 - Members
887 - `Members@odata.count`
893 - Location
894 - LocationIndicatorActive
895 - Status
901 - Description
902 - Members
903   - Should default to one member, named SEL
904 - `Members@odata.count`
910 - Actions
911 - DateTime
912 - DateTimeLocalOffset
913 - Description
914 - Entries
915 - OverWritePolicy
921 - Description
922 - Members
923 - `Members@odata.count`
929 - AdditionalDataURI
930 - Created
931 - EntryType
932 - Message
933 - Modified
934 - Resolved
935 - Severity
941 - Members
942 - `Members@odata.count`
943 - Description
944 - @odata.nextLink
950 - MessageArgs
951 - Severity
952 - SensorType
953 - Message
954 - MessageId
955 - Created
956 - EntryCode
957 - EntryType
963 - Members
964 - `Members@odata.count`
970 - AllowedSpeedsMHz
971 - BaseModuleType
972 - BusWidthBits
973 - CapacityMiB
974 - DataWidthBits
975 - ErrorCorrection
976 - FirmwareRevision
977 - LocationIndicatorActive
978 - Manufacturer
979 - Model
980 - OperatingSpeedMhz
981 - PartNumber
982 - RankCount
983 - SerialNumber
984 - SparePartNumber
985 - Status
991 - Description
992 - HealthData
998 - Description
999 - Members
1000 - `Members@odata.count`
1004 - Links/Processors
1005 - `Links/Processors@odata.count`
1006 - Manufacturer
1007 - Model
1008 - PartNumber
1009 - PCIeInterface
1010   - LanesInUse
1011   - MaxLanes
1012   - MaxPCIeType
1013   - PCIeType
1014 - SerialNumber
1015 - Slot
1016   - Lanes
1017   - PCIeType
1018   - SlotType
1019 - SparePartNumber
1020 - Status
1026 - Members
1027   - Should Support CPU1 and CPU2 for dual socket systems
1028 - `Members@odata.count`
1034 - InstructionSet
1035 - LocationIndicatorActive
1036 - Manufacturer
1037 - MaxSpeedMHz
1038 - PartNumber
1039 - ProcessorArchitecture
1040 - ProcessorId
1041 - ProcessorType
1042 - SerialNumber
1043 - Socket
1044 - SparePartNumber
1045 - Status
1046 - ThrottleCauses
1047 - Throttled
1048 - TotalCores
1049 - TotalThreads
1050 - Version
1056 - Parameters/AllowableValues
1057 - Parameters/DataType
1058 - Parameters/Required
1064 - Members
1065 - `Members@odata.count`
1071 - Drives
1072 - `Drives@odata.count`
1073 - Status
1079 - CapacityBytes
1080 - EncryptionStatus
1081 - Links
1082 - Status
1088 - CompletedTaskOverWritePolicy
1089 - DateTime
1090 - LifeCycleEventOnTaskStateChange
1091 - ServiceEnabled
1092 - Status
1093 - Tasks
1099 - Members
1100 - `Members@odata.count`
1106 - MaxReports
1107 - MetricReportDefinitions
1108 - MetricReports
1109 - MinCollectionInterval
1110 - Status
1111 - Triggers
1112 - SupportedCollectionFunctions
1118 - Members
1119 - `Members@odata.count`
1125 - AppendLimit
1126 - Id
1127 - MetricReport
1128 - MetricReportDefinitionEnabled
1129 - MetricReportDefinitionType
1130 - Metrics
1131 - Name
1132 - ReportActions
1133 - ReportUpdates
1134 - Schedule
1135 - Status
1141 - Members
1142 - `Members@odata.count`
1148 - Id
1149 - MetricReportDefinition
1150 - MetricValues
1151 - Name
1152 - Timestamp
1158 - Members
1159 - `Members@odata.count`
1165 - Actions
1166 - Description
1167 - FirmwareInventory
1168 - HttpPushUri
1169 - HttpPushUriOptions
1170 - MaxImageSizeBytes
1171 - MultipartHttpPushUri
1172 - ServiceEnabled
1178 - Members
1179   - Should Support BMC, ME, CPLD and BIOS
1180 - `Members@odata.count`
1186 - Description
1187 - LowestSupportedVersion
1188 - `RelatedItem@odata.count`
1189 - RelatedItem
1190 - Status
1191 - Updateable
1192 - Version
1195 [2]: https://github.com/DMTF/Redfish-Service-Validator
1199   https://github.com/openbmc/docs/blob/master/architecture/redfish-logging-in-bmcweb.md
1200 [6]: https://github.com/openbmc/phosphor-logging