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