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