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