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