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