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