xref: /openbmc/bmcweb/Redfish.md (revision e610b3168321eee167271e4532c37fe1ed9c6f56)
1# Redfish
2
3bmcweb provides an implementation of the [Redfish][1] API. This document details
4the Redfish schemas supported by bmcweb. This document also discusses some of
5the details of that implementation and different implementations available for
6certain areas.
7
8## Redfish Schema
9
10The redfish implementation shall pass the
11[Redfish Service Validator](https://github.com/DMTF/Redfish-Service-Validator "Validator")
12with no warnings or errors
13
14The following redfish schemas and fields are targeted for OpenBMC. This is a
15living document, and these schemas are subject to change.
16
17The latest Redfish schemas can be found
18[here](https://redfish.dmtf.org/schemas/)
19
20If using a previously unused schema, you will need to add it to the included
21schema list in `scripts/update_schemas.py` and run `update_schemas.py`.
22
23Fields common to all schemas
24
25- @odata.id
26- @odata.type
27- Id
28- Name
29
30### /redfish/v1/
31
32#### ServiceRoot
33
34- AccountService
35- AggregationService
36- Cables
37- CertificateService
38- Chassis
39- EventService
40- JsonSchemas
41- Links/ManagerProvidingService
42- Links/Sessions
43- Managers
44- RedfishVersion
45- Registries
46- SessionService
47- Systems
48- Tasks
49- TelemetryService
50- UUID
51- UpdateService
52
53### /redfish/v1/AccountService/
54
55#### AccountService
56
57- AccountLockoutDuration
58- AccountLockoutThreshold
59- Accounts
60- Description
61- LDAP
62- MaxPasswordLength
63- MinPasswordLength
64- Oem/OpenBMC/AuthMethods/BasicAuth
65- Oem/OpenBMC/AuthMethods/Cookie
66- Oem/OpenBMC/AuthMethods/SessionToken
67- Oem/OpenBMC/AuthMethods/TLS
68- Oem/OpenBMC/AuthMethods/XToken
69- Roles
70- ServiceEnabled
71
72### /redfish/v1/AggregationService/
73
74#### AggregationService
75
76- AggregationSources
77- Description
78- ServiceEnabled
79
80### /redfish/v1/AggregationService/AggregationSources
81
82#### AggregationSourceCollection
83
84- Members
85- Members@odata.count
86
87### /redfish/v1/AggregationService/AggregationSources/{AggregationSourceId}
88
89#### AggregationSource
90
91- HostName
92- Password
93
94### /redfish/v1/AccountService/Accounts/
95
96#### ManagerAccountCollection
97
98- Description
99- Members
100- Members@odata.count
101
102### /redfish/v1/AccountService/Accounts/{ManagerAccountId}/
103
104#### ManagerAccount
105
106- AccountTypes
107- Description
108- Enabled
109- Links/Role
110- Locked
111- Locked@Redfish.AllowableValues
112- Password
113- PasswordChangeRequired
114- RoleId
115- StrictAccountTypes
116- UserName
117
118### /redfish/v1/AccountService/LDAP/Certificates/
119
120#### CertificateCollection
121
122- Description
123- Members
124- Members@odata.count
125
126### /redfish/v1/AccountService/Roles/
127
128#### RoleCollection
129
130- Description
131- Members
132  - By default will contain 3 roles, "Administrator", "Operator", and "ReadOnly"
133- Members@odata.count
134
135### /redfish/v1/AccountService/Roles/{RoleId}/
136
137#### Role
138
139- AssignedPrivileges
140  - For the default roles, the following privileges will be assigned by default
141    - Administrator: Login, ConfigureManager, ConfigureUsers, ConfigureSelf,
142      ConfigureComponents
143    - Operator: Login, ConfigureComponents, ConfigureSelf
144    - ReadOnly: Login, ConfigureSelf
145- Description
146- IsPredefined
147  - Will be set to true for all default roles. If the given role is non-default,
148    or has been modified from default, will be marked as false.
149- OemPrivileges
150- RoleId
151
152### /redfish/v1/Cables/
153
154#### CableCollection
155
156- Description
157- Members
158- Members@odata.count
159
160### /redfish/v1/Cables/{CableId}/
161
162#### Cable
163
164- CableType
165- LengthMeters
166- Status
167
168### /redfish/v1/CertificateService/
169
170#### CertificateService
171
172- Actions
173- CertificateLocations
174- Description
175
176### /redfish/v1/CertificateService/CertificateLocations/
177
178#### CertificateLocations
179
180- Description
181- Links/Certificates
182- Links/Certificates@odata.count
183
184### /redfish/v1/Chassis/
185
186#### ChassisCollection
187
188- Members
189- Members@odata.count
190
191### /redfish/v1/Chassis/{ChassisId}/
192
193#### Chassis
194
195- Actions
196- ChassisType
197- HotPluggable
198- Links/ComputerSystems
199- Links/ManagedBy
200- PCIeDevices
201- Power
202  - Shall be included if component contains voltage/current sensing components,
203    otherwise will be omitted.
204- PowerState
205- Sensors
206- Status
207- Thermal
208  - Shall be included if component contains temperature sensors, otherwise shall
209    be omitted.
210
211### /redfish/v1/Chassis/{ChassisId}/Drive/
212
213#### Drive
214
215- Members (This is dependent on a entity manager association from Chassis to
216  Drives, The name of the association is `chassis<->drive`)
217
218### /redfish/v1/Chassis/{ChassisId}/Drive/{DriveId}/
219
220#### Drive
221
222- Drives
223- Drives@odata.count
224- Status (this is dependent on a entity manager association from Chassis to
225  Drives)
226
227### /redfish/v1/Chassis/{ChassisId}/EnvironmentMetrics/
228
229#### EnvironmentMetrics
230
231### /redfish/v1/Chassis/{ChassisId}/Power/
232
233#### Power
234
235- PowerControl
236- PowerSupplies
237- Redundancy
238- Voltages
239
240### /redfish/v1/Chassis/{ChassisId}/Sensors/
241
242#### SensorCollection
243
244- Description
245- Members
246- Members@odata.count
247
248### /redfish/v1/Chassis/{ChassisId}/Sensors/{Id}/
249
250#### Sensor
251
252- Reading
253- ReadingRangeMax
254- ReadingRangeMin
255- ReadingType
256- ReadingUnits
257- Status
258- Thresholds
259
260### /redfish/v1/Chassis/{ChassisId}/Thermal/
261
262#### Thermal
263
264- Fans
265- Redundancy
266- Temperatures
267
268### /redfish/v1/Chassis/{ChassisId}/Thermal#/Temperatures/{SensorName}/
269
270#### Temperature
271
272- MemberId
273- Status
274- ReadingCelsius
275- UpperThresholdNonCritical
276- UpperThresholdCritical
277- LowerThresholdNonCritical
278- LowerThresholdCritical
279- MinReadingRange
280- MaxReadingRange _threshold fields only present if defined for sensor,
281  otherwise absent_
282
283### /redfish/v1/Chassis/{ChassisId}/Thermal#/Fans/{FanName}/
284
285#### Fan
286
287- MemberId
288- Status
289- Reading
290- ReadingUnits
291- UpperThresholdNonCritical
292- UpperThresholdCritical
293- LowerThresholdNonCritical
294- LowerThresholdCritical
295- MinReadingRange
296- MaxReadingRange
297- Redundancy _threshold fields only present if defined for sensor, otherwise
298  absent_
299
300### /redfish/v1/Chassis/{ChassisId}/Thermal#/Redundancy/{RedundancyName}/
301
302#### Redundancy
303
304- MemberId
305- RedundancySet
306- Mode
307- Status
308- MinNumNeeded
309- MaxNumSupported
310
311### /redfish/v1/Chassis/{ChassisId}/ThermalSubsystem
312
313#### ThermalSubsystem
314
315- Status
316- ThermalMetrics
317
318#### /redfish/v1/Chassis/{ChassisId}/ThermalSubsystem/ThermalMetrics/
319
320##### ThermalMetrics
321
322#### /redfish/v1/Chassis/{ChassisId}/ThermalSubsystem/Fans
323
324##### FansCollection
325
326- Description
327- Members
328- Members@odata.count
329
330#### /redfish/v1/Chassis/{ChassisId}/ThermalSubsystem/Fans/{FanName}/
331
332#### Fan
333
334- Location
335- Manufacturer
336- Model
337- PartNumber
338- SerialNumber
339- SparePartNumber
340- Status
341
342### /redfish/v1/Chassis/{ChassisId}/Power#/PowerControl/{ControlName}/
343
344#### PowerControl
345
346- MemberId
347- PowerConsumedWatts
348- PowerMetrics/IntervalInMin
349- PowerMetrics/MinConsumedWatts
350- PowerMetrics/MaxConsumedWatts
351- PowerMetrics/AverageConsumedWatts
352- RelatedItem
353  - Should list systems and related chassis
354
355### /redfish/v1/Chassis/{ChassisId}/Power#/Voltages/{VoltageName}/
356
357#### Voltage
358
359- MemberId
360- Status
361- ReadingVolts
362- UpperThresholdNonCritical
363- UpperThresholdCritical
364- LowerThresholdNonCritical
365- LowerThresholdCritical
366- MinReadingRange
367- MaxReadingRange
368- PhysicalContext
369- RelatedItem
370
371### /redfish/v1/Chassis/{ChassisId}/Power#/PowerSupplies/{PSUName}/
372
373#### PowerSupply
374
375- MemberId
376- Status
377- LininputVoltage
378- Model
379- manufacturer
380- FirmwareVersion
381- SerialNumber
382- PartNumber
383- RelatedItem
384- Redundancy
385
386### /redfish/v1/Chassis/{ChassisId}/Power#/Redundancy/{RedundancyName}/
387
388#### Redundancy
389
390- MemberId
391- RedundancySet
392- Mode
393- Status
394- MinNumNeeded
395- MaxNumSupported
396
397#### /redfish/v1/Chassis/{ChassisId}/PowerSubsystem/PowerSupplies
398
399##### PowerSupplies
400
401- Description
402- Members
403- Members@odata.count
404
405#### /redfish/v1/Chassis/{ChassisId}/PowerSubsystem/PowerSupplies/{PowerSupplyId}
406
407##### PowerSupply
408
409- EfficiencyRatings
410  - EfficiencyPercent
411- FirmwareVersion
412- Location
413- Manufacturer
414- Model
415- PartNumber
416- SerialNumber
417- SparePartNumber
418- Status
419
420### /redfish/v1/EventService/
421
422#### EventService
423
424- Actions
425- DeliveryRetryAttempts
426  - Defaults to 3
427- DeliveryRetryIntervalSeconds
428- EventFormatTypes
429- RegistryPrefixes
430- ResourceTypes
431- SSEFilterPropertiesSupported
432- ServiceEnabled
433- Status
434- Subscriptions
435
436### /redfish/v1/EventService/Subscriptions/
437
438#### EventDestinationCollection
439
440- Members
441- Members@odata.count
442
443### /redfish/v1/EventService/Subscriptions/{EventName}/
444
445#### EventDestination
446
447- Id
448- Destination
449- EventTypes
450- Context
451- OriginResources
452- Protocol
453
454### /redfish/v1/JsonSchemas/
455
456#### JsonSchemaFileCollection
457
458- Description
459- Members@odata.count
460- Members
461
462### /redfish/v1/JsonSchemas/{Id}/
463
464#### JsonSchemaFile
465
466- Schema
467- Description
468- Languages
469- Languages@odata.count
470- Location
471- Location@odata.count
472
473### /redfish/v1/Managers/
474
475#### ManagerCollection
476
477- Members
478- Members@odata.count
479
480### /redfish/v1/Managers/bmc/
481
482#### Manager
483
484- Actions
485- DateTime
486- DateTimeLocalOffset
487- Description
488- EthernetInterfaces
489- FirmwareVersion
490- GraphicalConsole
491- LastResetTime
492- Links/ActiveSoftwareImage
493- Links/ManagerForChassis
494- Links/ManagerForChassis@odata.count
495- Links/ManagerForServers
496- Links/ManagerForServers@odata.count
497- Links/ManagerInChassis
498- Links/SoftwareImages
499- Links/SoftwareImages@odata.count
500- LogServices
501- ManagerType
502- Manufacturer
503- Model
504- NetworkProtocol
505- Oem
506- PartNumber
507- PowerState
508- SerialConsole
509- SerialNumber
510- ServiceEntryPointUUID
511- SparePartNumber
512- Status
513- UUID
514
515### /redfish/v1/Managers/bmc/EthernetInterfaces/
516
517#### EthernetInterfaceCollection
518
519- Description
520- Members
521- Members@odata.count
522
523### /redfish/v1/Managers/bmc/EthernetInterfaces/{EthernetInterfaceId}/
524
525#### EthernetInterface
526
527- DHCPv4
528- DHCPv6
529- Description
530- EthernetInterfaceType
531- FQDN
532- HostName
533- IPv4Addresses
534- IPv4StaticAddresses
535- IPv6AddressPolicyTable
536- IPv6Addresses
537- IPv6DefaultGateway
538- IPv6StaticAddresses
539- InterfaceEnabled
540- Links/RelatedInterfaces
541- LinkStatus
542- MACAddress
543- NameServers
544- SpeedMbps
545- StatelessAddressAutoConfig
546- StaticNameServers
547- Status
548- VLAN/VLANEnable
549- VLAN/VLANId
550- VLAN/Tagged
551
552### /redfish/v1/Managers/bmc/LogServices/
553
554The [LogService][2] resource provides properties for monitoring and configuring
555events for the service or resource to which it is associated.
556
557Within bmcweb, the LogService object resides under the System resource. It
558tracks all events for the system.
559
560The LogService supports multiple log entry types. bmcweb has support for the
561`Event` type. This is the new Redfish-defined type.
562
563bmcweb supports two different implementations of the
564`LogService/EventLog/Entries` URI.
565
566The default implementation uses rsyslog to write Redfish events from the journal
567to the persistent /var/log/ filesystem. The bmcweb software then looks for these
568files in /var/log/ and returns the appropriate Redfish EventLog Entries for
569these. More details on adding events can be found [here][3]
570
571The other implementation of EventLog Entries can be enabled by compiling bmcweb
572with the `-DBMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES=ON` option. This will cause
573bmcweb to look to [phosphor-logging][4] for any D-Bus log entries. These will
574then be translated to Redfish EventLog Entries.
575
576These two implementations do not work together, so choosing one will disable the
577other.
578
579#### LogServiceCollection
580
581- Description
582- Members
583- Members@odata.count
584
585### /redfish/v1/Managers/bmc/LogServices/RedfishLog/
586
587#### LogService
588
589- Entries
590- OverWritePolicy
591- Actions
592- Status
593- DateTime
594- MaxNumberOfRecords
595
596### /redfish/v1/Managers/bmc/LogServices/RedfishLog/Entries/{LogEntryId}/
597
598#### LogEntry
599
600- Message
601- Created
602- EntryType
603
604### /redfish/v1/Managers/bmc/ManagerDiagnosticData/
605
606#### ManagerDiagnosticData
607
608- ServiceRootUptimeSeconds
609- FreeStorageSpaceKiB
610- MemoryStatistics/AvailableBytes
611- MemoryStatistics/BuffersAndCacheBytes
612- MemoryStatistics/FreeBytes
613- MemoryStatistics/SharedBytes
614- MemoryStatistics/TotalBytes
615- ProcessorStatistics/KernelPercent
616- ProcessorStatistics/UserPercent
617
618### /redfish/v1/Managers/bmc/NetworkProtocol/
619
620#### ManagerNetworkProtocol
621
622- Description
623- FQDN
624- HTTP
625- HTTPS
626- HostName
627- IPMI
628- NTP
629- SSH
630- Status
631
632### /redfish/v1/Managers/bmc/NetworkProtocol/HTTPS/Certificates/
633
634#### CertificateCollection
635
636- Description
637- Members
638- Members@odata.count
639
640### /redfish/v1/Managers/bmc/NetworkProtocol/HTTPS/Certificates/{CertificateId}/
641
642#### Certificate
643
644- CertificateString
645- Description
646- Issuer
647- KeyUsage
648- Subject
649- ValidNotAfter
650- ValidNotBefore
651
652### /redfish/v1/Managers/bmc/Truststore/Certificates/
653
654#### CertificateCollection
655
656- Description
657- error
658
659### /redfish/v1/Registries/
660
661#### MessageRegistryFileCollection
662
663- Description
664- Members
665  - Should support Base, CommonMessages, and EventingMessages
666- Members@odata.count
667
668### /redfish/v1/Registries/{MessageRegistryFileId}/
669
670#### MessageRegistryFile
671
672- Description
673- Languages
674- Languages@odata.count
675- Location
676- Location@odata.count
677- Registry
678
679### /redfish/v1/SessionService/
680
681#### SessionService
682
683- Description
684- ServiceEnabled
685- SessionTimeout
686- Sessions
687
688### /redfish/v1/SessionService/Sessions/
689
690#### SessionCollection
691
692- Description
693- Members
694- Members@odata.count
695
696### /redfish/v1/SessionService/Sessions/{SessionId}/
697
698#### Session
699
700- ClientOriginIPAddress
701- Description
702- Oem
703- UserName
704
705### /redfish/v1/Systems/
706
707#### ComputerSystemCollection
708
709- Members
710  - Should support one system
711- Members@odata.count
712
713### /redfish/v1/Systems/system/Bios/
714
715#### Bios
716
717- Actions
718- Description
719- Links/ActiveSoftwareImage
720- Links/SoftwareImages
721- Links/SoftwareImages@odata.count
722
723### /redfish/v1/Systems/system/
724
725#### ComputerSystem
726
727- Actions
728- AssetTag
729- Bios
730- BiosVersion
731- Boot
732- BootProgress
733- Description
734- HostWatchdogTimer
735- IdlePowerSaver/Enable
736- IdlePowerSaver/EnterUtilizationPercent
737- IdlePowerSaver/EnterDwellTimeSeconds
738- IdlePowerSaver/ExitUtilizationPercent
739- IdlePowerSaver/ExitDwellTimeSeconds
740- IndicatorLED
741- LastResetTime
742- Links/Chassis
743- Links/ManagedBy
744- LocationIndicatorActive
745- LogServices
746- Manufacturer
747- Memory
748- MemorySummary
749- Model
750- PartNumber
751- PowerMode
752- PowerRestorePolicy
753- PowerState
754- ProcessorSummary
755- Processors
756- SerialNumber
757- Status
758- Storage
759- SubModel
760- SystemType
761
762### /redfish/v1/Systems/system/EthernetInterfaces/
763
764#### EthernetInterfaceCollection
765
766- Members
767- Members@odata.count
768- Description
769
770### /redfish/v1/Systems/system/FabricAdapters/
771
772#### FabricAdapterCollection
773
774- Members
775- Members@odata.count
776
777### /redfish/v1/Systems/system/FabricAdapters/{FabricAdapterId}/
778
779#### FabricAdapter
780
781- Location
782- Model
783- PartNumber
784- SerialNumber
785- SparePartNumber
786- Status
787
788### /redfish/v1/Systems/system/LogServices/
789
790#### LogServiceCollection
791
792- Description
793- Members
794  - Should default to one member, named SEL
795- Members@odata.count
796
797### /redfish/v1/Systems/system/LogServices/EventLog/
798
799#### LogService
800
801- Actions
802- DateTime
803- DateTimeLocalOffset
804- Description
805- Entries
806- OverWritePolicy
807
808### /redfish/v1/Systems/system/LogServices/EventLog/Entries/
809
810#### LogEntryCollection
811
812- Description
813- Members
814- Members@odata.count
815
816### /redfish/v1/Systems/system/LogServices/EventLog/Entries/{LogEntryId}/
817
818#### LogEntry
819
820- AdditionalDataURI
821- Created
822- EntryType
823- Message
824- Modified
825- Resolved
826- Severity
827
828### /redfish/v1/Systems/system/LogServices/SEL/Entries/
829
830#### LogEntryCollection
831
832- Members
833- Members@odata.count
834- Description
835- @odata.nextLink
836
837### /redfish/v1/Systems/system/LogServices/SEL/Entries/{LogEntryId}/
838
839#### LogEntry
840
841- MessageArgs
842- Severity
843- SensorType
844- Message
845- MessageId
846- Created
847- EntryCode
848- EntryType
849
850### /redfish/v1/Systems/system/Memory/
851
852#### MemoryCollection
853
854- Members
855- Members@odata.count
856
857### /redfish/v1/Systems/system/Memory/{MemoryId}/
858
859#### Memory
860
861- AllowedSpeedsMHz
862- BaseModuleType
863- BusWidthBits
864- CapacityMiB
865- DataWidthBits
866- ErrorCorrection
867- FirmwareRevision
868- Manufacturer
869- Model
870- OperatingSpeedMhz
871- PartNumber
872- RankCount
873- SerialNumber
874- SparePartNumber
875- Status
876
877### /redfish/v1/Systems/system/Memory/{MemoryId}/MemoryMetrics/
878
879#### MemoryMetrics
880
881- Description
882- HealthData
883
884### /redfish/v1/Systems/system/PCIeDevices/
885
886#### PCIeDeviceCollection
887
888- Description
889- Members
890- Members@odata.count
891
892### /redfish/v1/Systems/system/PCIeDevices/{PCIeDevice}/
893
894- Manufacturer
895- Model
896- PartNumber
897- PCIeInterface
898  - LanesInUse
899  - MaxLanes
900  - MaxPCIeType
901  - PCIeType
902- SerialNumber
903- Slot
904  - Lanes
905  - PCIeType
906  - SlotType
907- SparePartNumber
908- Status
909
910### /redfish/v1/Systems/system/Processors/
911
912#### ProcessorCollection
913
914- Members
915  - Should Support CPU1 and CPU2 for dual socket systems
916- Members@odata.count
917
918### /redfish/v1/Systems/system/Processors/{ProcessorId}/
919
920#### Processor
921
922- InstructionSet
923- Manufacturer
924- MaxSpeedMHz
925- PartNumber
926- ProcessorArchitecture
927- ProcessorId
928- ProcessorType
929- SerialNumber
930- Socket
931- SparePartNumber
932- Status
933- ThrottleCauses
934- Throttled
935- TotalCores
936- TotalThreads
937- Version
938
939### /redfish/v1/Systems/system/Storage/
940
941#### StorageCollection
942
943- Members
944- Members@odata.count
945
946### /redfish/v1/Systems/system/Storage/{StorageId}/
947
948#### Storage
949
950- Drives
951- Drives@odata.count
952- Status
953
954### /redfish/v1/Systems/system/Storage/{StorageId}/Drive/{DriveId}/
955
956#### Storage
957
958- CapacityBytes
959- EncryptionStatus
960- Links
961- Status
962
963### /redfish/v1/TaskService/
964
965#### TaskService
966
967- CompletedTaskOverWritePolicy
968- DateTime
969- LifeCycleEventOnTaskStateChange
970- ServiceEnabled
971- Status
972- Tasks
973
974### /redfish/v1/TaskService/Tasks/
975
976#### TaskCollection
977
978- Members
979- Members@odata.count
980
981### /redfish/v1/TelemetryService/
982
983#### TelemetryService
984
985- MaxReports
986- MetricReportDefinitions
987- MetricReports
988- MinCollectionInterval
989- Status
990- Triggers
991- SupportedCollectionFunctions
992
993### /redfish/v1/TelemetryService/MetricReportDefinitions/
994
995#### MetricReportDefinitionCollection
996
997- Members
998- Members@odata.count
999
1000### /redfish/v1/TelemetryService/MetricReportDefinitions/{MetricReportDefinitionId}/
1001
1002#### MetricReportDefinition
1003
1004- AppendLimit
1005- Id
1006- MetricReport
1007- MetricReportDefinitionEnabled
1008- MetricReportDefinitionType
1009- Metrics
1010- Name
1011- ReportActions
1012- ReportUpdates
1013- Schedule
1014- Status
1015
1016### /redfish/v1/TelemetryService/MetricReports/
1017
1018#### MetricReportCollection
1019
1020- Members
1021- Members@odata.count
1022
1023### /redfish/v1/TelemetryService/MetricReports/{MetricReportId}/
1024
1025#### MetricReport
1026
1027- Id
1028- MetricReportDefinition
1029- MetricValues
1030- Name
1031- Timestamp
1032
1033### /redfish/v1/TelemetryService/Triggers/
1034
1035#### TriggersCollection
1036
1037- Members
1038- Members@odata.count
1039
1040### /redfish/v1/UpdateService/
1041
1042#### UpdateService
1043
1044- Actions
1045- Description
1046- FirmwareInventory
1047- HttpPushUri
1048- HttpPushUriOptions
1049- MaxImageSizeBytes
1050- ServiceEnabled
1051
1052### /redfish/v1/UpdateService/FirmwareInventory/
1053
1054#### SoftwareInventoryCollection
1055
1056- Members
1057  - Should Support BMC, ME, CPLD and BIOS
1058- Members@odata.count
1059
1060### /redfish/v1/UpdateService/FirmwareInventory/{SoftwareInventoryId}/
1061
1062#### SoftwareInventory
1063
1064- Description
1065- RelatedItem@odata.count
1066- RelatedItem
1067- Status
1068- Updateable
1069- Version
1070
1071[1]: https://www.dmtf.org/standards/redfish
1072[2]: https://redfish.dmtf.org/schemas/v1/LogService.json
1073[3]:
1074  https://github.com/openbmc/docs/blob/master/architecture/redfish-logging-in-bmcweb.md
1075[4]: https://github.com/openbmc/phosphor-logging
1076