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