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