1import os
2
3OPENBMC_BASE_URI = '/xyz/openbmc_project/'
4OPENBMC_BASE_DBUS = 'xyz.openbmc_project.'
5
6# org open power base URI.
7OPENPOWER_BASE_URI = '/org/open_power/'
8OPENPOWER_CONTROL = OPENPOWER_BASE_URI + 'control/'
9OPENPOWER_SENSORS = OPENPOWER_BASE_URI + 'sensors/'
10
11# REST URI base endpoint paths.
12CONTROL_URI = OPENBMC_BASE_URI + 'control/'
13# old vs new code dependencies in many places.
14# TODO: remove when ready.
15SETTINGS_URI = '/org/openbmc/settings/'
16WATCHDOG_URI = OPENBMC_BASE_URI + 'watchdog/'
17TIME_MANAGER_URI = OPENBMC_BASE_URI + 'time/'
18NETWORK_MANAGER = OPENBMC_BASE_URI + 'network/'
19# SNMP
20SNMP_MANAGER_URI = NETWORK_MANAGER + 'snmp/manager/'
21# Sensors base variables.
22SENSORS_URI = OPENBMC_BASE_URI + 'sensors/'
23
24# State Manager base variables
25BMC_REBOOT_TRANS = 'xyz.openbmc_project.State.BMC.Transition.Reboot'
26
27HOST_POWEROFF_TRANS = 'xyz.openbmc_project.State.Host.Transition.Off'
28HOST_POWERON_TRANS = 'xyz.openbmc_project.State.Host.Transition.On'
29HOST_REBOOT_TRANS = 'xyz.openbmc_project.State.Host.Transition.Reboot'
30HOST_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.
39SYSTEM_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/'
44
45# Logging URI variables
46BMC_LOGGING_URI = OPENBMC_BASE_URI + 'logging/'
47BMC_LOGGING_ENTRY = BMC_LOGGING_URI + 'entry/'
48
49# Software manager version
50SOFTWARE_VERSION_URI = OPENBMC_BASE_URI + 'software/'
51ACTIVE = 'xyz.openbmc_project.Software.Activation.Activations.Active'
52READY = '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'
59REQUESTED_ACTIVATION = SOFTWARE_ACTIVATION + '.RequestedActivations'
60REQUESTED_ACTIVE = REQUESTED_ACTIVATION + '.Active'
61REQUESTED_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'
67
68# Image Upload Directory Path
69IMAGE_UPLOAD_DIR_PATH = '/tmp/images/'
70
71# Inventory URI
72HOST_INVENTORY_URI = OPENBMC_BASE_URI + 'inventory/'
73
74# Led URI variable
75LED_GROUPS_URI = OPENBMC_BASE_URI + 'led/groups/'
76LED_PHYSICAL_URI = OPENBMC_BASE_URI + 'led/physical/'
77LED_LAMP_TEST_ASSERTED_URI = LED_GROUPS_URI + 'lamp_test/'
78LED_PHYSICAL_PS0_URI = LED_PHYSICAL_URI + 'cffps1_69/'
79LED_PHYSICAL_PS1_URI = LED_PHYSICAL_URI + 'cffps1_68/'
80
81# Host control URI variables.
82CONTROL_HOST_URI = OPENBMC_BASE_URI + 'control/host0/'
83
84# Power restore variables.
85POWER_RESTORE_URI = CONTROL_HOST_URI + 'power_restore_policy'
86CONTROL_DBUS_BASE = 'xyz.openbmc_project.Control.'
87
88RESTORE_LAST_STATE = CONTROL_DBUS_BASE + 'Power.RestorePolicy.Policy.Restore'
89ALWAYS_POWER_ON = CONTROL_DBUS_BASE + 'Power.RestorePolicy.Policy.AlwaysOn'
90ALWAYS_POWER_OFF = CONTROL_DBUS_BASE + 'Power.RestorePolicy.Policy.AlwaysOff'
91
92# Dump URI variables.
93DUMP_URI = OPENBMC_BASE_URI + 'dump/'
94DUMP_ENTRY_URI = DUMP_URI + 'entry/'
95DUMP_DOWNLOAD_URI = "/download/dump/"
96# The path on the BMC where dumps are stored.
97DUMP_DIR_PATH = "/var/lib/phosphor-debug-collector/dumps/"
98
99# Boot progress variables.
100STATE_DBUS_BASE = 'xyz.openbmc_project.State.'
101OS_BOOT_START = STATE_DBUS_BASE + 'Boot.Progress.ProgressStages.OSStart'
102OS_BOOT_OFF = STATE_DBUS_BASE + 'Boot.Progress.ProgressStages.Unspecified'
103OS_BOOT_PCI = STATE_DBUS_BASE + 'Boot.Progress.ProgressStages.PCIInit'
104OS_BOOT_SECPCI = STATE_DBUS_BASE + \
105    'Boot.Progress.ProgressStages.SecondaryProcInit'
106OS_BOOT_MEM = STATE_DBUS_BASE + 'Boot.Progress.ProgressStages.MemoryInit'
107OS_BOOT_MOTHERBOARD = STATE_DBUS_BASE + \
108    'Boot.Progress.ProgressStages.MotherboardInit'
109
110# OperatingSystem status variables.
111OS_BOOT_COMPLETE = STATE_DBUS_BASE + \
112    'OperatingSystem.Status.OSStatus.BootComplete'
113OS_BOOT_CDROM = STATE_DBUS_BASE + 'OperatingSystem.Status.OSStatus.CDROMBoot'
114OS_BOOT_ROM = STATE_DBUS_BASE + 'OperatingSystem.Status.OSStatus.ROMBoot'
115OS_BOOT_PXE = STATE_DBUS_BASE + 'OperatingSystem.Status.OSStatus.PXEBoot'
116OS_BOOT_CBoot = STATE_DBUS_BASE + 'OperatingSystem.Status.OSStatus.CBoot'
117OS_BOOT_DiagBoot = STATE_DBUS_BASE + 'OperatingSystem.Status.OSStatus.DiagBoot'
118
119# Boot variables.
120BOOT_SOURCE_DEFAULT = 'xyz.openbmc_project.Control.Boot.Source.Sources.Default'
121BOOT_SOURCE_NETWORK = 'xyz.openbmc_project.Control.Boot.Source.Sources.Network'
122BOOT_SOURCE_DISK = 'xyz.openbmc_project.Control.Boot.Source.Sources.Disk'
123BOOT_SOURCE_CDROM = 'xyz.openbmc_project.Control.Boot.Source.Sources.ExternalMedia'
124BOOT_MODE_SAFE = 'xyz.openbmc_project.Control.Boot.Mode.Modes.Safe'
125BOOT_MODE_SETUP = 'xyz.openbmc_project.Control.Boot.Mode.Modes.Setup'
126BOOT_MODE_REGULAR = 'xyz.openbmc_project.Control.Boot.Mode.Modes.Regular'
127
128# Time variables.
129TIME_DBUS_BASE = 'xyz.openbmc_project.Time.'
130BMC_OWNER = TIME_DBUS_BASE + 'Owner.Owners.BMC'
131HOST_OWNER = TIME_DBUS_BASE + 'Owner.Owners.Host'
132SPLIT_OWNER = TIME_DBUS_BASE + 'Owner.Owners.Split'
133BOTH_OWNER = TIME_DBUS_BASE + 'Owner.Owners.Both'
134NTP_MODE = TIME_DBUS_BASE + 'Synchronization.Method.NTP'
135MANUAL_MODE = TIME_DBUS_BASE + 'Synchronization.Method.Manual'
136
137# User manager variable.
138BMC_USER_URI = OPENBMC_BASE_URI + 'user/'
139
140# LDAP User manager variable.
141BMC_LDAP_URI = BMC_USER_URI + 'ldap'
142
143# The path on the BMC where signed keys are stored.
144ACTIVATION_DIR_PATH = "/etc/activationdata/"
145
146# Redfish variables.
147REDFISH_BASE_URI = '/redfish/v1/'
148REDFISH_SESSION = REDFISH_BASE_URI + 'SessionService/Sessions'
149REDFISH_SESSION_URI = 'SessionService/Sessions/'
150REDFISH_NW_ETH0 = 'Managers/bmc/EthernetInterfaces/eth0/'
151REDFISH_NW_ETH0_URI = REDFISH_BASE_URI + REDFISH_NW_ETH0
152REDFISH_NW_PROTOCOL = 'Managers/bmc/NetworkProtocol'
153REDFISH_NW_PROTOCOL_URI = REDFISH_BASE_URI + REDFISH_NW_PROTOCOL
154REDFISH_ACCOUNTS_SERVICE = 'AccountService/'
155REDFISH_ACCOUNTS_SERVICE_URI = REDFISH_BASE_URI + REDFISH_ACCOUNTS_SERVICE
156REDFISH_ACCOUNTS = 'AccountService/Accounts/'
157REDFISH_ACCOUNTS_URI = REDFISH_BASE_URI + REDFISH_ACCOUNTS
158REDFISH_HTTPS_CERTIFICATE = 'Managers/bmc/NetworkProtocol/HTTPS/Certificates'
159REDFISH_HTTPS_CERTIFICATE_URI = REDFISH_BASE_URI + REDFISH_HTTPS_CERTIFICATE
160REDFISH_LDAP_CERTIFICATE = 'AccountService/LDAP/Certificates'
161REDFISH_LDAP_CERTIFICATE_URI = REDFISH_BASE_URI + REDFISH_LDAP_CERTIFICATE
162REDFISH_CA_CERTIFICATE = 'Managers/bmc/Truststore/Certificates'
163REDFISH_CA_CERTIFICATE_URI = REDFISH_BASE_URI + REDFISH_CA_CERTIFICATE
164REDFISH_CHASSIS_URI = REDFISH_BASE_URI + 'Chassis/'
165REDFISH_CHASSIS_THERMAL = 'chassis/Thermal/'
166REDFISH_CHASSIS_THERMAL_URI = REDFISH_CHASSIS_URI + REDFISH_CHASSIS_THERMAL
167REDFISH_CHASSIS_POWER = 'chassis/Power/'
168REDFISH_CHASSIS_POWER_URI = REDFISH_CHASSIS_URI + REDFISH_CHASSIS_POWER
169
170# Boot options and URI variables.
171POWER_ON = 'On'
172POWER_GRACEFUL_OFF = "GracefulShutdown"
173POWER_GRACEFUL_RESTART = "GracefulRestart"
174POWER_FORCE_OFF = 'ForceOff'
175
176REDFISH_POWER = 'Systems/system/Actions/ComputerSystem.Reset'
177REDFISH_POWER_URI = REDFISH_BASE_URI + REDFISH_POWER
178
179# rsyslog variables.
180REMOTE_LOGGING_URI = OPENBMC_BASE_URI + 'logging/config/remote/'
181
182# Certificate variables.
183SERVER_CERTIFICATE_URI = OPENBMC_BASE_URI + 'certs/server/https'
184CLIENT_CERTIFICATE_URI = OPENBMC_BASE_URI + 'certs/client/ldap'
185CA_CERTIFICATE_URI = OPENBMC_BASE_URI + 'certs/authority/ldap'
186
187# EventLog variables.
188SYSTEM_BASE_URI = REDFISH_BASE_URI + 'Systems/system/'
189EVENT_LOG_URI = SYSTEM_BASE_URI + 'LogServices/EventLog/'
190
191
192'''
193  QEMU HTTPS variable:
194
195  By default lib/resource.robot AUTH URI construct is as
196  ${AUTH_URI}   https://${OPENBMC_HOST}${AUTH_SUFFIX}
197  ${AUTH_SUFFIX} is populated here by default EMPTY else
198  the port from the OS environment
199'''
200
201
202def get_port_https():
203    # defaulted to empty string
204    l_suffix = ''
205    try:
206        l_https_port = os.getenv('HTTPS_PORT')
207        if l_https_port:
208            l_suffix = ':' + l_https_port
209    except BaseException:
210        print ("Environment variable HTTPS_PORT not set,\
211              using default HTTPS port")
212    return l_suffix
213
214
215AUTH_SUFFIX = {
216    "https_port": [get_port_https()],
217}
218
219# Update the ':Port number' to this variable
220AUTH_SUFFIX = AUTH_SUFFIX['https_port'][0]
221
222# Here contains a list of valid Properties bases on fru_type after a boot.
223INVENTORY_ITEMS = {
224    "CPU": [
225        "Custom Field 1",
226        "Custom Field 2",
227        "Custom Field 3",
228        "Custom Field 4",
229        "Custom Field 5",
230        "Custom Field 6",
231        "Custom Field 7",
232        "Custom Field 8",
233        "FRU File ID",
234        "Manufacturer",
235        "Name",
236        "Part Number",
237        "Serial Number",
238        "fault",
239        "fru_type",
240        "is_fru",
241        "present",
242        "version",
243    ],
244
245    "DIMM": [
246        "Asset Tag",
247        "Custom Field 1",
248        "Custom Field 2",
249        "Custom Field 3",
250        "Custom Field 4",
251        "Custom Field 5",
252        "Custom Field 6",
253        "Custom Field 7",
254        "Custom Field 8",
255        "FRU File ID",
256        "Manufacturer",
257        "Model Number",
258        "Name",
259        "Serial Number",
260        "Version",
261        "fault",
262        "fru_type",
263        "is_fru",
264        "present",
265        "version",
266    ],
267    "MEMORY_BUFFER": [
268        "Custom Field 1",
269        "Custom Field 2",
270        "Custom Field 3",
271        "Custom Field 4",
272        "Custom Field 5",
273        "Custom Field 6",
274        "Custom Field 7",
275        "Custom Field 8",
276        "FRU File ID",
277        "Manufacturer",
278        "Name",
279        "Part Number",
280        "Serial Number",
281        "fault",
282        "fru_type",
283        "is_fru",
284        "present",
285        "version",
286    ],
287    "FAN": [
288        "fault",
289        "fru_type",
290        "is_fru",
291        "present",
292        "version",
293    ],
294    "DAUGHTER_CARD": [
295        "Custom Field 1",
296        "Custom Field 2",
297        "Custom Field 3",
298        "Custom Field 4",
299        "Custom Field 5",
300        "Custom Field 6",
301        "Custom Field 7",
302        "Custom Field 8",
303        "FRU File ID",
304        "Manufacturer",
305        "Name",
306        "Part Number",
307        "Serial Number",
308        "fault",
309        "fru_type",
310        "is_fru",
311        "present",
312        "version",
313    ],
314    "BMC": [
315        "fault",
316        "fru_type",
317        "is_fru",
318        "manufacturer",
319        "present",
320        "version",
321    ],
322    "MAIN_PLANAR": [
323        "Custom Field 1",
324        "Custom Field 2",
325        "Custom Field 3",
326        "Custom Field 4",
327        "Custom Field 5",
328        "Custom Field 6",
329        "Custom Field 7",
330        "Custom Field 8",
331        "Part Number",
332        "Serial Number",
333        "Type",
334        "fault",
335        "fru_type",
336        "is_fru",
337        "present",
338        "version",
339    ],
340    "SYSTEM": [
341        "Custom Field 1",
342        "Custom Field 2",
343        "Custom Field 3",
344        "Custom Field 4",
345        "Custom Field 5",
346        "Custom Field 6",
347        "Custom Field 7",
348        "Custom Field 8",
349        "FRU File ID",
350        "Manufacturer",
351        "Model Number",
352        "Name",
353        "Serial Number",
354        "Version",
355        "fault",
356        "fru_type",
357        "is_fru",
358        "present",
359        "version",
360    ],
361    "CORE": [
362        "fault",
363        "fru_type",
364        "is_fru",
365        "present",
366        "version",
367    ],
368}
369