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