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