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