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