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 "account_service.hpp"
19 #include "aggregation_service.hpp"
20 #include "bios.hpp"
21 #include "cable.hpp"
22 #include "certificate_service.hpp"
23 #include "chassis.hpp"
24 #include "environment_metrics.hpp"
25 #include "ethernet.hpp"
26 #include "event_service.hpp"
27 #include "fabric_adapters.hpp"
28 #include "hypervisor_system.hpp"
29 #include "log_services.hpp"
30 #include "manager_diagnostic_data.hpp"
31 #include "managers.hpp"
32 #include "memory.hpp"
33 #include "message_registries.hpp"
34 #include "metric_report.hpp"
35 #include "metric_report_definition.hpp"
36 #include "network_protocol.hpp"
37 #include "pcie.hpp"
38 #include "pcie_slots.hpp"
39 #include "power.hpp"
40 #include "power_subsystem.hpp"
41 #include "power_supply.hpp"
42 #include "processor.hpp"
43 #include "redfish_sessions.hpp"
44 #include "redfish_v1.hpp"
45 #include "roles.hpp"
46 #include "sensors.hpp"
47 #include "service_root.hpp"
48 #include "storage.hpp"
49 #include "systems.hpp"
50 #include "task.hpp"
51 #include "telemetry_service.hpp"
52 #include "thermal.hpp"
53 #include "thermal_subsystem.hpp"
54 #include "trigger.hpp"
55 #include "update_service.hpp"
56 #include "virtual_media.hpp"
57 
58 namespace redfish
59 {
60 /*
61  * @brief Top level class installing and providing Redfish services
62  */
63 class RedfishService
64 {
65   public:
66     /*
67      * @brief Redfish service constructor
68      *
69      * Loads Redfish configuration and installs schema resources
70      *
71      * @param[in] app   Crow app on which Redfish will initialize
72      */
73     explicit RedfishService(App& app)
74     {
75         requestAccountServiceRoutes(app);
76 #ifdef BMCWEB_ENABLE_REDFISH_AGGREGATION
77         requestRoutesAggregationService(app);
78         requestRoutesAggregationSourceCollection(app);
79         requestRoutesAggregationSource(app);
80 #endif
81         requestRoutesRoles(app);
82         requestRoutesRoleCollection(app);
83         requestRoutesServiceRoot(app);
84         requestRoutesNetworkProtocol(app);
85         requestRoutesSession(app);
86         requestEthernetInterfacesRoutes(app);
87 #ifdef BMCWEB_ALLOW_DEPRECATED_POWER_THERMAL
88         requestRoutesThermal(app);
89         requestRoutesPower(app);
90 #endif
91 #ifdef BMCWEB_NEW_POWERSUBSYSTEM_THERMALSUBSYSTEM
92         requestRoutesEnvironmentMetrics(app);
93         requestRoutesPowerSubsystem(app);
94         requestRoutesPowerSupplyCollection(app);
95         requestRoutesThermalSubsystem(app);
96 #endif
97         requestRoutesManagerCollection(app);
98         requestRoutesManager(app);
99         requestRoutesManagerResetAction(app);
100         requestRoutesManagerResetActionInfo(app);
101         requestRoutesManagerResetToDefaultsAction(app);
102         requestRoutesManagerDiagnosticData(app);
103         requestRoutesChassisCollection(app);
104         requestRoutesChassis(app);
105         requestRoutesChassisResetAction(app);
106         requestRoutesChassisResetActionInfo(app);
107         requestRoutesChassisDrive(app);
108         requestRoutesChassisDriveName(app);
109         requestRoutesUpdateService(app);
110         requestRoutesStorageCollection(app);
111         requestRoutesStorage(app);
112         requestRoutesDrive(app);
113         requestRoutesCable(app);
114         requestRoutesCableCollection(app);
115 #ifdef BMCWEB_INSECURE_ENABLE_REDFISH_FW_TFTP_UPDATE
116         requestRoutesUpdateServiceActionsSimpleUpdate(app);
117 #endif
118         requestRoutesSoftwareInventoryCollection(app);
119         requestRoutesSoftwareInventory(app);
120 
121         requestRoutesSystemLogServiceCollection(app);
122         requestRoutesEventLogService(app);
123         requestRoutesPostCodesEntryAdditionalData(app);
124 
125         requestRoutesPostCodesLogService(app);
126         requestRoutesPostCodesClear(app);
127         requestRoutesPostCodesEntry(app);
128         requestRoutesPostCodesEntryCollection(app);
129 
130 #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG
131         requestRoutesSystemDumpService(app);
132         requestRoutesSystemDumpEntryCollection(app);
133         requestRoutesSystemDumpEntry(app);
134         requestRoutesSystemDumpCreate(app);
135         requestRoutesSystemDumpClear(app);
136 
137         requestRoutesBMCDumpService(app);
138         requestRoutesBMCDumpEntryCollection(app);
139         requestRoutesBMCDumpEntry(app);
140         requestRoutesBMCDumpCreate(app);
141         requestRoutesBMCDumpClear(app);
142 
143         requestRoutesFaultLogDumpService(app);
144         requestRoutesFaultLogDumpEntryCollection(app);
145         requestRoutesFaultLogDumpEntry(app);
146         requestRoutesFaultLogDumpClear(app);
147 #endif
148 
149 #ifndef BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES
150         requestRoutesJournalEventLogEntryCollection(app);
151         requestRoutesJournalEventLogEntry(app);
152         requestRoutesJournalEventLogClear(app);
153 #endif
154 
155         requestRoutesBMCLogServiceCollection(app);
156 #ifdef BMCWEB_ENABLE_REDFISH_BMC_JOURNAL
157         requestRoutesBMCJournalLogService(app);
158         requestRoutesBMCJournalLogEntryCollection(app);
159         requestRoutesBMCJournalLogEntry(app);
160 #endif
161 
162 #ifdef BMCWEB_ENABLE_REDFISH_CPU_LOG
163         requestRoutesCrashdumpService(app);
164         requestRoutesCrashdumpEntryCollection(app);
165         requestRoutesCrashdumpEntry(app);
166         requestRoutesCrashdumpFile(app);
167         requestRoutesCrashdumpClear(app);
168         requestRoutesCrashdumpCollect(app);
169 #endif // BMCWEB_ENABLE_REDFISH_CPU_LOG
170 
171         requestRoutesProcessorCollection(app);
172         requestRoutesProcessor(app);
173         requestRoutesOperatingConfigCollection(app);
174         requestRoutesOperatingConfig(app);
175         requestRoutesMemoryCollection(app);
176         requestRoutesMemory(app);
177 
178         requestRoutesSystemsCollection(app);
179         requestRoutesSystems(app);
180         requestRoutesSystemActionsReset(app);
181         requestRoutesSystemResetActionInfo(app);
182         requestRoutesBiosService(app);
183         requestRoutesBiosReset(app);
184 
185 #ifdef BMCWEB_ENABLE_VM_NBDPROXY
186         requestNBDVirtualMediaRoutes(app);
187 #endif // BMCWEB_ENABLE_VM_NBDPROXY
188 
189 #ifdef BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES
190         requestRoutesDBusLogServiceActionsClear(app);
191         requestRoutesDBusEventLogEntryCollection(app);
192         requestRoutesDBusEventLogEntry(app);
193         requestRoutesDBusEventLogEntryDownload(app);
194 #endif
195 
196 #ifdef BMCWEB_ENABLE_REDFISH_HOST_LOGGER
197         requestRoutesSystemHostLogger(app);
198         requestRoutesSystemHostLoggerCollection(app);
199         requestRoutesSystemHostLoggerLogEntry(app);
200 #endif
201 
202         requestRoutesMessageRegistryFileCollection(app);
203         requestRoutesMessageRegistryFile(app);
204         requestRoutesMessageRegistry(app);
205 
206         requestRoutesCertificateService(app);
207         requestRoutesHTTPSCertificate(app);
208         requestRoutesLDAPCertificate(app);
209         requestRoutesTrustStoreCertificate(app);
210 
211         requestRoutesSystemPCIeFunctionCollection(app);
212         requestRoutesSystemPCIeFunction(app);
213         requestRoutesSystemPCIeDeviceCollection(app);
214         requestRoutesSystemPCIeDevice(app);
215 
216         requestRoutesSensorCollection(app);
217         requestRoutesSensor(app);
218 
219         requestRoutesTaskMonitor(app);
220         requestRoutesTaskService(app);
221         requestRoutesTaskCollection(app);
222         requestRoutesTask(app);
223         requestRoutesEventService(app);
224         requestRoutesEventDestinationCollection(app);
225         requestRoutesEventDestination(app);
226         requestRoutesFabricAdapters(app);
227         requestRoutesFabricAdapterCollection(app);
228         requestRoutesSubmitTestEvent(app);
229 
230         requestRoutesHypervisorSystems(app);
231 
232         requestRoutesTelemetryService(app);
233         requestRoutesMetricReportDefinitionCollection(app);
234         requestRoutesMetricReportDefinition(app);
235         requestRoutesMetricReportCollection(app);
236         requestRoutesMetricReport(app);
237         requestRoutesTriggerCollection(app);
238         requestRoutesTrigger(app);
239 
240         // Note, this must be the last route registered
241         requestRoutesRedfish(app);
242     }
243 };
244 
245 } // namespace redfish
246