1 /* 2 // Copyright (c) 2018-2019 Intel Corporation 3 // 4 // Licensed under the Apache License, Version 2.0 (the "License"); 5 // you may not use this file except in compliance with the License. 6 // You may obtain a copy of the License at 7 // 8 // http://www.apache.org/licenses/LICENSE-2.0 9 // 10 // Unless required by applicable law or agreed to in writing, software 11 // distributed under the License is distributed on an "AS IS" BASIS, 12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 // See the License for the specific language governing permissions and 14 // limitations under the License. 15 */ 16 #pragma once 17 18 #include "../lib/account_service.hpp" 19 #include "../lib/bios.hpp" 20 #include "../lib/certificate_service.hpp" 21 #include "../lib/chassis.hpp" 22 #include "../lib/ethernet.hpp" 23 #include "../lib/event_service.hpp" 24 #include "../lib/log_services.hpp" 25 #include "../lib/managers.hpp" 26 #include "../lib/memory.hpp" 27 #include "../lib/message_registries.hpp" 28 #include "../lib/metric_report.hpp" 29 #include "../lib/metric_report_definition.hpp" 30 #include "../lib/network_protocol.hpp" 31 #include "../lib/pcie.hpp" 32 #include "../lib/power.hpp" 33 #include "../lib/processor.hpp" 34 #include "../lib/redfish_sessions.hpp" 35 #include "../lib/roles.hpp" 36 #include "../lib/sensors.hpp" 37 #include "../lib/service_root.hpp" 38 #include "../lib/storage.hpp" 39 #include "../lib/systems.hpp" 40 #include "../lib/task.hpp" 41 #include "../lib/telemetry_service.hpp" 42 #include "../lib/thermal.hpp" 43 #include "../lib/update_service.hpp" 44 #ifdef BMCWEB_ENABLE_VM_NBDPROXY 45 #include "../lib/virtual_media.hpp" 46 #endif // BMCWEB_ENABLE_VM_NBDPROXY 47 #include "../lib/hypervisor_system.hpp" 48 49 namespace redfish 50 { 51 /* 52 * @brief Top level class installing and providing Redfish services 53 */ 54 class RedfishService 55 { 56 public: 57 /* 58 * @brief Redfish service constructor 59 * 60 * Loads Redfish configuration and installs schema resources 61 * 62 * @param[in] app Crow app on which Redfish will initialize 63 */ 64 RedfishService(App& app) 65 { 66 requestAccountServiceRoutes(app); 67 requestRoutesRoles(app); 68 requestRoutesRoleCollection(app); 69 requestRoutesServiceRoot(app); 70 requestRoutesNetworkProtocol(app); 71 requestRoutesSession(app); 72 requestEthernetInterfacesRoutes(app); 73 requestRoutesThermal(app); 74 requestRoutesManagerCollection(app); 75 requestRoutesManager(app); 76 requestRoutesManagerResetAction(app); 77 requestRoutesManagerResetActionInfo(app); 78 requestRoutesManagerResetToDefaultsAction(app); 79 requestRoutesPower(app); 80 requestRoutesChassisCollection(app); 81 requestRoutesChassis(app); 82 requestRoutesChassisResetAction(app); 83 requestRoutesChassisResetActionInfo(app); 84 requestRoutesUpdateService(app); 85 requestRoutesStorageCollection(app); 86 requestRoutesStorage(app); 87 requestRoutesDrive(app); 88 #ifdef BMCWEB_INSECURE_ENABLE_REDFISH_FW_TFTP_UPDATE 89 requestRoutesUpdateServiceActionsSimpleUpdate(app); 90 #endif 91 requestRoutesSoftwareInventoryCollection(app); 92 requestRoutesSoftwareInventory(app); 93 94 requestRoutesSystemLogServiceCollection(app); 95 requestRoutesEventLogService(app); 96 97 requestRoutesPostCodesLogService(app); 98 requestRoutesPostCodesClear(app); 99 requestRoutesPostCodesEntry(app); 100 requestRoutesPostCodesEntryCollection(app); 101 102 #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG 103 requestRoutesSystemDumpService(app); 104 requestRoutesSystemDumpEntryCollection(app); 105 requestRoutesSystemDumpEntry(app); 106 requestRoutesSystemDumpCreate(app); 107 requestRoutesSystemDumpClear(app); 108 109 requestRoutesBMCDumpService(app); 110 requestRoutesBMCDumpEntryCollection(app); 111 requestRoutesBMCDumpEntry(app); 112 requestRoutesBMCDumpCreate(app); 113 requestRoutesBMCDumpClear(app); 114 #endif 115 116 #ifndef BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES 117 requestRoutesJournalEventLogEntryCollection(app); 118 requestRoutesJournalEventLogEntry(app); 119 requestRoutesJournalEventLogClear(app); 120 #endif 121 122 requestRoutesBMCLogServiceCollection(app); 123 #ifdef BMCWEB_ENABLE_REDFISH_BMC_JOURNAL 124 requestRoutesBMCJournalLogService(app); 125 requestRoutesBMCJournalLogEntryCollection(app); 126 requestRoutesBMCJournalLogEntry(app); 127 #endif 128 129 #ifdef BMCWEB_ENABLE_REDFISH_CPU_LOG 130 requestRoutesCrashdumpService(app); 131 requestRoutesCrashdumpEntryCollection(app); 132 requestRoutesCrashdumpEntry(app); 133 requestRoutesCrashdumpFile(app); 134 requestRoutesCrashdumpClear(app); 135 requestRoutesCrashdumpCollect(app); 136 #endif // BMCWEB_ENABLE_REDFISH_CPU_LOG 137 138 requestRoutesProcessorCollection(app); 139 requestRoutesProcessor(app); 140 requestRoutesOperatingConfigCollection(app); 141 requestRoutesOperatingConfig(app); 142 requestRoutesMemoryCollection(app); 143 requestRoutesMemory(app); 144 145 requestRoutesSystemsCollection(app); 146 requestRoutesSystems(app); 147 requestRoutesSystemActionsReset(app); 148 requestRoutesSystemResetActionInfo(app); 149 requestRoutesBiosService(app); 150 requestRoutesBiosReset(app); 151 #ifdef BMCWEB_ENABLE_VM_NBDPROXY 152 nodes.emplace_back(std::make_unique<VirtualMedia>(app)); 153 nodes.emplace_back(std::make_unique<VirtualMediaCollection>(app)); 154 nodes.emplace_back( 155 std::make_unique<VirtualMediaActionInsertMedia>(app)); 156 nodes.emplace_back(std::make_unique<VirtualMediaActionEjectMedia>(app)); 157 #endif // BMCWEB_ENABLE_VM_NBDPROXY 158 #ifdef BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES 159 requestRoutesDBusLogServiceActionsClear(app); 160 requestRoutesDBusEventLogEntryCollection(app); 161 requestRoutesDBusEventLogEntry(app); 162 requestRoutesDBusEventLogEntryDownload(app); 163 #endif 164 165 requestRoutesMessageRegistryFileCollection(app); 166 requestRoutesMessageRegistryFile(app); 167 requestRoutesMessageRegistry(app); 168 169 requestRoutesCertificateService(app); 170 requestRoutesCertificateActionGenerateCSR(app); 171 requestRoutesCertificateActionsReplaceCertificate(app); 172 requestRoutesHTTPSCertificate(app); 173 requestRoutesHTTPSCertificateCollection(app); 174 requestRoutesCertificateLocations(app); 175 requestRoutesLDAPCertificateCollection(app); 176 requestRoutesLDAPCertificate(app); 177 requestRoutesTrustStoreCertificateCollection(app); 178 requestRoutesTrustStoreCertificate(app); 179 180 requestRoutesSystemPCIeFunctionCollection(app); 181 requestRoutesSystemPCIeFunction(app); 182 requestRoutesSystemPCIeDeviceCollection(app); 183 requestRoutesSystemPCIeDevice(app); 184 185 requestRoutesSensorCollection(app); 186 requestRoutesSensor(app); 187 188 requestRoutesTaskMonitor(app); 189 requestRoutesTaskService(app); 190 requestRoutesTaskCollection(app); 191 requestRoutesTask(app); 192 requestRoutesEventService(app); 193 requestRoutesEventDestinationCollection(app); 194 requestRoutesEventDestination(app); 195 requestRoutesSubmitTestEvent(app); 196 197 hypervisor::requestRoutesHypervisorSystems(app); 198 199 requestRoutesTelemetryService(app); 200 requestRoutesMetricReportDefinitionCollection(app); 201 requestRoutesMetricReportDefinition(app); 202 requestRoutesMetricReportCollection(app); 203 requestRoutesMetricReport(app); 204 205 for (const auto& node : nodes) 206 { 207 node->initPrivileges(); 208 } 209 } 210 211 private: 212 std::vector<std::unique_ptr<Node>> nodes; 213 }; 214 215 } // namespace redfish 216