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/'
77
78# Host control URI variables.
79CONTROL_HOST_URI = OPENBMC_BASE_URI + 'control/host0/'
80
81# 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
89# Dump URI variables.
90DUMP_URI = OPENBMC_BASE_URI + 'dump/'
91DUMP_ENTRY_URI = DUMP_URI + 'entry/'
92# The path on the BMC where dumps are stored.
93DUMP_DIR_PATH = "/var/lib/phosphor-debug-collector/dumps/"
94
95# 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'
99OS_BOOT_PCI = STATE_DBUS_BASE + 'Boot.Progress.ProgressStages.PCIInit'
100OS_BOOT_SECPCI = STATE_DBUS_BASE + \
101    'Boot.Progress.ProgressStages.SecondaryProcInit'
102OS_BOOT_MEM = STATE_DBUS_BASE + 'Boot.Progress.ProgressStages.MemoryInit'
103OS_BOOT_MOTHERBOARD = STATE_DBUS_BASE + \
104    'Boot.Progress.ProgressStages.MotherboardInit'
105
106# OperatingSystem status variables.
107OS_BOOT_COMPLETE = STATE_DBUS_BASE + \
108    'OperatingSystem.Status.OSStatus.BootComplete'
109OS_BOOT_CDROM = STATE_DBUS_BASE + 'OperatingSystem.Status.OSStatus.CDROMBoot'
110OS_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'
114
115# 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
124# 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
133# User manager variable.
134BMC_USER_URI = OPENBMC_BASE_URI + 'user/'
135
136# LDAP User manager variable.
137BMC_LDAP_URI = BMC_USER_URI + 'ldap'
138
139# The path on the BMC where signed keys are stored.
140ACTIVATION_DIR_PATH = "/etc/activationdata/"
141
142# Redfish variables.
143REDFISH_BASE_URI = '/redfish/v1/'
144REDFISH_SESSION = REDFISH_BASE_URI + 'SessionService/Sessions'
145REDFISH_SESSION_URI = 'SessionService/Sessions/'
146REDFISH_NW_ETH0 = 'Managers/bmc/EthernetInterfaces/eth0/'
147REDFISH_NW_ETH0_URI = REDFISH_BASE_URI + REDFISH_NW_ETH0
148REDFISH_NW_PROTOCOL = 'Managers/bmc/NetworkProtocol'
149REDFISH_NW_PROTOCOL_URI = REDFISH_BASE_URI + REDFISH_NW_PROTOCOL
150REDFISH_ACCOUNTS_SERVICE = 'AccountService/'
151REDFISH_ACCOUNTS_SERVICE_URI = REDFISH_BASE_URI + REDFISH_ACCOUNTS_SERVICE
152REDFISH_ACCOUNTS = 'AccountService/Accounts/'
153REDFISH_ACCOUNTS_URI = REDFISH_BASE_URI + REDFISH_ACCOUNTS
154REDFISH_HTTPS_CERTIFICATE = 'Managers/bmc/NetworkProtocol/HTTPS/Certificates'
155REDFISH_HTTPS_CERTIFICATE_URI = REDFISH_BASE_URI + REDFISH_HTTPS_CERTIFICATE
156REDFISH_LDAP_CERTIFICATE = 'AccountService/LDAP/Certificates'
157REDFISH_LDAP_CERTIFICATE_URI = REDFISH_BASE_URI + REDFISH_LDAP_CERTIFICATE
158REDFISH_CA_CERTIFICATE = 'Managers/bmc/Truststore/Certificates'
159REDFISH_CA_CERTIFICATE_URI = REDFISH_BASE_URI + REDFISH_CA_CERTIFICATE
160REDFISH_CHASSIS_THERMAL = 'Chassis/chassis/Thermal'
161REDFISH_CHASSIS_THERMAL_URI = REDFISH_BASE_URI + REDFISH_CHASSIS_THERMAL
162
163# Boot options and URI variables.
164POWER_ON = 'On'
165POWER_GRACEFUL_OFF = "GracefulShutdown"
166POWER_GRACEFUL_RESTART = "GracefulRestart"
167POWER_FORCE_OFF = 'ForceOff'
168
169REDFISH_POWER_URI = 'Systems/1/Actions/ComputerSystem.Reset'
170
171# rsyslog variables.
172REMOTE_LOGGING_URI = OPENBMC_BASE_URI + 'logging/config/remote/'
173
174# Certificate variables.
175SERVER_CERTIFICATE_URI = OPENBMC_BASE_URI + 'certs/server/https'
176CLIENT_CERTIFICATE_URI = OPENBMC_BASE_URI + 'certs/client/ldap'
177CA_CERTIFICATE_URI = OPENBMC_BASE_URI + 'certs/authority/ldap'
178
179# EventLog variables.
180SYSTEM_BASE_URI = REDFISH_BASE_URI + 'Systems/system/'
181EVENT_LOG_URI = SYSTEM_BASE_URI + 'LogServices/EventLog/'
182
183
184'''
185  QEMU HTTPS variable:
186
187  By default lib/resource.robot AUTH URI construct is as
188  ${AUTH_URI}   https://${OPENBMC_HOST}${AUTH_SUFFIX}
189  ${AUTH_SUFFIX} is populated here by default EMPTY else
190  the port from the OS environment
191'''
192
193
194def get_port_https():
195    # defaulted to empty string
196    l_suffix = ''
197    try:
198        l_https_port = os.getenv('HTTPS_PORT')
199        if l_https_port:
200            l_suffix = ':' + l_https_port
201    except BaseException:
202        print ("Environment variable HTTPS_PORT not set,\
203              using default HTTPS port")
204    return l_suffix
205
206
207AUTH_SUFFIX = {
208    "https_port": [get_port_https()],
209}
210
211# Update the ':Port number' to this variable
212AUTH_SUFFIX = AUTH_SUFFIX['https_port'][0]
213
214# Here contains a list of valid Properties bases on fru_type after a boot.
215INVENTORY_ITEMS = {
216    "CPU": [
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        "Name",
228        "Part Number",
229        "Serial Number",
230        "fault",
231        "fru_type",
232        "is_fru",
233        "present",
234        "version",
235    ],
236
237    "DIMM": [
238        "Asset Tag",
239        "Custom Field 1",
240        "Custom Field 2",
241        "Custom Field 3",
242        "Custom Field 4",
243        "Custom Field 5",
244        "Custom Field 6",
245        "Custom Field 7",
246        "Custom Field 8",
247        "FRU File ID",
248        "Manufacturer",
249        "Model Number",
250        "Name",
251        "Serial Number",
252        "Version",
253        "fault",
254        "fru_type",
255        "is_fru",
256        "present",
257        "version",
258    ],
259    "MEMORY_BUFFER": [
260        "Custom Field 1",
261        "Custom Field 2",
262        "Custom Field 3",
263        "Custom Field 4",
264        "Custom Field 5",
265        "Custom Field 6",
266        "Custom Field 7",
267        "Custom Field 8",
268        "FRU File ID",
269        "Manufacturer",
270        "Name",
271        "Part Number",
272        "Serial Number",
273        "fault",
274        "fru_type",
275        "is_fru",
276        "present",
277        "version",
278    ],
279    "FAN": [
280        "fault",
281        "fru_type",
282        "is_fru",
283        "present",
284        "version",
285    ],
286    "DAUGHTER_CARD": [
287        "Custom Field 1",
288        "Custom Field 2",
289        "Custom Field 3",
290        "Custom Field 4",
291        "Custom Field 5",
292        "Custom Field 6",
293        "Custom Field 7",
294        "Custom Field 8",
295        "FRU File ID",
296        "Manufacturer",
297        "Name",
298        "Part Number",
299        "Serial Number",
300        "fault",
301        "fru_type",
302        "is_fru",
303        "present",
304        "version",
305    ],
306    "BMC": [
307        "fault",
308        "fru_type",
309        "is_fru",
310        "manufacturer",
311        "present",
312        "version",
313    ],
314    "MAIN_PLANAR": [
315        "Custom Field 1",
316        "Custom Field 2",
317        "Custom Field 3",
318        "Custom Field 4",
319        "Custom Field 5",
320        "Custom Field 6",
321        "Custom Field 7",
322        "Custom Field 8",
323        "Part Number",
324        "Serial Number",
325        "Type",
326        "fault",
327        "fru_type",
328        "is_fru",
329        "present",
330        "version",
331    ],
332    "SYSTEM": [
333        "Custom Field 1",
334        "Custom Field 2",
335        "Custom Field 3",
336        "Custom Field 4",
337        "Custom Field 5",
338        "Custom Field 6",
339        "Custom Field 7",
340        "Custom Field 8",
341        "FRU File ID",
342        "Manufacturer",
343        "Model Number",
344        "Name",
345        "Serial Number",
346        "Version",
347        "fault",
348        "fru_type",
349        "is_fru",
350        "present",
351        "version",
352    ],
353    "CORE": [
354        "fault",
355        "fru_type",
356        "is_fru",
357        "present",
358        "version",
359    ],
360}
361