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