xref: /openbmc/bmcweb/Redfish.md (revision aa848de216d501c2c6dd00e3599a3d7a86eaa660)
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- UserName
732
733### /redfish/v1/Systems/
734
735#### ComputerSystemCollection
736
737- Members
738  - Should support one system
739- Members@odata.count
740
741### /redfish/v1/Systems/system/Bios/
742
743#### Bios
744
745- Actions
746- Description
747- Links/ActiveSoftwareImage
748- Links/SoftwareImages
749- Links/SoftwareImages@odata.count
750
751### /redfish/v1/Systems/system/
752
753#### ComputerSystem
754
755- Actions
756- AssetTag
757- Bios
758- BiosVersion
759- Boot
760- BootProgress
761- Description
762- HostWatchdogTimer
763- IdlePowerSaver/Enable
764- IdlePowerSaver/EnterUtilizationPercent
765- IdlePowerSaver/EnterDwellTimeSeconds
766- IdlePowerSaver/ExitUtilizationPercent
767- IdlePowerSaver/ExitDwellTimeSeconds
768- IndicatorLED
769- LastResetTime
770- Links/Chassis
771- Links/ManagedBy
772- LocationIndicatorActive
773- LogServices
774- Manufacturer
775- Memory
776- MemorySummary
777- Model
778- PartNumber
779- PowerMode
780- PowerRestorePolicy
781- PowerState
782- ProcessorSummary
783- Processors
784- SerialNumber
785- Status
786- Storage
787- SubModel
788- SystemType
789
790### /redfish/v1/Systems/system/EthernetInterfaces/
791
792#### EthernetInterfaceCollection
793
794- Members
795- Members@odata.count
796- Description
797
798### /redfish/v1/Systems/system/FabricAdapters/
799
800#### FabricAdapterCollection
801
802- Members
803- Members@odata.count
804
805### /redfish/v1/Systems/system/FabricAdapters/{FabricAdapterId}/
806
807#### FabricAdapter
808
809- Location
810- Model
811- PartNumber
812- SerialNumber
813- SparePartNumber
814- Status
815
816### /redfish/v1/Systems/system/LogServices/
817
818#### LogServiceCollection
819
820- Description
821- Members
822  - Should default to one member, named SEL
823- Members@odata.count
824
825### /redfish/v1/Systems/system/LogServices/EventLog/
826
827#### LogService
828
829- Actions
830- DateTime
831- DateTimeLocalOffset
832- Description
833- Entries
834- OverWritePolicy
835
836### /redfish/v1/Systems/system/LogServices/EventLog/Entries/
837
838#### LogEntryCollection
839
840- Description
841- Members
842- Members@odata.count
843
844### /redfish/v1/Systems/system/LogServices/EventLog/Entries/{LogEntryId}/
845
846#### LogEntry
847
848- AdditionalDataURI
849- Created
850- EntryType
851- Message
852- Modified
853- Resolved
854- Severity
855
856### /redfish/v1/Systems/system/LogServices/SEL/Entries/
857
858#### LogEntryCollection
859
860- Members
861- Members@odata.count
862- Description
863- @odata.nextLink
864
865### /redfish/v1/Systems/system/LogServices/SEL/Entries/{LogEntryId}/
866
867#### LogEntry
868
869- MessageArgs
870- Severity
871- SensorType
872- Message
873- MessageId
874- Created
875- EntryCode
876- EntryType
877
878### /redfish/v1/Systems/system/Memory/
879
880#### MemoryCollection
881
882- Members
883- Members@odata.count
884
885### /redfish/v1/Systems/system/Memory/{MemoryId}/
886
887#### Memory
888
889- AllowedSpeedsMHz
890- BaseModuleType
891- BusWidthBits
892- CapacityMiB
893- DataWidthBits
894- ErrorCorrection
895- FirmwareRevision
896- Manufacturer
897- Model
898- OperatingSpeedMhz
899- PartNumber
900- RankCount
901- SerialNumber
902- SparePartNumber
903- Status
904
905### /redfish/v1/Systems/system/Memory/{MemoryId}/MemoryMetrics/
906
907#### MemoryMetrics
908
909- Description
910- HealthData
911
912### /redfish/v1/Systems/system/PCIeDevices/
913
914#### PCIeDeviceCollection
915
916- Description
917- Members
918- Members@odata.count
919
920### /redfish/v1/Systems/system/PCIeDevices/{PCIeDevice}/
921
922- Manufacturer
923- Model
924- PartNumber
925- PCIeInterface
926  - LanesInUse
927  - MaxLanes
928  - MaxPCIeType
929  - PCIeType
930- SerialNumber
931- Slot
932  - Lanes
933  - PCIeType
934  - SlotType
935- SparePartNumber
936- Status
937
938### /redfish/v1/Systems/system/Processors/
939
940#### ProcessorCollection
941
942- Members
943  - Should Support CPU1 and CPU2 for dual socket systems
944- Members@odata.count
945
946### /redfish/v1/Systems/system/Processors/{ProcessorId}/
947
948#### Processor
949
950- InstructionSet
951- Manufacturer
952- MaxSpeedMHz
953- PartNumber
954- ProcessorArchitecture
955- ProcessorId
956- ProcessorType
957- SerialNumber
958- Socket
959- SparePartNumber
960- Status
961- ThrottleCauses
962- Throttled
963- TotalCores
964- TotalThreads
965- Version
966
967### /redfish/v1/Systems/system/ResetActionInfo/
968
969#### ActionInfo
970
971- Parameters/AllowableValues
972- Parameters/DataType
973- Parameters/Required
974
975### /redfish/v1/Systems/system/Storage/
976
977#### StorageCollection
978
979- Members
980- Members@odata.count
981
982### /redfish/v1/Systems/system/Storage/{StorageId}/
983
984#### Storage
985
986- Drives
987- Drives@odata.count
988- Status
989
990### /redfish/v1/Systems/system/Storage/{StorageId}/Drive/{DriveId}/
991
992#### Storage
993
994- CapacityBytes
995- EncryptionStatus
996- Links
997- Status
998
999### /redfish/v1/TaskService/
1000
1001#### TaskService
1002
1003- CompletedTaskOverWritePolicy
1004- DateTime
1005- LifeCycleEventOnTaskStateChange
1006- ServiceEnabled
1007- Status
1008- Tasks
1009
1010### /redfish/v1/TaskService/Tasks/
1011
1012#### TaskCollection
1013
1014- Members
1015- Members@odata.count
1016
1017### /redfish/v1/TelemetryService/
1018
1019#### TelemetryService
1020
1021- MaxReports
1022- MetricReportDefinitions
1023- MetricReports
1024- MinCollectionInterval
1025- Status
1026- Triggers
1027- SupportedCollectionFunctions
1028
1029### /redfish/v1/TelemetryService/MetricReportDefinitions/
1030
1031#### MetricReportDefinitionCollection
1032
1033- Members
1034- Members@odata.count
1035
1036### /redfish/v1/TelemetryService/MetricReportDefinitions/{MetricReportDefinitionId}/
1037
1038#### MetricReportDefinition
1039
1040- AppendLimit
1041- Id
1042- MetricReport
1043- MetricReportDefinitionEnabled
1044- MetricReportDefinitionType
1045- Metrics
1046- Name
1047- ReportActions
1048- ReportUpdates
1049- Schedule
1050- Status
1051
1052### /redfish/v1/TelemetryService/MetricReports/
1053
1054#### MetricReportCollection
1055
1056- Members
1057- Members@odata.count
1058
1059### /redfish/v1/TelemetryService/MetricReports/{MetricReportId}/
1060
1061#### MetricReport
1062
1063- Id
1064- MetricReportDefinition
1065- MetricValues
1066- Name
1067- Timestamp
1068
1069### /redfish/v1/TelemetryService/Triggers/
1070
1071#### TriggersCollection
1072
1073- Members
1074- Members@odata.count
1075
1076### /redfish/v1/UpdateService/
1077
1078#### UpdateService
1079
1080- Actions
1081- Description
1082- FirmwareInventory
1083- HttpPushUri
1084- HttpPushUriOptions
1085- MaxImageSizeBytes
1086- ServiceEnabled
1087
1088### /redfish/v1/UpdateService/FirmwareInventory/
1089
1090#### SoftwareInventoryCollection
1091
1092- Members
1093  - Should Support BMC, ME, CPLD and BIOS
1094- Members@odata.count
1095
1096### /redfish/v1/UpdateService/FirmwareInventory/{SoftwareInventoryId}/
1097
1098#### SoftwareInventory
1099
1100- Description
1101- RelatedItem@odata.count
1102- RelatedItem
1103- Status
1104- Updateable
1105- Version
1106
1107[1]: https://www.dmtf.org/standards/redfish
1108[2]: https://redfish.dmtf.org/schemas/v1/LogService.json
1109[3]:
1110  https://github.com/openbmc/docs/blob/master/architecture/redfish-logging-in-bmcweb.md
1111[4]: https://github.com/openbmc/phosphor-logging
1112