openbmc/bmcweb/Redfish.md

23 - @odata.id
24 - @odata.type
25 - Id
26 - Name
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 - SessionService
45 - Systems
46 - Tasks
47 - TelemetryService
48 - UUID
49 - UpdateService
55 - AccountLockoutDuration
56 - AccountLockoutThreshold
57 - Accounts
58 - Description
59 - HTTPBasicAuth
60 - LDAP
61 - MaxPasswordLength
62 - MinPasswordLength
63 - MultiFactorAuth/ClientCertificate/Certificates
64 - MultiFactorAuth/ClientCertificate/CertificateMappingAttribute
65 - MultiFactorAuth/ClientCertificate/Enabled
66 - MultiFactorAuth/ClientCertificate/RespondToUnauthenticatedClients
67 - Oem/OpenBMC/AuthMethods/BasicAuth
68 - Oem/OpenBMC/AuthMethods/Cookie
69 - Oem/OpenBMC/AuthMethods/SessionToken
70 - Oem/OpenBMC/AuthMethods/TLS
71 - Oem/OpenBMC/AuthMethods/XToken
72 - Roles
73 - ServiceEnabled
77 - Members
78 - `Members@odata.count`
82 - CertificateString
83 - Id
84 - Issuer/City
85 - Issuer/CommonName
86 - Issuer/Country
87 - Issuer/Organization
88 - Issuer/OrganizationalUnit
89 - Issuer/State
90 - KeyUsage
91 - Subject/City
92 - Subject/Country
93 - Subject/CommonName
94 - Subject/Organization
95 - Subject/OrganizationalUnit
96 - Subject/State
97 - ValidNotAfter
98 - ValidNotBefore
104 - AggregationSources
105 - Description
106 - ServiceEnabled
112 - Members
113 - `Members@odata.count`
119 - HostName
120 - Password
126 - Description
127 - Members
128 - `Members@odata.count`
134 - AccountTypes
135 - Description
136 - Enabled
137 - Links/Role
138 - Locked
139 - `Locked@Redfish.AllowableValues`
140 - Password
141 - PasswordChangeRequired
142 - RoleId
143 - StrictAccountTypes
144 - UserName
150 - Description
151 - Members
152 - `Members@odata.count`
158 - Description
159 - Members
160   - By default will contain 3 roles, "Administrator", "Operator", and "ReadOnly"
161 - `Members@odata.count`
167 - AssignedPrivileges
168   - For the default roles, the following privileges will be assigned by default
169     - Administrator: Login, ConfigureManager, ConfigureUsers, ConfigureSelf,
171     - Operator: Login, ConfigureComponents, ConfigureSelf
172     - ReadOnly: Login, ConfigureSelf
173 - Description
174 - IsPredefined
175   - Will be set to true for all default roles. If the given role is non-default,
177 - OemPrivileges
178 - RoleId
184 - Description
185 - Members
186 - `Members@odata.count`
192 - CableType
193 - LengthMeters
194 - Status
200 - Actions
201 - CertificateLocations
202 - Description
208 - Description
209 - Links/Certificates
210 - Links/Certificates@odata.count
216 - Members
217 - `Members@odata.count`
223 - Actions
224 - AssetTag
225 - ChassisType
226 - Drives
227 - HotPluggable
228 - Links/ComputerSystems
229 - Links/ManagedBy
230 - Location/PartLocation/ServiceLabel
231 - LocationIndicatorActive
232 - Manufacturer
233 - Model
234 - PartNumber
235 - Power
236 - PowerSubsystem
237 - PowerState
238 - PhysicalSecurity
239 - Sensors
240 - SerialNumber
241 - SparePartNumber
242 - Status
243 - Thermal
244 - ThermalSubsystem
245 - UUID
246 - Version
252 - Members (This is dependent on a entity manager association from Chassis to
253   Drives, The name of the association is `chassis<->drive`)
259 - Drives
260 - `Drives@odata.count`
261 - Status (this is dependent on a entity manager association from Chassis to
272 - PowerControl
273 - PowerSupplies
274 - Redundancy
275 - Voltages
281 - Description
282 - Members
283 - `Members@odata.count`
289 - Reading
290 - ReadingRangeMax
291 - ReadingRangeMin
292 - ReadingType
293 - ReadingUnits
294 - SpeedRPM
295 - Status
296 - Thresholds
302 - Fans
303 - Redundancy
304 - Temperatures
310 - MemberId
311 - Status
312 - ReadingCelsius
313 - UpperThresholdNonCritical
314 - UpperThresholdCritical
315 - LowerThresholdNonCritical
316 - LowerThresholdCritical
317 - MinReadingRange
318 - MaxReadingRange _threshold fields only present if defined for sensor,
325 - MemberId
326 - Status
327 - Reading
328 - ReadingUnits
329 - UpperThresholdNonCritical
330 - UpperThresholdCritical
331 - LowerThresholdNonCritical
332 - LowerThresholdCritical
333 - MinReadingRange
334 - MaxReadingRange
335 - Redundancy _threshold fields only present if defined for sensor, otherwise
342 - MemberId
343 - RedundancySet
344 - Mode
345 - Status
346 - MinNumNeeded
347 - MaxNumSupported
353 - Status
354 - ThermalMetrics
360 - TemperatureReadingsCelsius[]/DataSourceUri
361 - TemperatureReadingsCelsius[]/Reading
362 - `TemperatureReadingsCelsius@odata.count`
368 - Description
369 - Members
370 - `Members@odata.count`
376 - Location
377 - LocationIndicatorActive
378 - Manufacturer
379 - Model
380 - PartNumber
381 - SerialNumber
382 - SparePartNumber
383 - Status
389 - MemberId
390 - PowerConsumedWatts
391 - PowerMetrics/IntervalInMin
392 - PowerMetrics/MinConsumedWatts
393 - PowerMetrics/MaxConsumedWatts
394 - PowerMetrics/AverageConsumedWatts
395 - RelatedItem
396   - Should list systems and related chassis
402 - MemberId
403 - Status
404 - ReadingVolts
405 - UpperThresholdNonCritical
406 - UpperThresholdCritical
407 - LowerThresholdNonCritical
408 - LowerThresholdCritical
409 - MinReadingRange
410 - MaxReadingRange
411 - PhysicalContext
412 - RelatedItem
418 - MemberId
419 - Status
420 - LininputVoltage
421 - Model
422 - manufacturer
423 - FirmwareVersion
424 - SerialNumber
425 - PartNumber
426 - RelatedItem
427 - Redundancy
433 - MemberId
434 - RedundancySet
435 - Mode
436 - Status
437 - MinNumNeeded
438 - MaxNumSupported
444 - Description
445 - Members
446 - `Members@odata.count`
452 - EfficiencyRatings
453   - EfficiencyPercent
454 - FirmwareVersion
455 - Location
456 - LocationIndicatorActive
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][6] 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 - LocationIndicatorActive
847 - Model
848 - PartNumber
849 - SerialNumber
850 - SparePartNumber
851 - Status
857 - Description
858 - Members
859   - Should default to one member, named SEL
860 - `Members@odata.count`
866 - Actions
867 - DateTime
868 - DateTimeLocalOffset
869 - Description
870 - Entries
871 - OverWritePolicy
877 - Description
878 - Members
879 - `Members@odata.count`
885 - AdditionalDataURI
886 - Created
887 - EntryType
888 - Message
889 - Modified
890 - Resolved
891 - Severity
897 - Members
898 - `Members@odata.count`
899 - Description
900 - @odata.nextLink
906 - MessageArgs
907 - Severity
908 - SensorType
909 - Message
910 - MessageId
911 - Created
912 - EntryCode
913 - EntryType
919 - Members
920 - `Members@odata.count`
926 - AllowedSpeedsMHz
927 - BaseModuleType
928 - BusWidthBits
929 - CapacityMiB
930 - DataWidthBits
931 - ErrorCorrection
932 - FirmwareRevision
933 - LocationIndicatorActive
934 - Manufacturer
935 - Model
936 - OperatingSpeedMhz
937 - PartNumber
938 - RankCount
939 - SerialNumber
940 - SparePartNumber
941 - Status
947 - Description
948 - HealthData
954 - Description
955 - Members
956 - `Members@odata.count`
960 - Manufacturer
961 - Model
962 - PartNumber
963 - PCIeInterface
964   - LanesInUse
965   - MaxLanes
966   - MaxPCIeType
967   - PCIeType
968 - SerialNumber
969 - Slot
970   - Lanes
971   - PCIeType
972   - SlotType
973 - SparePartNumber
974 - Status
980 - Members
981   - Should Support CPU1 and CPU2 for dual socket systems
982 - `Members@odata.count`
988 - InstructionSet
989 - LocationIndicatorActive
990 - Manufacturer
991 - MaxSpeedMHz
992 - PartNumber
993 - ProcessorArchitecture
994 - ProcessorId
995 - ProcessorType
996 - SerialNumber
997 - Socket
998 - SparePartNumber
999 - Status
1000 - ThrottleCauses
1001 - Throttled
1002 - TotalCores
1003 - TotalThreads
1004 - Version
1010 - Parameters/AllowableValues
1011 - Parameters/DataType
1012 - Parameters/Required
1018 - Members
1019 - `Members@odata.count`
1025 - Drives
1026 - `Drives@odata.count`
1027 - Status
1033 - CapacityBytes
1034 - EncryptionStatus
1035 - Links
1036 - Status
1042 - CompletedTaskOverWritePolicy
1043 - DateTime
1044 - LifeCycleEventOnTaskStateChange
1045 - ServiceEnabled
1046 - Status
1047 - Tasks
1053 - Members
1054 - `Members@odata.count`
1060 - MaxReports
1061 - MetricReportDefinitions
1062 - MetricReports
1063 - MinCollectionInterval
1064 - Status
1065 - Triggers
1066 - SupportedCollectionFunctions
1072 - Members
1073 - `Members@odata.count`
1079 - AppendLimit
1080 - Id
1081 - MetricReport
1082 - MetricReportDefinitionEnabled
1083 - MetricReportDefinitionType
1084 - Metrics
1085 - Name
1086 - ReportActions
1087 - ReportUpdates
1088 - Schedule
1089 - Status
1095 - Members
1096 - `Members@odata.count`
1102 - Id
1103 - MetricReportDefinition
1104 - MetricValues
1105 - Name
1106 - Timestamp
1112 - Members
1113 - `Members@odata.count`
1119 - Actions
1120 - Description
1121 - FirmwareInventory
1122 - HttpPushUri
1123 - HttpPushUriOptions
1124 - MaxImageSizeBytes
1125 - MultipartHttpPushUri
1126 - ServiceEnabled
1132 - Members
1133   - Should Support BMC, ME, CPLD and BIOS
1134 - `Members@odata.count`
1140 - Description
1141 - LowestSupportedVersion
1142 - `RelatedItem@odata.count`
1143 - RelatedItem
1144 - Status
1145 - Updateable
1146 - Version
1149 [2]: https://github.com/DMTF/Redfish-Service-Validator
1153   https://github.com/openbmc/docs/blob/master/architecture/redfish-logging-in-bmcweb.md
1154 [6]: https://github.com/openbmc/phosphor-logging