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 = 'AccountService/Accounts/'
151REDFISH_ACCOUNTS_URI = REDFISH_BASE_URI + REDFISH_ACCOUNTS
152REDFISH_HTTPS_CERTIFICATE = 'Managers/bmc/NetworkProtocol/HTTPS/Certificates'
153REDFISH_HTTPS_CERTIFICATE_URI = REDFISH_BASE_URI + REDFISH_HTTPS_CERTIFICATE
154REDFISH_LDAP_CERTIFICATE = 'AccountService/LDAP/Certificates'
155REDFISH_LDAP_CERTIFICATE_URI = REDFISH_BASE_URI + REDFISH_LDAP_CERTIFICATE
156REDFISH_CA_CERTIFICATE = 'Managers/bmc/Truststore/Certificates'
157REDFISH_CA_CERTIFICATE_URI = REDFISH_BASE_URI + REDFISH_CA_CERTIFICATE
158REDFISH_CHASSIS_THERMAL = 'Chassis/chassis/Thermal'
159REDFISH_CHASSIS_THERMAL_URI = REDFISH_BASE_URI + REDFISH_CHASSIS_THERMAL
160
161# Boot options and URI variables.
162POWER_ON = 'On'
163POWER_GRACEFUL_OFF = "GracefulShutdown"
164POWER_GRACEFUL_RESTART = "GracefulRestart"
165POWER_FORCE_OFF = 'ForceOff'
166
167REDFISH_POWER_URI = 'Systems/1/Actions/ComputerSystem.Reset'
168
169# rsyslog variables.
170REMOTE_LOGGING_URI = OPENBMC_BASE_URI + 'logging/config/remote/'
171
172# Certificate variables.
173SERVER_CERTIFICATE_URI = OPENBMC_BASE_URI + 'certs/server/https'
174CLIENT_CERTIFICATE_URI = OPENBMC_BASE_URI + 'certs/client/ldap'
175CA_CERTIFICATE_URI = OPENBMC_BASE_URI + 'certs/authority/ldap'
176
177# EventLog variables.
178SYSTEM_BASE_URI = REDFISH_BASE_URI + 'Systems/system/'
179EVENT_LOG_URI = SYSTEM_BASE_URI + 'LogServices/EventLog/'
180
181
182'''
183  QEMU HTTPS variable:
184
185  By default lib/resource.robot AUTH URI construct is as
186  ${AUTH_URI}   https://${OPENBMC_HOST}${AUTH_SUFFIX}
187  ${AUTH_SUFFIX} is populated here by default EMPTY else
188  the port from the OS environment
189'''
190
191
192def get_port_https():
193    # defaulted to empty string
194    l_suffix = ''
195    try:
196        l_https_port = os.getenv('HTTPS_PORT')
197        if l_https_port:
198            l_suffix = ':' + l_https_port
199    except BaseException:
200        print ("Environment variable HTTPS_PORT not set,\
201              using default HTTPS port")
202    return l_suffix
203
204
205AUTH_SUFFIX = {
206    "https_port": [get_port_https()],
207}
208
209# Update the ':Port number' to this variable
210AUTH_SUFFIX = AUTH_SUFFIX['https_port'][0]
211
212# Here contains a list of valid Properties bases on fru_type after a boot.
213INVENTORY_ITEMS = {
214    "CPU": [
215        "Custom Field 1",
216        "Custom Field 2",
217        "Custom Field 3",
218        "Custom Field 4",
219        "Custom Field 5",
220        "Custom Field 6",
221        "Custom Field 7",
222        "Custom Field 8",
223        "FRU File ID",
224        "Manufacturer",
225        "Name",
226        "Part Number",
227        "Serial Number",
228        "fault",
229        "fru_type",
230        "is_fru",
231        "present",
232        "version",
233    ],
234
235    "DIMM": [
236        "Asset Tag",
237        "Custom Field 1",
238        "Custom Field 2",
239        "Custom Field 3",
240        "Custom Field 4",
241        "Custom Field 5",
242        "Custom Field 6",
243        "Custom Field 7",
244        "Custom Field 8",
245        "FRU File ID",
246        "Manufacturer",
247        "Model Number",
248        "Name",
249        "Serial Number",
250        "Version",
251        "fault",
252        "fru_type",
253        "is_fru",
254        "present",
255        "version",
256    ],
257    "MEMORY_BUFFER": [
258        "Custom Field 1",
259        "Custom Field 2",
260        "Custom Field 3",
261        "Custom Field 4",
262        "Custom Field 5",
263        "Custom Field 6",
264        "Custom Field 7",
265        "Custom Field 8",
266        "FRU File ID",
267        "Manufacturer",
268        "Name",
269        "Part Number",
270        "Serial Number",
271        "fault",
272        "fru_type",
273        "is_fru",
274        "present",
275        "version",
276    ],
277    "FAN": [
278        "fault",
279        "fru_type",
280        "is_fru",
281        "present",
282        "version",
283    ],
284    "DAUGHTER_CARD": [
285        "Custom Field 1",
286        "Custom Field 2",
287        "Custom Field 3",
288        "Custom Field 4",
289        "Custom Field 5",
290        "Custom Field 6",
291        "Custom Field 7",
292        "Custom Field 8",
293        "FRU File ID",
294        "Manufacturer",
295        "Name",
296        "Part Number",
297        "Serial Number",
298        "fault",
299        "fru_type",
300        "is_fru",
301        "present",
302        "version",
303    ],
304    "BMC": [
305        "fault",
306        "fru_type",
307        "is_fru",
308        "manufacturer",
309        "present",
310        "version",
311    ],
312    "MAIN_PLANAR": [
313        "Custom Field 1",
314        "Custom Field 2",
315        "Custom Field 3",
316        "Custom Field 4",
317        "Custom Field 5",
318        "Custom Field 6",
319        "Custom Field 7",
320        "Custom Field 8",
321        "Part Number",
322        "Serial Number",
323        "Type",
324        "fault",
325        "fru_type",
326        "is_fru",
327        "present",
328        "version",
329    ],
330    "SYSTEM": [
331        "Custom Field 1",
332        "Custom Field 2",
333        "Custom Field 3",
334        "Custom Field 4",
335        "Custom Field 5",
336        "Custom Field 6",
337        "Custom Field 7",
338        "Custom Field 8",
339        "FRU File ID",
340        "Manufacturer",
341        "Model Number",
342        "Name",
343        "Serial Number",
344        "Version",
345        "fault",
346        "fru_type",
347        "is_fru",
348        "present",
349        "version",
350    ],
351    "CORE": [
352        "fault",
353        "fru_type",
354        "is_fru",
355        "present",
356        "version",
357    ],
358}
359