xref: /openbmc/bmcweb/Redfish.md (revision d51c61b4)
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- Protocol
483
484### /redfish/v1/JsonSchemas/
485
486#### JsonSchemaFileCollection
487
488- Description
489- `Members@odata.count`
490- Members
491
492### /redfish/v1/JsonSchemas/{Id}/
493
494#### JsonSchemaFile
495
496- Schema
497- Description
498- Languages
499- `Languages@odata.count`
500- Location
501- `Location@odata.count`
502
503### /redfish/v1/Managers/
504
505#### ManagerCollection
506
507- Members
508- `Members@odata.count`
509
510### /redfish/v1/Managers/bmc/
511
512#### Manager
513
514- Actions
515- DateTime
516- DateTimeLocalOffset
517- Description
518- EthernetInterfaces
519- FirmwareVersion
520- GraphicalConsole
521- LastResetTime
522- Links/ActiveSoftwareImage
523- Links/ManagerForChassis
524- Links/ManagerForChassis@odata.count
525- Links/ManagerForServers
526- Links/ManagerForServers@odata.count
527- Links/ManagerInChassis
528- Links/SoftwareImages
529- Links/SoftwareImages@odata.count
530- LogServices
531- ManagerType
532- Manufacturer
533- Model
534- NetworkProtocol
535- Oem
536- PartNumber
537- PowerState
538- SerialConsole
539- SerialNumber
540- ServiceEntryPointUUID
541- SparePartNumber
542- Status
543- UUID
544
545### /redfish/v1/Managers/bmc/EthernetInterfaces/
546
547#### EthernetInterfaceCollection
548
549- Description
550- Members
551- `Members@odata.count`
552
553### /redfish/v1/Managers/bmc/EthernetInterfaces/{EthernetInterfaceId}/
554
555#### EthernetInterface
556
557- DHCPv4
558- DHCPv6
559- Description
560- EthernetInterfaceType
561- FQDN
562- HostName
563- IPv4Addresses
564- IPv4StaticAddresses
565- IPv6AddressPolicyTable
566- IPv6Addresses
567- IPv6DefaultGateway
568- IPv6StaticAddresses
569- IPv6StaticDefaultGateways
570- InterfaceEnabled
571- Links/RelatedInterfaces
572- LinkStatus
573- MACAddress
574- NameServers
575- SpeedMbps
576- StatelessAddressAutoConfig
577- StaticNameServers
578- Status
579- VLAN/VLANEnable
580- VLAN/VLANId
581- VLAN/Tagged
582
583### /redfish/v1/Managers/bmc/LogServices/
584
585The [LogService][2] resource provides properties for monitoring and configuring
586events for the service or resource to which it is associated.
587
588Within bmcweb, the LogService object resides under the System resource. It
589tracks all events for the system.
590
591The LogService supports multiple log entry types. bmcweb has support for the
592`Event` type. This is the new Redfish-defined type.
593
594bmcweb supports two different implementations of the
595`LogService/EventLog/Entries` URI.
596
597The default implementation uses rsyslog to write Redfish events from the journal
598to the persistent /var/log/ filesystem. The bmcweb software then looks for these
599files in /var/log/ and returns the appropriate Redfish EventLog Entries for
600these. More details on adding events can be found [here][3]
601
602The other implementation of EventLog Entries can be enabled by compiling bmcweb
603with the `-DBMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES=ON` option. This will cause
604bmcweb to look to [phosphor-logging][4] for any D-Bus log entries. These will
605then be translated to Redfish EventLog Entries.
606
607These two implementations do not work together, so choosing one will disable the
608other.
609
610#### LogServiceCollection
611
612- Description
613- Members
614- `Members@odata.count`
615
616### /redfish/v1/Managers/bmc/LogServices/RedfishLog/
617
618#### LogService
619
620- Entries
621- OverWritePolicy
622- Actions
623- Status
624- DateTime
625- MaxNumberOfRecords
626
627### /redfish/v1/Managers/bmc/LogServices/RedfishLog/Entries/{LogEntryId}/
628
629#### LogEntry
630
631- Message
632- Created
633- EntryType
634
635### /redfish/v1/Managers/bmc/ManagerDiagnosticData/
636
637#### ManagerDiagnosticData
638
639- ServiceRootUptimeSeconds
640- FreeStorageSpaceKiB
641- MemoryStatistics/AvailableBytes
642- MemoryStatistics/BuffersAndCacheBytes
643- MemoryStatistics/FreeBytes
644- MemoryStatistics/SharedBytes
645- MemoryStatistics/TotalBytes
646- ProcessorStatistics/KernelPercent
647- ProcessorStatistics/UserPercent
648
649### /redfish/v1/Managers/bmc/NetworkProtocol/
650
651#### ManagerNetworkProtocol
652
653- Description
654- FQDN
655- HTTP
656- HTTPS
657- HostName
658- IPMI
659- NTP
660- SSH
661- Status
662
663### /redfish/v1/Managers/bmc/NetworkProtocol/HTTPS/Certificates/
664
665#### CertificateCollection
666
667- Description
668- Members
669- `Members@odata.count`
670
671### /redfish/v1/Managers/bmc/NetworkProtocol/HTTPS/Certificates/{CertificateId}/
672
673#### Certificate
674
675- CertificateString
676- Description
677- Issuer
678- KeyUsage
679- Subject
680- ValidNotAfter
681- ValidNotBefore
682
683### /redfish/v1/Managers/bmc/Truststore/Certificates/
684
685#### CertificateCollection
686
687- Description
688- error
689
690### /redfish/v1/Registries/
691
692#### MessageRegistryFileCollection
693
694- Description
695- Members
696  - Should support Base, CommonMessages, and EventingMessages
697- `Members@odata.count`
698
699### /redfish/v1/Registries/{MessageRegistryFileId}/
700
701#### MessageRegistryFile
702
703- Description
704- Languages
705- `Languages@odata.count`
706- Location
707- `Location@odata.count`
708- Registry
709
710### /redfish/v1/SessionService/
711
712#### SessionService
713
714- Description
715- ServiceEnabled
716- SessionTimeout
717- Sessions
718
719### /redfish/v1/SessionService/Sessions/
720
721#### SessionCollection
722
723- Description
724- Members
725- `Members@odata.count`
726
727### /redfish/v1/SessionService/Sessions/{SessionId}/
728
729#### Session
730
731- ClientOriginIPAddress
732- Description
733- Roles
734- UserName
735
736### /redfish/v1/Systems/
737
738#### ComputerSystemCollection
739
740- Members
741  - Should support one system
742- `Members@odata.count`
743
744### /redfish/v1/Systems/system/Bios/
745
746#### Bios
747
748- Actions
749- Description
750- Links/ActiveSoftwareImage
751- Links/SoftwareImages
752- Links/SoftwareImages@odata.count
753
754### /redfish/v1/Systems/system/
755
756#### ComputerSystem
757
758- Actions
759- AssetTag
760- Bios
761- BiosVersion
762- Boot
763- BootProgress
764- Description
765- HostWatchdogTimer
766- IdlePowerSaver/Enable
767- IdlePowerSaver/EnterUtilizationPercent
768- IdlePowerSaver/EnterDwellTimeSeconds
769- IdlePowerSaver/ExitUtilizationPercent
770- IdlePowerSaver/ExitDwellTimeSeconds
771- IndicatorLED
772- LastResetTime
773- Links/Chassis
774- Links/ManagedBy
775- LocationIndicatorActive
776- LogServices
777- Manufacturer
778- Memory
779- MemorySummary
780- Model
781- PartNumber
782- PowerMode
783- PowerRestorePolicy
784- PowerState
785- ProcessorSummary
786- Processors
787- SerialNumber
788- Status
789- Storage
790- SubModel
791- SystemType
792
793### /redfish/v1/Systems/system/EthernetInterfaces/
794
795#### EthernetInterfaceCollection
796
797- Members
798- `Members@odata.count`
799- Description
800
801### /redfish/v1/Systems/system/FabricAdapters/
802
803#### FabricAdapterCollection
804
805- Members
806- `Members@odata.count`
807
808### /redfish/v1/Systems/system/FabricAdapters/{FabricAdapterId}/
809
810#### FabricAdapter
811
812- Location
813- Model
814- PartNumber
815- SerialNumber
816- SparePartNumber
817- Status
818
819### /redfish/v1/Systems/system/LogServices/
820
821#### LogServiceCollection
822
823- Description
824- Members
825  - Should default to one member, named SEL
826- `Members@odata.count`
827
828### /redfish/v1/Systems/system/LogServices/EventLog/
829
830#### LogService
831
832- Actions
833- DateTime
834- DateTimeLocalOffset
835- Description
836- Entries
837- OverWritePolicy
838
839### /redfish/v1/Systems/system/LogServices/EventLog/Entries/
840
841#### LogEntryCollection
842
843- Description
844- Members
845- `Members@odata.count`
846
847### /redfish/v1/Systems/system/LogServices/EventLog/Entries/{LogEntryId}/
848
849#### LogEntry
850
851- AdditionalDataURI
852- Created
853- EntryType
854- Message
855- Modified
856- Resolved
857- Severity
858
859### /redfish/v1/Systems/system/LogServices/SEL/Entries/
860
861#### LogEntryCollection
862
863- Members
864- `Members@odata.count`
865- Description
866- @odata.nextLink
867
868### /redfish/v1/Systems/system/LogServices/SEL/Entries/{LogEntryId}/
869
870#### LogEntry
871
872- MessageArgs
873- Severity
874- SensorType
875- Message
876- MessageId
877- Created
878- EntryCode
879- EntryType
880
881### /redfish/v1/Systems/system/Memory/
882
883#### MemoryCollection
884
885- Members
886- `Members@odata.count`
887
888### /redfish/v1/Systems/system/Memory/{MemoryId}/
889
890#### Memory
891
892- AllowedSpeedsMHz
893- BaseModuleType
894- BusWidthBits
895- CapacityMiB
896- DataWidthBits
897- ErrorCorrection
898- FirmwareRevision
899- Manufacturer
900- Model
901- OperatingSpeedMhz
902- PartNumber
903- RankCount
904- SerialNumber
905- SparePartNumber
906- Status
907
908### /redfish/v1/Systems/system/Memory/{MemoryId}/MemoryMetrics/
909
910#### MemoryMetrics
911
912- Description
913- HealthData
914
915### /redfish/v1/Systems/system/PCIeDevices/
916
917#### PCIeDeviceCollection
918
919- Description
920- Members
921- `Members@odata.count`
922
923### /redfish/v1/Systems/system/PCIeDevices/{PCIeDevice}/
924
925- Manufacturer
926- Model
927- PartNumber
928- PCIeInterface
929  - LanesInUse
930  - MaxLanes
931  - MaxPCIeType
932  - PCIeType
933- SerialNumber
934- Slot
935  - Lanes
936  - PCIeType
937  - SlotType
938- SparePartNumber
939- Status
940
941### /redfish/v1/Systems/system/Processors/
942
943#### ProcessorCollection
944
945- Members
946  - Should Support CPU1 and CPU2 for dual socket systems
947- `Members@odata.count`
948
949### /redfish/v1/Systems/system/Processors/{ProcessorId}/
950
951#### Processor
952
953- InstructionSet
954- Manufacturer
955- MaxSpeedMHz
956- PartNumber
957- ProcessorArchitecture
958- ProcessorId
959- ProcessorType
960- SerialNumber
961- Socket
962- SparePartNumber
963- Status
964- ThrottleCauses
965- Throttled
966- TotalCores
967- TotalThreads
968- Version
969
970### /redfish/v1/Systems/system/ResetActionInfo/
971
972#### ActionInfo
973
974- Parameters/AllowableValues
975- Parameters/DataType
976- Parameters/Required
977
978### /redfish/v1/Systems/system/Storage/
979
980#### StorageCollection
981
982- Members
983- `Members@odata.count`
984
985### /redfish/v1/Systems/system/Storage/{StorageId}/
986
987#### Storage
988
989- Drives
990- `Drives@odata.count`
991- Status
992
993### /redfish/v1/Systems/system/Storage/{StorageId}/Drive/{DriveId}/
994
995#### Storage
996
997- CapacityBytes
998- EncryptionStatus
999- Links
1000- Status
1001
1002### /redfish/v1/TaskService/
1003
1004#### TaskService
1005
1006- CompletedTaskOverWritePolicy
1007- DateTime
1008- LifeCycleEventOnTaskStateChange
1009- ServiceEnabled
1010- Status
1011- Tasks
1012
1013### /redfish/v1/TaskService/Tasks/
1014
1015#### TaskCollection
1016
1017- Members
1018- `Members@odata.count`
1019
1020### /redfish/v1/TelemetryService/
1021
1022#### TelemetryService
1023
1024- MaxReports
1025- MetricReportDefinitions
1026- MetricReports
1027- MinCollectionInterval
1028- Status
1029- Triggers
1030- SupportedCollectionFunctions
1031
1032### /redfish/v1/TelemetryService/MetricReportDefinitions/
1033
1034#### MetricReportDefinitionCollection
1035
1036- Members
1037- `Members@odata.count`
1038
1039### /redfish/v1/TelemetryService/MetricReportDefinitions/{MetricReportDefinitionId}/
1040
1041#### MetricReportDefinition
1042
1043- AppendLimit
1044- Id
1045- MetricReport
1046- MetricReportDefinitionEnabled
1047- MetricReportDefinitionType
1048- Metrics
1049- Name
1050- ReportActions
1051- ReportUpdates
1052- Schedule
1053- Status
1054
1055### /redfish/v1/TelemetryService/MetricReports/
1056
1057#### MetricReportCollection
1058
1059- Members
1060- `Members@odata.count`
1061
1062### /redfish/v1/TelemetryService/MetricReports/{MetricReportId}/
1063
1064#### MetricReport
1065
1066- Id
1067- MetricReportDefinition
1068- MetricValues
1069- Name
1070- Timestamp
1071
1072### /redfish/v1/TelemetryService/Triggers/
1073
1074#### TriggersCollection
1075
1076- Members
1077- `Members@odata.count`
1078
1079### /redfish/v1/UpdateService/
1080
1081#### UpdateService
1082
1083- Actions
1084- Description
1085- FirmwareInventory
1086- HttpPushUri
1087- HttpPushUriOptions
1088- MaxImageSizeBytes
1089- ServiceEnabled
1090
1091### /redfish/v1/UpdateService/FirmwareInventory/
1092
1093#### SoftwareInventoryCollection
1094
1095- Members
1096  - Should Support BMC, ME, CPLD and BIOS
1097- `Members@odata.count`
1098
1099### /redfish/v1/UpdateService/FirmwareInventory/{SoftwareInventoryId}/
1100
1101#### SoftwareInventory
1102
1103- Description
1104- `RelatedItem@odata.count`
1105- RelatedItem
1106- Status
1107- Updateable
1108- Version
1109
1110[1]: https://www.dmtf.org/standards/redfish
1111[2]: https://redfish.dmtf.org/schemas/v1/LogService.json
1112[3]:
1113  https://github.com/openbmc/docs/blob/master/architecture/redfish-logging-in-bmcweb.md
1114[4]: https://github.com/openbmc/phosphor-logging
1115