xref: /openbmc/bmcweb/redfish-core/include/redfish.hpp (revision 8b2521a5a3be479814beb316975bf3de0b4e378f)
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         requestRoutesAggregationService(app);
77         requestRoutesAggregationSourceCollection(app);
78         requestRoutesAggregationSource(app);
79 #endif
80         requestRoutesRoles(app);
81         requestRoutesRoleCollection(app);
82         requestRoutesServiceRoot(app);
83         requestRoutesNetworkProtocol(app);
84         requestRoutesSession(app);
85         requestEthernetInterfacesRoutes(app);
86 #ifdef BMCWEB_ALLOW_DEPRECATED_POWER_THERMAL
87         requestRoutesThermal(app);
88         requestRoutesPower(app);
89 #endif
90 #ifdef BMCWEB_NEW_POWERSUBSYSTEM_THERMALSUBSYSTEM
91         requestRoutesEnvironmentMetrics(app);
92         requestRoutesPowerSubsystem(app);
93         requestRoutesThermalSubsystem(app);
94 #endif
95         requestRoutesManagerCollection(app);
96         requestRoutesManager(app);
97         requestRoutesManagerResetAction(app);
98         requestRoutesManagerResetActionInfo(app);
99         requestRoutesManagerResetToDefaultsAction(app);
100         requestRoutesManagerDiagnosticData(app);
101         requestRoutesChassisCollection(app);
102         requestRoutesChassis(app);
103         requestRoutesChassisResetAction(app);
104         requestRoutesChassisResetActionInfo(app);
105         requestRoutesChassisDrive(app);
106         requestRoutesChassisDriveName(app);
107         requestRoutesUpdateService(app);
108         requestRoutesStorageCollection(app);
109         requestRoutesStorage(app);
110         requestRoutesDrive(app);
111         requestRoutesCable(app);
112         requestRoutesCableCollection(app);
113 #ifdef BMCWEB_INSECURE_ENABLE_REDFISH_FW_TFTP_UPDATE
114         requestRoutesUpdateServiceActionsSimpleUpdate(app);
115 #endif
116         requestRoutesSoftwareInventoryCollection(app);
117         requestRoutesSoftwareInventory(app);
118 
119         requestRoutesSystemLogServiceCollection(app);
120         requestRoutesEventLogService(app);
121         requestRoutesPostCodesEntryAdditionalData(app);
122 
123         requestRoutesPostCodesLogService(app);
124         requestRoutesPostCodesClear(app);
125         requestRoutesPostCodesEntry(app);
126         requestRoutesPostCodesEntryCollection(app);
127 
128 #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG
129         requestRoutesSystemDumpService(app);
130         requestRoutesSystemDumpEntryCollection(app);
131         requestRoutesSystemDumpEntry(app);
132         requestRoutesSystemDumpCreate(app);
133         requestRoutesSystemDumpClear(app);
134 
135         requestRoutesBMCDumpService(app);
136         requestRoutesBMCDumpEntryCollection(app);
137         requestRoutesBMCDumpEntry(app);
138         requestRoutesBMCDumpCreate(app);
139         requestRoutesBMCDumpClear(app);
140 
141         requestRoutesFaultLogDumpService(app);
142         requestRoutesFaultLogDumpEntryCollection(app);
143         requestRoutesFaultLogDumpEntry(app);
144         requestRoutesFaultLogDumpClear(app);
145 #endif
146 
147 #ifndef BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES
148         requestRoutesJournalEventLogEntryCollection(app);
149         requestRoutesJournalEventLogEntry(app);
150         requestRoutesJournalEventLogClear(app);
151 #endif
152 
153         requestRoutesBMCLogServiceCollection(app);
154 #ifdef BMCWEB_ENABLE_REDFISH_BMC_JOURNAL
155         requestRoutesBMCJournalLogService(app);
156         requestRoutesBMCJournalLogEntryCollection(app);
157         requestRoutesBMCJournalLogEntry(app);
158 #endif
159 
160 #ifdef BMCWEB_ENABLE_REDFISH_CPU_LOG
161         requestRoutesCrashdumpService(app);
162         requestRoutesCrashdumpEntryCollection(app);
163         requestRoutesCrashdumpEntry(app);
164         requestRoutesCrashdumpFile(app);
165         requestRoutesCrashdumpClear(app);
166         requestRoutesCrashdumpCollect(app);
167 #endif // BMCWEB_ENABLE_REDFISH_CPU_LOG
168 
169         requestRoutesProcessorCollection(app);
170         requestRoutesProcessor(app);
171         requestRoutesOperatingConfigCollection(app);
172         requestRoutesOperatingConfig(app);
173         requestRoutesMemoryCollection(app);
174         requestRoutesMemory(app);
175 
176         requestRoutesSystemsCollection(app);
177         requestRoutesSystems(app);
178         requestRoutesSystemActionsReset(app);
179         requestRoutesSystemResetActionInfo(app);
180         requestRoutesBiosService(app);
181         requestRoutesBiosReset(app);
182 
183 #ifdef BMCWEB_ENABLE_VM_NBDPROXY
184         requestNBDVirtualMediaRoutes(app);
185 #endif // BMCWEB_ENABLE_VM_NBDPROXY
186 
187 #ifdef BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES
188         requestRoutesDBusLogServiceActionsClear(app);
189         requestRoutesDBusEventLogEntryCollection(app);
190         requestRoutesDBusEventLogEntry(app);
191         requestRoutesDBusEventLogEntryDownload(app);
192 #endif
193 
194 #ifdef BMCWEB_ENABLE_REDFISH_HOST_LOGGER
195         requestRoutesSystemHostLogger(app);
196         requestRoutesSystemHostLoggerCollection(app);
197         requestRoutesSystemHostLoggerLogEntry(app);
198 #endif
199 
200         requestRoutesMessageRegistryFileCollection(app);
201         requestRoutesMessageRegistryFile(app);
202         requestRoutesMessageRegistry(app);
203 
204         requestRoutesCertificateService(app);
205         requestRoutesHTTPSCertificate(app);
206         requestRoutesLDAPCertificate(app);
207         requestRoutesTrustStoreCertificate(app);
208 
209         requestRoutesSystemPCIeFunctionCollection(app);
210         requestRoutesSystemPCIeFunction(app);
211         requestRoutesSystemPCIeDeviceCollection(app);
212         requestRoutesSystemPCIeDevice(app);
213 
214         requestRoutesSensorCollection(app);
215         requestRoutesSensor(app);
216 
217         requestRoutesTaskMonitor(app);
218         requestRoutesTaskService(app);
219         requestRoutesTaskCollection(app);
220         requestRoutesTask(app);
221         requestRoutesEventService(app);
222         requestRoutesEventDestinationCollection(app);
223         requestRoutesEventDestination(app);
224         requestRoutesFabricAdapters(app);
225         requestRoutesFabricAdapterCollection(app);
226         requestRoutesSubmitTestEvent(app);
227 
228         requestRoutesHypervisorSystems(app);
229 
230         requestRoutesTelemetryService(app);
231         requestRoutesMetricReportDefinitionCollection(app);
232         requestRoutesMetricReportDefinition(app);
233         requestRoutesMetricReportCollection(app);
234         requestRoutesMetricReport(app);
235         requestRoutesTriggerCollection(app);
236         requestRoutesTrigger(app);
237 
238         // Note, this must be the last route registered
239         requestRoutesRedfish(app);
240     }
241 };
242 
243 } // namespace redfish
244