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