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