xref: /openbmc/bmcweb/Redfish.md (revision 3bfa3b29c0515a9e77c7c69fe072b7ff2e0fc302)
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- HTTPBasicAuth
62- LDAP
63- MaxPasswordLength
64- MinPasswordLength
65- Oem/OpenBMC/AuthMethods/BasicAuth
66- Oem/OpenBMC/AuthMethods/Cookie
67- Oem/OpenBMC/AuthMethods/SessionToken
68- Oem/OpenBMC/AuthMethods/TLS
69- Oem/OpenBMC/AuthMethods/XToken
70- Roles
71- ServiceEnabled
72
73### /redfish/v1/AggregationService/
74
75#### AggregationService
76
77- AggregationSources
78- Description
79- ServiceEnabled
80
81### /redfish/v1/AggregationService/AggregationSources
82
83#### AggregationSourceCollection
84
85- Members
86- Members@odata.count
87
88### /redfish/v1/AggregationService/AggregationSources/{AggregationSourceId}
89
90#### AggregationSource
91
92- HostName
93- Password
94
95### /redfish/v1/AccountService/Accounts/
96
97#### ManagerAccountCollection
98
99- Description
100- Members
101- Members@odata.count
102
103### /redfish/v1/AccountService/Accounts/{ManagerAccountId}/
104
105#### ManagerAccount
106
107- AccountTypes
108- Description
109- Enabled
110- Links/Role
111- Locked
112- Locked@Redfish.AllowableValues
113- Password
114- PasswordChangeRequired
115- RoleId
116- StrictAccountTypes
117- UserName
118
119### /redfish/v1/AccountService/LDAP/Certificates/
120
121#### CertificateCollection
122
123- Description
124- Members
125- Members@odata.count
126
127### /redfish/v1/AccountService/Roles/
128
129#### RoleCollection
130
131- Description
132- Members
133  - By default will contain 3 roles, "Administrator", "Operator", and "ReadOnly"
134- Members@odata.count
135
136### /redfish/v1/AccountService/Roles/{RoleId}/
137
138#### Role
139
140- AssignedPrivileges
141  - For the default roles, the following privileges will be assigned by default
142    - Administrator: Login, ConfigureManager, ConfigureUsers, ConfigureSelf,
143      ConfigureComponents
144    - Operator: Login, ConfigureComponents, ConfigureSelf
145    - ReadOnly: Login, ConfigureSelf
146- Description
147- IsPredefined
148  - Will be set to true for all default roles. If the given role is non-default,
149    or has been modified from default, will be marked as false.
150- OemPrivileges
151- RoleId
152
153### /redfish/v1/Cables/
154
155#### CableCollection
156
157- Description
158- Members
159- Members@odata.count
160
161### /redfish/v1/Cables/{CableId}/
162
163#### Cable
164
165- CableType
166- LengthMeters
167- Status
168
169### /redfish/v1/CertificateService/
170
171#### CertificateService
172
173- Actions
174- CertificateLocations
175- Description
176
177### /redfish/v1/CertificateService/CertificateLocations/
178
179#### CertificateLocations
180
181- Description
182- Links/Certificates
183- Links/Certificates@odata.count
184
185### /redfish/v1/Chassis/
186
187#### ChassisCollection
188
189- Members
190- Members@odata.count
191
192### /redfish/v1/Chassis/{ChassisId}/
193
194#### Chassis
195
196- Actions
197- ChassisType
198- HotPluggable
199- Links/ComputerSystems
200- Links/ManagedBy
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/ResetActionInfo/
940
941#### ActionInfo
942
943- Parameters/AllowableValues
944- Parameters/DataType
945- Parameters/Required
946
947### /redfish/v1/Systems/system/Storage/
948
949#### StorageCollection
950
951- Members
952- Members@odata.count
953
954### /redfish/v1/Systems/system/Storage/{StorageId}/
955
956#### Storage
957
958- Drives
959- Drives@odata.count
960- Status
961
962### /redfish/v1/Systems/system/Storage/{StorageId}/Drive/{DriveId}/
963
964#### Storage
965
966- CapacityBytes
967- EncryptionStatus
968- Links
969- Status
970
971### /redfish/v1/TaskService/
972
973#### TaskService
974
975- CompletedTaskOverWritePolicy
976- DateTime
977- LifeCycleEventOnTaskStateChange
978- ServiceEnabled
979- Status
980- Tasks
981
982### /redfish/v1/TaskService/Tasks/
983
984#### TaskCollection
985
986- Members
987- Members@odata.count
988
989### /redfish/v1/TelemetryService/
990
991#### TelemetryService
992
993- MaxReports
994- MetricReportDefinitions
995- MetricReports
996- MinCollectionInterval
997- Status
998- Triggers
999- SupportedCollectionFunctions
1000
1001### /redfish/v1/TelemetryService/MetricReportDefinitions/
1002
1003#### MetricReportDefinitionCollection
1004
1005- Members
1006- Members@odata.count
1007
1008### /redfish/v1/TelemetryService/MetricReportDefinitions/{MetricReportDefinitionId}/
1009
1010#### MetricReportDefinition
1011
1012- AppendLimit
1013- Id
1014- MetricReport
1015- MetricReportDefinitionEnabled
1016- MetricReportDefinitionType
1017- Metrics
1018- Name
1019- ReportActions
1020- ReportUpdates
1021- Schedule
1022- Status
1023
1024### /redfish/v1/TelemetryService/MetricReports/
1025
1026#### MetricReportCollection
1027
1028- Members
1029- Members@odata.count
1030
1031### /redfish/v1/TelemetryService/MetricReports/{MetricReportId}/
1032
1033#### MetricReport
1034
1035- Id
1036- MetricReportDefinition
1037- MetricValues
1038- Name
1039- Timestamp
1040
1041### /redfish/v1/TelemetryService/Triggers/
1042
1043#### TriggersCollection
1044
1045- Members
1046- Members@odata.count
1047
1048### /redfish/v1/UpdateService/
1049
1050#### UpdateService
1051
1052- Actions
1053- Description
1054- FirmwareInventory
1055- HttpPushUri
1056- HttpPushUriOptions
1057- MaxImageSizeBytes
1058- ServiceEnabled
1059
1060### /redfish/v1/UpdateService/FirmwareInventory/
1061
1062#### SoftwareInventoryCollection
1063
1064- Members
1065  - Should Support BMC, ME, CPLD and BIOS
1066- Members@odata.count
1067
1068### /redfish/v1/UpdateService/FirmwareInventory/{SoftwareInventoryId}/
1069
1070#### SoftwareInventory
1071
1072- Description
1073- RelatedItem@odata.count
1074- RelatedItem
1075- Status
1076- Updateable
1077- Version
1078
1079[1]: https://www.dmtf.org/standards/redfish
1080[2]: https://redfish.dmtf.org/schemas/v1/LogService.json
1081[3]:
1082  https://github.com/openbmc/docs/blob/master/architecture/redfish-logging-in-bmcweb.md
1083[4]: https://github.com/openbmc/phosphor-logging
1084