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