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