xref: /openbmc/bmcweb/docs/Redfish.md (revision 378f1d6138791d1d936ae3bc2114ddcafe124ed0)
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 [Redfish Service Validator][2] with no
11warnings or errors
12
13The following redfish schemas and fields are targeted for OpenBMC. This is a
14living document, and these schemas are subject to change.
15
16The latest [Redfish schemas][3] are available from DMTF
17
18If using a previously unused schema, you will need to add it to the included
19schema list in `scripts/update_schemas.py` and run `update_schemas.py`.
20
21Fields common to all schemas
22
23- @odata.id
24- @odata.type
25- Id
26- Name
27
28### /redfish/v1/
29
30#### ServiceRoot
31
32- AccountService
33- AggregationService
34- Cables
35- CertificateService
36- Chassis
37- EventService
38- JsonSchemas
39- Links/ManagerProvidingService
40- Links/Sessions
41- Managers
42- RedfishVersion
43- Registries
44- ServiceIdentification
45- SessionService
46- Systems
47- Tasks
48- TelemetryService
49- UUID
50- UpdateService
51
52### /redfish/v1/AccountService/
53
54#### AccountService
55
56- AccountLockoutDuration
57- AccountLockoutThreshold
58- Accounts
59- Description
60- HTTPBasicAuth
61- LDAP
62- MaxPasswordLength
63- MinPasswordLength
64- MultiFactorAuth/ClientCertificate/Certificates
65- MultiFactorAuth/ClientCertificate/CertificateMappingAttribute
66- MultiFactorAuth/ClientCertificate/Enabled
67- MultiFactorAuth/ClientCertificate/RespondToUnauthenticatedClients
68- Oem/OpenBMC/AuthMethods/BasicAuth
69- Oem/OpenBMC/AuthMethods/Cookie
70- Oem/OpenBMC/AuthMethods/SessionToken
71- Oem/OpenBMC/AuthMethods/TLS
72- Oem/OpenBMC/AuthMethods/XToken
73- Roles
74- ServiceEnabled
75
76### /redfish/v1/AccountService/MultiFactorAuth/ClientCertificate/Certificates
77
78- Members
79- `Members@odata.count`
80
81### /redfish/v1/AccountService/MultiFactorAuth/ClientCertificate/Certificates/{Certificate}
82
83- CertificateString
84- Id
85- Issuer/City
86- Issuer/CommonName
87- Issuer/Country
88- Issuer/Organization
89- Issuer/OrganizationalUnit
90- Issuer/State
91- KeyUsage
92- Subject/City
93- Subject/Country
94- Subject/CommonName
95- Subject/Organization
96- Subject/OrganizationalUnit
97- Subject/State
98- ValidNotAfter
99- ValidNotBefore
100
101### /redfish/v1/AggregationService/
102
103#### AggregationService
104
105- AggregationSources
106- Description
107- ServiceEnabled
108
109### /redfish/v1/AggregationService/AggregationSources
110
111#### AggregationSourceCollection
112
113- Members
114- `Members@odata.count`
115
116### /redfish/v1/AggregationService/AggregationSources/{AggregationSourceId}
117
118#### AggregationSource
119
120- HostName
121- Password
122
123### /redfish/v1/AccountService/Accounts/
124
125#### ManagerAccountCollection
126
127- Description
128- Members
129- `Members@odata.count`
130
131### /redfish/v1/AccountService/Accounts/{ManagerAccountId}/
132
133#### ManagerAccount
134
135- AccountTypes
136- Description
137- Enabled
138- Links/Role
139- Locked
140- `Locked@Redfish.AllowableValues`
141- Password
142- PasswordChangeRequired
143- RoleId
144- StrictAccountTypes
145- UserName
146
147### /redfish/v1/AccountService/LDAP/Certificates/
148
149#### CertificateCollection
150
151- Description
152- Members
153- `Members@odata.count`
154
155### /redfish/v1/AccountService/Roles/
156
157#### RoleCollection
158
159- Description
160- Members
161  - By default will contain 3 roles, "Administrator", "Operator", and "ReadOnly"
162- `Members@odata.count`
163
164### /redfish/v1/AccountService/Roles/{RoleId}/
165
166#### Role
167
168- AssignedPrivileges
169  - For the default roles, the following privileges will be assigned by default
170    - Administrator: Login, ConfigureManager, ConfigureUsers, ConfigureSelf,
171      ConfigureComponents
172    - Operator: Login, ConfigureComponents, ConfigureSelf
173    - ReadOnly: Login, ConfigureSelf
174- Description
175- IsPredefined
176  - Will be set to true for all default roles. If the given role is non-default,
177    or has been modified from default, will be marked as false.
178- OemPrivileges
179- RoleId
180
181### /redfish/v1/Cables/
182
183#### CableCollection
184
185- Description
186- Members
187- `Members@odata.count`
188
189### /redfish/v1/Cables/{CableId}/
190
191#### Cable
192
193- CableType
194- LengthMeters
195- Status
196
197### /redfish/v1/CertificateService/
198
199#### CertificateService
200
201- Actions
202- CertificateLocations
203- Description
204
205### /redfish/v1/CertificateService/CertificateLocations/
206
207#### CertificateLocations
208
209- Description
210- Links/Certificates
211- Links/Certificates@odata.count
212
213### /redfish/v1/Chassis/
214
215#### ChassisCollection
216
217- Members
218- `Members@odata.count`
219
220### /redfish/v1/Chassis/{ChassisId}/
221
222#### Chassis
223
224- Actions
225- AssetTag
226- ChassisType
227- Drives
228- HotPluggable
229- Links/ComputerSystems
230- Links/ManagedBy
231- Location/PartLocation/ServiceLabel
232- LocationIndicatorActive
233- Manufacturer
234- Model
235- PartNumber
236- Power
237- PowerSubsystem
238- PowerState
239- PhysicalSecurity
240- Sensors
241- SerialNumber
242- SparePartNumber
243- Status
244- Thermal
245- ThermalSubsystem
246- UUID
247- Version
248
249### /redfish/v1/Chassis/{ChassisId}/Drive/
250
251#### Drive
252
253- Members (This is dependent on a entity manager association from Chassis to
254  Drives, The name of the association is `chassis<->drive`)
255
256### /redfish/v1/Chassis/{ChassisId}/Drive/{DriveId}/
257
258#### Drive
259
260- Drives
261- `Drives@odata.count`
262- Status (this is dependent on a entity manager association from Chassis to
263  Drives)
264
265### /redfish/v1/Chassis/{ChassisId}/EnvironmentMetrics/
266
267#### EnvironmentMetrics
268
269- PowerWatts/DataSourceUri
270- PowerWatts/Reading
271
272### /redfish/v1/Chassis/{ChassisId}/Power/
273
274#### Power
275
276- PowerControl
277- PowerSupplies
278- Redundancy
279- Voltages
280
281### /redfish/v1/Chassis/{ChassisId}/Sensors/
282
283#### SensorCollection
284
285- Description
286- Members
287- `Members@odata.count`
288
289### /redfish/v1/Chassis/{ChassisId}/Sensors/{Id}/
290
291#### Sensor
292
293- Reading
294- ReadingRangeMax
295- ReadingRangeMin
296- ReadingType
297- ReadingUnits
298- SpeedRPM
299- Status
300- Thresholds
301
302### /redfish/v1/Chassis/{ChassisId}/Thermal/
303
304#### Thermal
305
306- Fans
307- Redundancy
308- Temperatures
309
310### /redfish/v1/Chassis/{ChassisId}/Thermal#/Temperatures/{SensorName}/
311
312#### Temperature
313
314- MemberId
315- Status
316- ReadingCelsius
317- UpperThresholdNonCritical
318- UpperThresholdCritical
319- LowerThresholdNonCritical
320- LowerThresholdCritical
321- MinReadingRange
322- MaxReadingRange _threshold fields only present if defined for sensor,
323  otherwise absent_
324
325### /redfish/v1/Chassis/{ChassisId}/Thermal#/Fans/{FanName}/
326
327#### Fan
328
329- MemberId
330- Status
331- Reading
332- ReadingUnits
333- UpperThresholdNonCritical
334- UpperThresholdCritical
335- LowerThresholdNonCritical
336- LowerThresholdCritical
337- MinReadingRange
338- MaxReadingRange
339- Redundancy _threshold fields only present if defined for sensor, otherwise
340  absent_
341
342### /redfish/v1/Chassis/{ChassisId}/Thermal#/Redundancy/{RedundancyName}/
343
344#### Redundancy
345
346- MemberId
347- RedundancySet
348- Mode
349- Status
350- MinNumNeeded
351- MaxNumSupported
352
353### /redfish/v1/Chassis/{ChassisId}/ThermalSubsystem
354
355#### ThermalSubsystem
356
357- Status
358- ThermalMetrics
359
360#### /redfish/v1/Chassis/{ChassisId}/ThermalSubsystem/ThermalMetrics/
361
362##### ThermalMetrics
363
364- TemperatureReadingsCelsius[]/DataSourceUri
365- TemperatureReadingsCelsius[]/Reading
366- `TemperatureReadingsCelsius@odata.count`
367
368#### /redfish/v1/Chassis/{ChassisId}/ThermalSubsystem/Fans
369
370##### FansCollection
371
372- Description
373- Members
374- `Members@odata.count`
375
376#### /redfish/v1/Chassis/{ChassisId}/ThermalSubsystem/Fans/{FanName}/
377
378#### Fan
379
380- Location
381- LocationIndicatorActive
382- Manufacturer
383- Model
384- PartNumber
385- SerialNumber
386- SparePartNumber
387- Status
388
389### /redfish/v1/Chassis/{ChassisId}/Power#/PowerControl/{ControlName}/
390
391#### PowerControl
392
393- MemberId
394- PowerConsumedWatts
395- PowerMetrics/IntervalInMin
396- PowerMetrics/MinConsumedWatts
397- PowerMetrics/MaxConsumedWatts
398- PowerMetrics/AverageConsumedWatts
399- RelatedItem
400  - Should list systems and related chassis
401
402### /redfish/v1/Chassis/{ChassisId}/Power#/Voltages/{VoltageName}/
403
404#### Voltage
405
406- MemberId
407- Status
408- ReadingVolts
409- UpperThresholdNonCritical
410- UpperThresholdCritical
411- LowerThresholdNonCritical
412- LowerThresholdCritical
413- MinReadingRange
414- MaxReadingRange
415- PhysicalContext
416- RelatedItem
417
418### /redfish/v1/Chassis/{ChassisId}/Power#/PowerSupplies/{PSUName}/
419
420#### PowerSupply
421
422- MemberId
423- Status
424- LininputVoltage
425- Model
426- manufacturer
427- FirmwareVersion
428- SerialNumber
429- PartNumber
430- RelatedItem
431- Redundancy
432
433### /redfish/v1/Chassis/{ChassisId}/Power#/Redundancy/{RedundancyName}/
434
435#### Redundancy
436
437- MemberId
438- RedundancySet
439- Mode
440- Status
441- MinNumNeeded
442- MaxNumSupported
443
444#### /redfish/v1/Chassis/{ChassisId}/PowerSubsystem/PowerSupplies
445
446##### PowerSupplies
447
448- Description
449- Members
450- `Members@odata.count`
451
452#### /redfish/v1/Chassis/{ChassisId}/PowerSubsystem/PowerSupplies/{PowerSupplyId}
453
454##### PowerSupply
455
456- EfficiencyRatings
457  - EfficiencyPercent
458- FirmwareVersion
459- Location
460- LocationIndicatorActive
461- Manufacturer
462- Model
463- PartNumber
464- SerialNumber
465- SparePartNumber
466- Status
467
468#### /redfish/v1/Chassis/{ChassisId}/Assembly
469
470##### Assemblies
471
472- Assemblies
473- `Assemblies@odata.count`
474
475###### Assembly
476
477- Model
478- PartNumber
479- SerialNumber
480- SparePartNumber
481
482### /redfish/v1/EventService/
483
484#### EventService
485
486- Actions
487- SubmitTestEvent
488  - eventGroupId
489  - eventId
490  - eventTimestamp
491  - message
492  - messageArgs
493  - messageId
494  - originOfCondition
495  - resolution
496  - severity
497- DeliveryRetryAttempts
498  - Defaults to 3
499- DeliveryRetryIntervalSeconds
500- EventFormatTypes
501- RegistryPrefixes
502- ResourceTypes
503- SSEFilterPropertiesSupported
504- ServiceEnabled
505- Status
506- Subscriptions
507
508### /redfish/v1/EventService/Subscriptions/
509
510#### EventDestinationCollection
511
512- Members
513- `Members@odata.count`
514
515### /redfish/v1/EventService/Subscriptions/{EventName}/
516
517#### EventDestination
518
519- Id
520- Destination
521- EventTypes
522- Context
523- HeartbeatIntervalMinutes
524- OriginResources
525- RegistryPrefixes
526- Protocol
527- SendHeartbeat
528
529### /redfish/v1/JsonSchemas/
530
531#### JsonSchemaFileCollection
532
533- Description
534- `Members@odata.count`
535- Members
536
537### /redfish/v1/JsonSchemas/{Id}/
538
539#### JsonSchemaFile
540
541- Schema
542- Description
543- Languages
544- `Languages@odata.count`
545- Location
546- `Location@odata.count`
547
548### /redfish/v1/Managers/
549
550#### ManagerCollection
551
552- Members
553- `Members@odata.count`
554
555### /redfish/v1/Managers/bmc/
556
557#### Manager
558
559- Actions
560- DateTime
561- DateTimeLocalOffset
562- Description
563- EthernetInterfaces
564- FirmwareVersion
565- GraphicalConsole
566- LastResetTime
567- Links/ActiveSoftwareImage
568- Links/ManagerForChassis
569- Links/ManagerForChassis@odata.count
570- Links/ManagerForServers
571- Links/ManagerForServers@odata.count
572- Links/ManagerInChassis
573- Links/SoftwareImages
574- Links/SoftwareImages@odata.count
575- LocationIndicatorActive
576- LogServices
577- ManagerType
578- Manufacturer
579- Model
580- NetworkProtocol
581- Oem
582- PartNumber
583- PowerState
584- SerialNumber
585- ServiceEntryPointUUID
586- ServiceIdentification
587- SparePartNumber
588- Status
589- UUID
590
591### /redfish/v1/Managers/bmc/EthernetInterfaces/
592
593#### EthernetInterfaceCollection
594
595- Description
596- Members
597- `Members@odata.count`
598
599### /redfish/v1/Managers/bmc/EthernetInterfaces/{EthernetInterfaceId}/
600
601#### EthernetInterface
602
603- DHCPv4
604- DHCPv6
605- Description
606- EthernetInterfaceType
607- FQDN
608- HostName
609- IPv4Addresses
610- IPv4StaticAddresses
611- IPv6AddressPolicyTable
612- IPv6Addresses
613- IPv6DefaultGateway
614- IPv6StaticAddresses
615- IPv6StaticDefaultGateways
616- InterfaceEnabled
617- Links/RelatedInterfaces
618- LinkStatus
619- MACAddress
620- NameServers
621- SpeedMbps
622- StatelessAddressAutoConfig
623- StaticNameServers
624- Status
625- VLAN/VLANEnable
626- VLAN/VLANId
627- VLAN/Tagged
628
629### /redfish/v1/Managers/bmc/LogServices/
630
631The [LogService][4] resource provides properties for monitoring and configuring
632events for the service or resource to which it is associated.
633
634Within bmcweb, the LogService object resides under the System resource. It
635tracks all events for the system.
636
637The LogService supports multiple log entry types. bmcweb has support for the
638`Event` type. This is the new Redfish-defined type.
639
640bmcweb supports two different implementations of the
641`LogService/EventLog/Entries` URI.
642
643The default implementation uses rsyslog to write Redfish events from the journal
644to the persistent /var/log/ filesystem. The bmcweb software then looks for these
645files in /var/log/ and returns the appropriate Redfish EventLog Entries for
646these. [More details][5] on adding events are available.
647
648The other implementation of EventLog Entries can be enabled by compiling bmcweb
649with the `-DBMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES=ON` option. This will cause
650bmcweb to look to [phosphor-logging][6] for any D-Bus log entries. These will
651then be translated to Redfish EventLog Entries.
652
653These two implementations do not work together, so choosing one will disable the
654other.
655
656#### LogServiceCollection
657
658- Description
659- Members
660- `Members@odata.count`
661
662### /redfish/v1/Managers/bmc/LogServices/RedfishLog/
663
664#### LogService
665
666- Entries
667- OverWritePolicy
668- Actions
669- Status
670- DateTime
671- MaxNumberOfRecords
672
673### /redfish/v1/Managers/bmc/LogServices/RedfishLog/Entries/{LogEntryId}/
674
675#### LogEntry
676
677- Message
678- Created
679- EntryType
680
681### /redfish/v1/Managers/bmc/ManagerDiagnosticData/
682
683#### ManagerDiagnosticData
684
685- ServiceRootUptimeSeconds
686- FreeStorageSpaceKiB
687- MemoryStatistics/AvailableBytes
688- MemoryStatistics/BuffersAndCacheBytes
689- MemoryStatistics/FreeBytes
690- MemoryStatistics/SharedBytes
691- MemoryStatistics/TotalBytes
692- ProcessorStatistics/KernelPercent
693- ProcessorStatistics/UserPercent
694
695### /redfish/v1/Managers/bmc/NetworkProtocol/
696
697#### ManagerNetworkProtocol
698
699- Description
700- FQDN
701- HTTP
702- HTTPS
703- HostName
704- IPMI
705- NTP
706- SSH
707- Status
708
709### /redfish/v1/Managers/bmc/NetworkProtocol/HTTPS/Certificates/
710
711#### CertificateCollection
712
713- Description
714- Members
715- `Members@odata.count`
716
717### /redfish/v1/Managers/bmc/NetworkProtocol/HTTPS/Certificates/{CertificateId}/
718
719#### Certificate
720
721- CertificateString
722- Description
723- Issuer
724- KeyUsage
725- Subject
726- ValidNotAfter
727- ValidNotBefore
728
729### /redfish/v1/Managers/bmc/Truststore/Certificates/
730
731#### CertificateCollection
732
733- Description
734- error
735
736### /redfish/v1/Registries/
737
738#### MessageRegistryFileCollection
739
740- Description
741- Members
742  - Should support Base, CommonMessages, and EventingMessages
743- `Members@odata.count`
744
745### /redfish/v1/Registries/{MessageRegistryFileId}/
746
747#### MessageRegistryFile
748
749- Description
750- Languages
751- `Languages@odata.count`
752- Location
753- `Location@odata.count`
754- Registry
755
756### /redfish/v1/SessionService/
757
758#### SessionService
759
760- Description
761- ServiceEnabled
762- SessionTimeout
763- Sessions
764
765### /redfish/v1/SessionService/Sessions/
766
767#### SessionCollection
768
769- Description
770- Members
771- `Members@odata.count`
772
773### /redfish/v1/SessionService/Sessions/{SessionId}/
774
775#### Session
776
777- ClientOriginIPAddress
778- Description
779- Roles
780- UserName
781
782### /redfish/v1/Systems/
783
784#### ComputerSystemCollection
785
786- Members
787  - Should support one system
788- `Members@odata.count`
789
790### /redfish/v1/Systems/system/Bios/
791
792#### Bios
793
794- Actions
795- Description
796- Links/ActiveSoftwareImage
797- Links/SoftwareImages
798- Links/SoftwareImages@odata.count
799
800### /redfish/v1/Systems/system/
801
802#### ComputerSystem
803
804- Actions
805- AssetTag
806- Bios
807- BiosVersion
808- Boot
809- BootProgress
810- Description
811- FabricAdapters
812- HostWatchdogTimer
813- IdlePowerSaver/Enable
814- IdlePowerSaver/EnterUtilizationPercent
815- IdlePowerSaver/EnterDwellTimeSeconds
816- IdlePowerSaver/ExitUtilizationPercent
817- IdlePowerSaver/ExitDwellTimeSeconds
818- IndicatorLED
819- LastResetTime
820- Links/Chassis
821- Links/ManagedBy
822- LocationIndicatorActive
823- LogServices
824- Manufacturer
825- Memory
826- MemorySummary
827- Model
828- PCIeDevices
829- PartNumber
830- PowerMode
831- PowerRestorePolicy
832- PowerState
833- ProcessorSummary
834- Processors
835- SerialConsole/IPMI/ServiceEnabled
836- SerialConsole/MaxConcurrentSessions
837- SerialConsole/SSH/HotKeySequenceDisplay
838- SerialConsole/SSH/Port
839- SerialConsole/SSH/ServiceEnabled
840- SerialNumber
841- Status
842- Storage
843- SubModel
844- SystemType
845
846### /redfish/v1/Systems/system/EthernetInterfaces/
847
848#### EthernetInterfaceCollection
849
850- Members
851- `Members@odata.count`
852- Description
853
854### /redfish/v1/Systems/system/FabricAdapters/
855
856#### FabricAdapterCollection
857
858- Members
859- `Members@odata.count`
860
861### /redfish/v1/Systems/system/FabricAdapters/{FabricAdapterId}/
862
863#### FabricAdapter
864
865- Location
866- LocationIndicatorActive
867- Model
868- PartNumber
869- Ports
870- SerialNumber
871- SparePartNumber
872- Status
873
874### /redfish/v1/Systems/system/FabricAdapters/{FabricAdapterId}/Ports/
875
876#### PortCollection
877
878- Members
879- `Members@odata.count`
880
881### /redfish/v1/Systems/system/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/
882
883#### Port
884
885- Location
886- LocationIndicatorActive
887- Status
888
889### /redfish/v1/Systems/system/LogServices/
890
891#### LogServiceCollection
892
893- Description
894- Members
895  - Should default to one member, named SEL
896- `Members@odata.count`
897
898### /redfish/v1/Systems/system/LogServices/EventLog/
899
900#### LogService
901
902- Actions
903- DateTime
904- DateTimeLocalOffset
905- Description
906- Entries
907- OverWritePolicy
908
909### /redfish/v1/Systems/system/LogServices/EventLog/Entries/
910
911#### LogEntryCollection
912
913- Description
914- Members
915- `Members@odata.count`
916
917### /redfish/v1/Systems/system/LogServices/EventLog/Entries/{LogEntryId}/
918
919#### LogEntry
920
921- AdditionalDataURI
922- Created
923- EntryType
924- Message
925- Modified
926- Resolved
927- Severity
928
929### /redfish/v1/Systems/system/LogServices/SEL/Entries/
930
931#### LogEntryCollection
932
933- Members
934- `Members@odata.count`
935- Description
936- @odata.nextLink
937
938### /redfish/v1/Systems/system/LogServices/SEL/Entries/{LogEntryId}/
939
940#### LogEntry
941
942- MessageArgs
943- Severity
944- SensorType
945- Message
946- MessageId
947- Created
948- EntryCode
949- EntryType
950
951### /redfish/v1/Systems/system/Memory/
952
953#### MemoryCollection
954
955- Members
956- `Members@odata.count`
957
958### /redfish/v1/Systems/system/Memory/{MemoryId}/
959
960#### Memory
961
962- AllowedSpeedsMHz
963- BaseModuleType
964- BusWidthBits
965- CapacityMiB
966- DataWidthBits
967- ErrorCorrection
968- FirmwareRevision
969- LocationIndicatorActive
970- Manufacturer
971- Model
972- OperatingSpeedMhz
973- PartNumber
974- RankCount
975- SerialNumber
976- SparePartNumber
977- Status
978
979### /redfish/v1/Systems/system/Memory/{MemoryId}/MemoryMetrics/
980
981#### MemoryMetrics
982
983- Description
984- HealthData
985
986### /redfish/v1/Systems/system/PCIeDevices/
987
988#### PCIeDeviceCollection
989
990- Description
991- Members
992- `Members@odata.count`
993
994### /redfish/v1/Systems/system/PCIeDevices/{PCIeDevice}/
995
996- Manufacturer
997- Model
998- PartNumber
999- PCIeInterface
1000  - LanesInUse
1001  - MaxLanes
1002  - MaxPCIeType
1003  - PCIeType
1004- SerialNumber
1005- Slot
1006  - Lanes
1007  - PCIeType
1008  - SlotType
1009- SparePartNumber
1010- Status
1011
1012### /redfish/v1/Systems/system/Processors/
1013
1014#### ProcessorCollection
1015
1016- Members
1017  - Should Support CPU1 and CPU2 for dual socket systems
1018- `Members@odata.count`
1019
1020### /redfish/v1/Systems/system/Processors/{ProcessorId}/
1021
1022#### Processor
1023
1024- InstructionSet
1025- LocationIndicatorActive
1026- Manufacturer
1027- MaxSpeedMHz
1028- PartNumber
1029- ProcessorArchitecture
1030- ProcessorId
1031- ProcessorType
1032- SerialNumber
1033- Socket
1034- SparePartNumber
1035- Status
1036- ThrottleCauses
1037- Throttled
1038- TotalCores
1039- TotalThreads
1040- Version
1041
1042### /redfish/v1/Systems/system/ResetActionInfo/
1043
1044#### ActionInfo
1045
1046- Parameters/AllowableValues
1047- Parameters/DataType
1048- Parameters/Required
1049
1050### /redfish/v1/Systems/system/Storage/
1051
1052#### StorageCollection
1053
1054- Members
1055- `Members@odata.count`
1056
1057### /redfish/v1/Systems/system/Storage/{StorageId}/
1058
1059#### Storage
1060
1061- Drives
1062- `Drives@odata.count`
1063- Status
1064
1065### /redfish/v1/Systems/system/Storage/{StorageId}/Drive/{DriveId}/
1066
1067#### Storage
1068
1069- CapacityBytes
1070- EncryptionStatus
1071- Links
1072- Status
1073
1074### /redfish/v1/TaskService/
1075
1076#### TaskService
1077
1078- CompletedTaskOverWritePolicy
1079- DateTime
1080- LifeCycleEventOnTaskStateChange
1081- ServiceEnabled
1082- Status
1083- Tasks
1084
1085### /redfish/v1/TaskService/Tasks/
1086
1087#### TaskCollection
1088
1089- Members
1090- `Members@odata.count`
1091
1092### /redfish/v1/TelemetryService/
1093
1094#### TelemetryService
1095
1096- MaxReports
1097- MetricReportDefinitions
1098- MetricReports
1099- MinCollectionInterval
1100- Status
1101- Triggers
1102- SupportedCollectionFunctions
1103
1104### /redfish/v1/TelemetryService/MetricReportDefinitions/
1105
1106#### MetricReportDefinitionCollection
1107
1108- Members
1109- `Members@odata.count`
1110
1111### /redfish/v1/TelemetryService/MetricReportDefinitions/{MetricReportDefinitionId}/
1112
1113#### MetricReportDefinition
1114
1115- AppendLimit
1116- Id
1117- MetricReport
1118- MetricReportDefinitionEnabled
1119- MetricReportDefinitionType
1120- Metrics
1121- Name
1122- ReportActions
1123- ReportUpdates
1124- Schedule
1125- Status
1126
1127### /redfish/v1/TelemetryService/MetricReports/
1128
1129#### MetricReportCollection
1130
1131- Members
1132- `Members@odata.count`
1133
1134### /redfish/v1/TelemetryService/MetricReports/{MetricReportId}/
1135
1136#### MetricReport
1137
1138- Id
1139- MetricReportDefinition
1140- MetricValues
1141- Name
1142- Timestamp
1143
1144### /redfish/v1/TelemetryService/Triggers/
1145
1146#### TriggersCollection
1147
1148- Members
1149- `Members@odata.count`
1150
1151### /redfish/v1/UpdateService/
1152
1153#### UpdateService
1154
1155- Actions
1156- Description
1157- FirmwareInventory
1158- HttpPushUri
1159- HttpPushUriOptions
1160- MaxImageSizeBytes
1161- MultipartHttpPushUri
1162- ServiceEnabled
1163
1164### /redfish/v1/UpdateService/FirmwareInventory/
1165
1166#### SoftwareInventoryCollection
1167
1168- Members
1169  - Should Support BMC, ME, CPLD and BIOS
1170- `Members@odata.count`
1171
1172### /redfish/v1/UpdateService/FirmwareInventory/{SoftwareInventoryId}/
1173
1174#### SoftwareInventory
1175
1176- Description
1177- LowestSupportedVersion
1178- `RelatedItem@odata.count`
1179- RelatedItem
1180- Status
1181- Updateable
1182- Version
1183
1184[1]: https://www.dmtf.org/standards/redfish
1185[2]: https://github.com/DMTF/Redfish-Service-Validator
1186[3]: https://redfish.dmtf.org/schemas/
1187[4]: https://redfish.dmtf.org/schemas/v1/LogService.json
1188[5]:
1189  https://github.com/openbmc/docs/blob/master/architecture/redfish-logging-in-bmcweb.md
1190[6]: https://github.com/openbmc/phosphor-logging
1191