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