blob: 9f0d6def2548840e2ba7c7179dcd5aa5837c1811 [file] [log] [blame]
George Keishingfbeaecc2016-08-16 05:24:31 -05001import os
2
Sweta Potthuridaf91342017-09-07 12:05:56 -05003OPENBMC_BASE_URI = '/xyz/openbmc_project/'
4OPENBMC_BASE_DBUS = 'xyz.openbmc_project.'
George Keishingcf910442016-12-08 03:12:59 -06005
George Keishingcae6e902017-09-07 13:35:59 -05006# org open power base URI.
7OPENPOWER_BASE_URI = '/org/open_power/'
8OPENPOWER_CONTROL = OPENPOWER_BASE_URI + 'control/'
George Keishingac512252018-02-05 02:04:30 -06009OPENPOWER_SENSORS = OPENPOWER_BASE_URI + 'sensors/'
George Keishingcae6e902017-09-07 13:35:59 -050010
11# REST URI base endpoint paths.
George Keishingcf910442016-12-08 03:12:59 -060012CONTROL_URI = OPENBMC_BASE_URI + 'control/'
George Keishing0da47e92017-10-23 02:22:29 -050013# old vs new code dependencies in many places.
14# TODO: remove when ready.
15SETTINGS_URI = '/org/openbmc/settings/'
George Keishingcf910442016-12-08 03:12:59 -060016WATCHDOG_URI = OPENBMC_BASE_URI + 'watchdog/'
Sweta Potthuridaf91342017-09-07 12:05:56 -050017TIME_MANAGER_URI = OPENBMC_BASE_URI + 'time/'
manasarm104cc6b2018-02-07 12:35:05 +053018NETWORK_MANAGER = OPENBMC_BASE_URI + 'network/'
Prashanth Katti081b3d92018-06-15 05:13:11 -050019# SNMP
20SNMP_MANAGER_URI = NETWORK_MANAGER + 'snmp/manager/'
George Keishing06572472017-09-01 11:33:01 -050021# Sensors base variables.
Gunnar Millsdca35792018-03-26 10:05:38 -050022SENSORS_URI = OPENBMC_BASE_URI + 'sensors/'
George Keishing06572472017-09-01 11:33:01 -050023
Sweta Potthuridaf91342017-09-07 12:05:56 -050024# State Manager base variables
Rahul Maheshwari2f8de6c2017-01-17 07:00:22 -060025BMC_REBOOT_TRANS = 'xyz.openbmc_project.State.BMC.Transition.Reboot'
26
George Keishingbec365b2017-01-19 01:28:41 -060027HOST_POWEROFF_TRANS = 'xyz.openbmc_project.State.Host.Transition.Off'
28HOST_POWERON_TRANS = 'xyz.openbmc_project.State.Host.Transition.On'
Rahul Maheshwarif7ead242017-02-14 01:59:42 -060029HOST_REBOOT_TRANS = 'xyz.openbmc_project.State.Host.Transition.Reboot'
George Keishingbec365b2017-01-19 01:28:41 -060030HOST_POWEROFF_STATE = 'xyz.openbmc_project.State.Host.HostState.Off'
31HOST_POWERON_STATE = 'xyz.openbmc_project.State.Host.HostState.Running'
32
33CHASSIS_POWEROFF_TRANS = 'xyz.openbmc_project.State.Chassis.Transition.Off'
34CHASSIS_POWERON_TRANS = 'xyz.openbmc_project.State.Chassis.Transition.On'
35CHASSIS_POWEROFF_STATE = 'xyz.openbmc_project.State.Chassis.PowerState.Off'
36CHASSIS_POWERON_STATE = 'xyz.openbmc_project.State.Chassis.PowerState.On'
37
38# State Manager URI variables.
Sweta Potthuridaf91342017-09-07 12:05:56 -050039SYSTEM_STATE_URI = OPENBMC_BASE_URI + 'state/'
40BMC_STATE_URI = OPENBMC_BASE_URI + 'state/bmc0/'
41HOST_STATE_URI = OPENBMC_BASE_URI + 'state/host0/'
42CHASSIS_STATE_URI = OPENBMC_BASE_URI + 'state/chassis0/'
43HOST_WATCHDOG_URI = OPENBMC_BASE_URI + 'watchdog/host0/'
George Keishingbec365b2017-01-19 01:28:41 -060044
George Keishing505d5b42017-02-21 11:01:54 -060045# Logging URI variables
Sweta Potthuridaf91342017-09-07 12:05:56 -050046BMC_LOGGING_URI = OPENBMC_BASE_URI + 'logging/'
George Keishinga71dd202017-02-24 00:49:40 -060047BMC_LOGGING_ENTRY = BMC_LOGGING_URI + 'entry/'
George Keishing505d5b42017-02-21 11:01:54 -060048
George Keishingab5157b2017-02-09 12:24:25 -060049# Software manager version
Sweta Potthuridaf91342017-09-07 12:05:56 -050050SOFTWARE_VERSION_URI = OPENBMC_BASE_URI + 'software/'
George Keishingab5157b2017-02-09 12:24:25 -060051ACTIVE = 'xyz.openbmc_project.Software.Activation.Activations.Active'
Saqib Khanbb8b63f2017-05-24 10:58:01 -050052READY = 'xyz.openbmc_project.Software.Activation.Activations.Ready'
53INVALID = 'xyz.openbmc_project.Software.Activation.Activations.Invalid'
54ACTIVATING = 'xyz.openbmc_project.Software.Activation.Activations.Activating'
55NOTREADY = 'xyz.openbmc_project.Software.Activation.Activations.NotReady'
56FAILED = 'xyz.openbmc_project.Software.Activation.Activations.Failed'
57
58SOFTWARE_ACTIVATION = 'xyz.openbmc_project.Software.Activation'
George Keishing4af8f362017-10-23 00:26:58 -050059REQUESTED_ACTIVATION = SOFTWARE_ACTIVATION + '.RequestedActivations'
60REQUESTED_ACTIVE = REQUESTED_ACTIVATION + '.Active'
Saqib Khanbb8b63f2017-05-24 10:58:01 -050061REQUESTED_NONE = REQUESTED_ACTIVATION + '.None'
62
63SOFTWARE_PURPOSE = 'xyz.openbmc_project.Software.Version.VersionPurpose'
64VERSION_PURPOSE_HOST = SOFTWARE_PURPOSE + '.Host'
65VERSION_PURPOSE_BMC = SOFTWARE_PURPOSE + '.BMC'
66VERSION_PURPOSE_SYSTEM = SOFTWARE_PURPOSE + '.System'
George Keishingab5157b2017-02-09 12:24:25 -060067
Charles Paul Hofer9f74d3a2017-08-18 09:54:28 -050068# Image Upload Directory Path
69IMAGE_UPLOAD_DIR_PATH = '/tmp/images/'
70
George Keishingc8166ed2017-02-24 03:53:38 -060071# Inventory URI
Sweta Potthuridaf91342017-09-07 12:05:56 -050072HOST_INVENTORY_URI = OPENBMC_BASE_URI + 'inventory/'
George Keishingc8166ed2017-02-24 03:53:38 -060073
Rahul Maheshwari7258aec2017-02-02 04:46:38 -060074# Led URI variable
Sweta Potthuridaf91342017-09-07 12:05:56 -050075LED_GROUPS_URI = OPENBMC_BASE_URI + 'led/groups/'
76LED_PHYSICAL_URI = OPENBMC_BASE_URI + 'led/physical/'
Rahul Maheshwari7258aec2017-02-02 04:46:38 -060077
George Keishing1059b222017-07-21 13:24:43 -050078# Host control URI variables.
Sweta Potthuridaf91342017-09-07 12:05:56 -050079CONTROL_HOST_URI = OPENBMC_BASE_URI + 'control/host0/'
Rahul Maheshwari7258aec2017-02-02 04:46:38 -060080
George Keishing1c3a9662017-08-11 10:16:36 -050081# Power restore variables.
82POWER_RESTORE_URI = CONTROL_HOST_URI + 'power_restore_policy'
83CONTROL_DBUS_BASE = 'xyz.openbmc_project.Control.'
84
85RESTORE_LAST_STATE = CONTROL_DBUS_BASE + 'Power.RestorePolicy.Policy.Restore'
86ALWAYS_POWER_ON = CONTROL_DBUS_BASE + 'Power.RestorePolicy.Policy.AlwaysOn'
87ALWAYS_POWER_OFF = CONTROL_DBUS_BASE + 'Power.RestorePolicy.Policy.AlwaysOff'
88
Sweta Potthuri09a3cf92017-12-08 01:19:53 -060089# Dump URI variables.
George Keishing8d693382018-12-18 12:15:04 -060090DUMP_URI = OPENBMC_BASE_URI + 'dump/'
Rahul Maheshwari23b18fb2017-08-01 00:30:26 -050091DUMP_ENTRY_URI = DUMP_URI + 'entry/'
Michael Walshe11a1362017-10-19 15:35:26 -050092# The path on the BMC where dumps are stored.
93DUMP_DIR_PATH = "/var/lib/phosphor-debug-collector/dumps/"
Rahul Maheshwari23b18fb2017-08-01 00:30:26 -050094
George Keishing2bd6fc02017-08-10 01:15:16 -050095# Boot progress variables.
96STATE_DBUS_BASE = 'xyz.openbmc_project.State.'
97OS_BOOT_START = STATE_DBUS_BASE + 'Boot.Progress.ProgressStages.OSStart'
98OS_BOOT_OFF = STATE_DBUS_BASE + 'Boot.Progress.ProgressStages.Unspecified'
Sweta Potthuri09a3cf92017-12-08 01:19:53 -060099OS_BOOT_PCI = STATE_DBUS_BASE + 'Boot.Progress.ProgressStages.PCIInit'
100OS_BOOT_SECPCI = STATE_DBUS_BASE + \
Gunnar Millsdca35792018-03-26 10:05:38 -0500101 'Boot.Progress.ProgressStages.SecondaryProcInit'
Sweta Potthuri09a3cf92017-12-08 01:19:53 -0600102OS_BOOT_MEM = STATE_DBUS_BASE + 'Boot.Progress.ProgressStages.MemoryInit'
103OS_BOOT_MOTHERBOARD = STATE_DBUS_BASE + \
Gunnar Millsdca35792018-03-26 10:05:38 -0500104 'Boot.Progress.ProgressStages.MotherboardInit'
Sweta Potthuri09a3cf92017-12-08 01:19:53 -0600105
106# OperatingSystem status variables.
Gunnar Millsdca35792018-03-26 10:05:38 -0500107OS_BOOT_COMPLETE = STATE_DBUS_BASE + \
108 'OperatingSystem.Status.OSStatus.BootComplete'
109OS_BOOT_CDROM = STATE_DBUS_BASE + 'OperatingSystem.Status.OSStatus.CDROMBoot'
Sweta Potthuri09a3cf92017-12-08 01:19:53 -0600110OS_BOOT_ROM = STATE_DBUS_BASE + 'OperatingSystem.Status.OSStatus.ROMBoot'
111OS_BOOT_PXE = STATE_DBUS_BASE + 'OperatingSystem.Status.OSStatus.PXEBoot'
112OS_BOOT_CBoot = STATE_DBUS_BASE + 'OperatingSystem.Status.OSStatus.CBoot'
113OS_BOOT_DiagBoot = STATE_DBUS_BASE + 'OperatingSystem.Status.OSStatus.DiagBoot'
George Keishing2bd6fc02017-08-10 01:15:16 -0500114
Rahul Maheshwari85c4d342017-08-09 21:59:30 -0500115# Boot variables.
116BOOT_SOURCE_DEFAULT = 'xyz.openbmc_project.Control.Boot.Source.Sources.Default'
117BOOT_SOURCE_NETWORK = 'xyz.openbmc_project.Control.Boot.Source.Sources.Network'
118BOOT_SOURCE_DISK = 'xyz.openbmc_project.Control.Boot.Source.Sources.Disk'
119BOOT_SOURCE_CDROM = 'xyz.openbmc_project.Control.Boot.Source.Sources.ExternalMedia'
120BOOT_MODE_SAFE = 'xyz.openbmc_project.Control.Boot.Mode.Modes.Safe'
121BOOT_MODE_SETUP = 'xyz.openbmc_project.Control.Boot.Mode.Modes.Setup'
122BOOT_MODE_REGULAR = 'xyz.openbmc_project.Control.Boot.Mode.Modes.Regular'
123
Rahul Maheshwarif486ae82017-10-24 06:10:14 -0500124# Time variables.
125TIME_DBUS_BASE = 'xyz.openbmc_project.Time.'
126BMC_OWNER = TIME_DBUS_BASE + 'Owner.Owners.BMC'
127HOST_OWNER = TIME_DBUS_BASE + 'Owner.Owners.Host'
128SPLIT_OWNER = TIME_DBUS_BASE + 'Owner.Owners.Split'
129BOTH_OWNER = TIME_DBUS_BASE + 'Owner.Owners.Both'
130NTP_MODE = TIME_DBUS_BASE + 'Synchronization.Method.NTP'
131MANUAL_MODE = TIME_DBUS_BASE + 'Synchronization.Method.Manual'
132
George Keishingf1331672018-01-18 05:19:02 -0600133# User manager variable.
134BMC_USER_URI = OPENBMC_BASE_URI + 'user/'
135
Sivas SRR39909e32018-11-09 18:58:36 -0600136# LDAP User manager variable.
137BMC_LDAP_URI = BMC_USER_URI + 'ldap'
138
George Keishing0b837432018-03-20 13:46:10 -0500139# The path on the BMC where signed keys are stored.
140ACTIVATION_DIR_PATH = "/etc/activationdata/"
141
George Keishingeaa73b72018-07-30 09:30:16 -0500142# Redfish variables.
143REDFISH_BASE_URI = '/redfish/v1/'
144REDFISH_SESSION = REDFISH_BASE_URI + 'SessionService/Sessions'
George Keishing9cef1092018-08-06 01:06:24 -0500145REDFISH_SESSION_URI = 'SessionService/Sessions/'
George Keishingeaa73b72018-07-30 09:30:16 -0500146
George Keishing713dd5e2018-11-29 01:16:19 -0600147# Boot options and URI variables.
148POWER_ON = 'On'
149POWER_GRACEFULL_OFF = "GracefulShutdown"
150POWER_FORCE_OFF = 'ForceOff'
151
152REDFISH_POWER_URI = 'Systems/1/Actions/ComputerSystem.Reset'
153
George Keishing6a514ef2018-08-27 05:19:19 -0500154# rsyslog variables.
155REMOTE_LOGGING_URI = OPENBMC_BASE_URI + 'logging/config/remote/'
156
Rahul Maheshwari984791c2018-09-21 00:49:37 -0500157# Certificate variables.
158SERVER_CERTIFICATE_URI = OPENBMC_BASE_URI + 'certs/server/https'
159CLIENT_CERTIFICATE_URI = OPENBMC_BASE_URI + 'certs/client/ldap'
Rahul Maheshwari081eadb2018-10-26 03:11:10 -0500160CA_CERTIFICATE_URI = OPENBMC_BASE_URI + 'certs/authority/ldap'
Rahul Maheshwari984791c2018-09-21 00:49:37 -0500161
George Keishingfbeaecc2016-08-16 05:24:31 -0500162'''
163 QEMU HTTPS variable:
164
165 By default lib/resource.txt AUTH URI construct is as
166 ${AUTH_URI} https://${OPENBMC_HOST}${AUTH_SUFFIX}
167 ${AUTH_SUFFIX} is populated here by default EMPTY else
168 the port from the OS environment
169'''
George Keishingcf910442016-12-08 03:12:59 -0600170
171
George Keishingfbeaecc2016-08-16 05:24:31 -0500172def get_port_https():
173 # defaulted to empty string
174 l_suffix = ''
175 try:
176 l_https_port = os.getenv('HTTPS_PORT')
177 if l_https_port:
George Keishingcf910442016-12-08 03:12:59 -0600178 l_suffix = ':' + l_https_port
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500179 except BaseException:
George Keishing3b7115a2018-08-02 10:48:17 -0500180 print ("Environment variable HTTPS_PORT not set,\
181 using default HTTPS port")
George Keishingfbeaecc2016-08-16 05:24:31 -0500182 return l_suffix
183
Gunnar Millsdca35792018-03-26 10:05:38 -0500184
George Keishingcf910442016-12-08 03:12:59 -0600185AUTH_SUFFIX = {
186 "https_port": [get_port_https()],
George Keishingfbeaecc2016-08-16 05:24:31 -0500187}
188
189# Update the ':Port number' to this variable
190AUTH_SUFFIX = AUTH_SUFFIX['https_port'][0]
Chris Austenb29d2e82016-06-07 12:25:35 -0500191
192# Here contains a list of valid Properties bases on fru_type after a boot.
George Keishingcf910442016-12-08 03:12:59 -0600193INVENTORY_ITEMS = {
Chris Austenb29d2e82016-06-07 12:25:35 -0500194 "CPU": [
195 "Custom Field 1",
196 "Custom Field 2",
197 "Custom Field 3",
198 "Custom Field 4",
199 "Custom Field 5",
200 "Custom Field 6",
201 "Custom Field 7",
202 "Custom Field 8",
203 "FRU File ID",
204 "Manufacturer",
205 "Name",
206 "Part Number",
207 "Serial Number",
208 "fault",
209 "fru_type",
210 "is_fru",
211 "present",
212 "version",
Gunnar Millsdca35792018-03-26 10:05:38 -0500213 ],
Chris Austenb29d2e82016-06-07 12:25:35 -0500214
215 "DIMM": [
216 "Asset Tag",
217 "Custom Field 1",
218 "Custom Field 2",
219 "Custom Field 3",
220 "Custom Field 4",
221 "Custom Field 5",
222 "Custom Field 6",
223 "Custom Field 7",
224 "Custom Field 8",
225 "FRU File ID",
226 "Manufacturer",
227 "Model Number",
228 "Name",
229 "Serial Number",
230 "Version",
231 "fault",
232 "fru_type",
233 "is_fru",
234 "present",
235 "version",
Gunnar Millsdca35792018-03-26 10:05:38 -0500236 ],
Chris Austenb29d2e82016-06-07 12:25:35 -0500237 "MEMORY_BUFFER": [
238 "Custom Field 1",
239 "Custom Field 2",
240 "Custom Field 3",
241 "Custom Field 4",
242 "Custom Field 5",
243 "Custom Field 6",
244 "Custom Field 7",
245 "Custom Field 8",
246 "FRU File ID",
247 "Manufacturer",
248 "Name",
249 "Part Number",
250 "Serial Number",
251 "fault",
252 "fru_type",
253 "is_fru",
254 "present",
255 "version",
Gunnar Millsdca35792018-03-26 10:05:38 -0500256 ],
Chris Austenb29d2e82016-06-07 12:25:35 -0500257 "FAN": [
258 "fault",
259 "fru_type",
260 "is_fru",
261 "present",
262 "version",
Gunnar Millsdca35792018-03-26 10:05:38 -0500263 ],
Chris Austenb29d2e82016-06-07 12:25:35 -0500264 "DAUGHTER_CARD": [
265 "Custom Field 1",
266 "Custom Field 2",
267 "Custom Field 3",
268 "Custom Field 4",
269 "Custom Field 5",
270 "Custom Field 6",
271 "Custom Field 7",
272 "Custom Field 8",
273 "FRU File ID",
274 "Manufacturer",
275 "Name",
276 "Part Number",
277 "Serial Number",
278 "fault",
279 "fru_type",
280 "is_fru",
281 "present",
282 "version",
Gunnar Millsdca35792018-03-26 10:05:38 -0500283 ],
Chris Austenb29d2e82016-06-07 12:25:35 -0500284 "BMC": [
285 "fault",
286 "fru_type",
287 "is_fru",
288 "manufacturer",
289 "present",
290 "version",
Gunnar Millsdca35792018-03-26 10:05:38 -0500291 ],
Chris Austenb29d2e82016-06-07 12:25:35 -0500292 "MAIN_PLANAR": [
293 "Custom Field 1",
294 "Custom Field 2",
295 "Custom Field 3",
296 "Custom Field 4",
297 "Custom Field 5",
298 "Custom Field 6",
299 "Custom Field 7",
300 "Custom Field 8",
301 "Part Number",
302 "Serial Number",
303 "Type",
304 "fault",
305 "fru_type",
306 "is_fru",
307 "present",
308 "version",
Gunnar Millsdca35792018-03-26 10:05:38 -0500309 ],
Chris Austenb29d2e82016-06-07 12:25:35 -0500310 "SYSTEM": [
311 "Custom Field 1",
312 "Custom Field 2",
313 "Custom Field 3",
314 "Custom Field 4",
315 "Custom Field 5",
316 "Custom Field 6",
317 "Custom Field 7",
318 "Custom Field 8",
319 "FRU File ID",
320 "Manufacturer",
321 "Model Number",
322 "Name",
323 "Serial Number",
324 "Version",
325 "fault",
326 "fru_type",
327 "is_fru",
328 "present",
329 "version",
Gunnar Millsdca35792018-03-26 10:05:38 -0500330 ],
Chris Austenb29d2e82016-06-07 12:25:35 -0500331 "CORE": [
332 "fault",
333 "fru_type",
334 "is_fru",
335 "present",
336 "version",
Gunnar Millsdca35792018-03-26 10:05:38 -0500337 ],
Chris Austenb29d2e82016-06-07 12:25:35 -0500338}