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