openbmc/bmcweb/Redfish.md

11 [Redfish Service Validator](https://github.com/DMTF/Redfish-Service-Validator "Validator")
25 - @odata.id
26 - @odata.type
27 - Id
28 - Name
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
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
79 - Members
80 - `Members@odata.count`
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
106 - AggregationSources
107 - Description
108 - ServiceEnabled
114 - Members
115 - `Members@odata.count`
121 - HostName
122 - Password
128 - Description
129 - Members
130 - `Members@odata.count`
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
152 - Description
153 - Members
154 - `Members@odata.count`
160 - Description
161 - Members
162   - By default will contain 3 roles, "Administrator", "Operator", and "ReadOnly"
163 - `Members@odata.count`
169 - AssignedPrivileges
170   - For the default roles, the following privileges will be assigned by default
171     - Administrator: Login, ConfigureManager, ConfigureUsers, ConfigureSelf,
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,
179 - OemPrivileges
180 - RoleId
186 - Description
187 - Members
188 - `Members@odata.count`
194 - CableType
195 - LengthMeters
196 - Status
202 - Actions
203 - CertificateLocations
204 - Description
210 - Description
211 - Links/Certificates
212 - Links/Certificates@odata.count
218 - Members
219 - `Members@odata.count`
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
254 - Members (This is dependent on a entity manager association from Chassis to
255   Drives, The name of the association is `chassis<->drive`)
261 - Drives
262 - `Drives@odata.count`
263 - Status (this is dependent on a entity manager association from Chassis to
274 - PowerControl
275 - PowerSupplies
276 - Redundancy
277 - Voltages
283 - Description
284 - Members
285 - `Members@odata.count`
291 - Reading
292 - ReadingRangeMax
293 - ReadingRangeMin
294 - ReadingType
295 - ReadingUnits
296 - SpeedRPM
297 - Status
298 - Thresholds
304 - Fans
305 - Redundancy
306 - Temperatures
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,
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
344 - MemberId
345 - RedundancySet
346 - Mode
347 - Status
348 - MinNumNeeded
349 - MaxNumSupported
355 - Status
356 - ThermalMetrics
362 - TemperatureReadingsCelsius[]/DataSourceUri
363 - TemperatureReadingsCelsius[]/Reading
364 - `TemperatureReadingsCelsius@odata.count`
370 - Description
371 - Members
372 - `Members@odata.count`
378 - Location
379 - Manufacturer
380 - Model
381 - PartNumber
382 - SerialNumber
383 - SparePartNumber
384 - Status
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
403 - MemberId
404 - Status
405 - ReadingVolts
406 - UpperThresholdNonCritical
407 - UpperThresholdCritical
408 - LowerThresholdNonCritical
409 - LowerThresholdCritical
410 - MinReadingRange
411 - MaxReadingRange
412 - PhysicalContext
413 - RelatedItem
419 - MemberId
420 - Status
421 - LininputVoltage
422 - Model
423 - manufacturer
424 - FirmwareVersion
425 - SerialNumber
426 - PartNumber
427 - RelatedItem
428 - Redundancy
434 - MemberId
435 - RedundancySet
436 - Mode
437 - Status
438 - MinNumNeeded
439 - MaxNumSupported
445 - Description
446 - Members
447 - `Members@odata.count`
453 - EfficiencyRatings
454   - EfficiencyPercent
455 - FirmwareVersion
456 - Location
457 - Manufacturer
458 - Model
459 - PartNumber
460 - SerialNumber
461 - SparePartNumber
462 - Status
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
494 - Members
495 - `Members@odata.count`
501 - Id
502 - Destination
503 - EventTypes
504 - Context
505 - HeartbeatIntervalMinutes
506 - OriginResources
507 - RegistryPrefixes
508 - Protocol
509 - SendHeartbeat
515 - Description
516 - `Members@odata.count`
517 - Members
523 - Schema
524 - Description
525 - Languages
526 - `Languages@odata.count`
527 - Location
528 - `Location@odata.count`
534 - Members
535 - `Members@odata.count`
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
575 - Description
576 - Members
577 - `Members@odata.count`
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
618 `Event` type. This is the new Redfish-defined type.
629 with the `-DBMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES=ON` option. This will cause
630 bmcweb to look to [phosphor-logging][4] for any D-Bus log entries. These will
638 - Description
639 - Members
640 - `Members@odata.count`
646 - Entries
647 - OverWritePolicy
648 - Actions
649 - Status
650 - DateTime
651 - MaxNumberOfRecords
657 - Message
658 - Created
659 - EntryType
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
679 - Description
680 - FQDN
681 - HTTP
682 - HTTPS
683 - HostName
684 - IPMI
685 - NTP
686 - SSH
687 - Status
693 - Description
694 - Members
695 - `Members@odata.count`
701 - CertificateString
702 - Description
703 - Issuer
704 - KeyUsage
705 - Subject
706 - ValidNotAfter
707 - ValidNotBefore
713 - Description
714 - error
720 - Description
721 - Members
722   - Should support Base, CommonMessages, and EventingMessages
723 - `Members@odata.count`
729 - Description
730 - Languages
731 - `Languages@odata.count`
732 - Location
733 - `Location@odata.count`
734 - Registry
740 - Description
741 - ServiceEnabled
742 - SessionTimeout
743 - Sessions
749 - Description
750 - Members
751 - `Members@odata.count`
757 - ClientOriginIPAddress
758 - Description
759 - Roles
760 - UserName
766 - Members
767   - Should support one system
768 - `Members@odata.count`
774 - Actions
775 - Description
776 - Links/ActiveSoftwareImage
777 - Links/SoftwareImages
778 - Links/SoftwareImages@odata.count
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
830 - Members
831 - `Members@odata.count`
832 - Description
838 - Members
839 - `Members@odata.count`
845 - Location
846 - Model
847 - PartNumber
848 - SerialNumber
849 - SparePartNumber
850 - Status
856 - Description
857 - Members
858   - Should default to one member, named SEL
859 - `Members@odata.count`
865 - Actions
866 - DateTime
867 - DateTimeLocalOffset
868 - Description
869 - Entries
870 - OverWritePolicy
876 - Description
877 - Members
878 - `Members@odata.count`
884 - AdditionalDataURI
885 - Created
886 - EntryType
887 - Message
888 - Modified
889 - Resolved
890 - Severity
896 - Members
897 - `Members@odata.count`
898 - Description
899 - @odata.nextLink
905 - MessageArgs
906 - Severity
907 - SensorType
908 - Message
909 - MessageId
910 - Created
911 - EntryCode
912 - EntryType
918 - Members
919 - `Members@odata.count`
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
945 - Description
946 - HealthData
952 - Description
953 - Members
954 - `Members@odata.count`
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
978 - Members
979   - Should Support CPU1 and CPU2 for dual socket systems
980 - `Members@odata.count`
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
1007 - Parameters/AllowableValues
1008 - Parameters/DataType
1009 - Parameters/Required
1015 - Members
1016 - `Members@odata.count`
1022 - Drives
1023 - `Drives@odata.count`
1024 - Status
1030 - CapacityBytes
1031 - EncryptionStatus
1032 - Links
1033 - Status
1039 - CompletedTaskOverWritePolicy
1040 - DateTime
1041 - LifeCycleEventOnTaskStateChange
1042 - ServiceEnabled
1043 - Status
1044 - Tasks
1050 - Members
1051 - `Members@odata.count`
1057 - MaxReports
1058 - MetricReportDefinitions
1059 - MetricReports
1060 - MinCollectionInterval
1061 - Status
1062 - Triggers
1063 - SupportedCollectionFunctions
1069 - Members
1070 - `Members@odata.count`
1076 - AppendLimit
1077 - Id
1078 - MetricReport
1079 - MetricReportDefinitionEnabled
1080 - MetricReportDefinitionType
1081 - Metrics
1082 - Name
1083 - ReportActions
1084 - ReportUpdates
1085 - Schedule
1086 - Status
1092 - Members
1093 - `Members@odata.count`
1099 - Id
1100 - MetricReportDefinition
1101 - MetricValues
1102 - Name
1103 - Timestamp
1109 - Members
1110 - `Members@odata.count`
1116 - Actions
1117 - Description
1118 - FirmwareInventory
1119 - HttpPushUri
1120 - HttpPushUriOptions
1121 - MaxImageSizeBytes
1122 - ServiceEnabled
1128 - Members
1129   - Should Support BMC, ME, CPLD and BIOS
1130 - `Members@odata.count`
1136 - Description
1137 - `RelatedItem@odata.count`
1138 - RelatedItem
1139 - Status
1140 - Updateable
1141 - Version
1146   https://github.com/openbmc/docs/blob/master/architecture/redfish-logging-in-bmcweb.md
1147 [4]: https://github.com/openbmc/phosphor-logging