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