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