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