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