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