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