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# The path on the BMC where signed keys are stored. 137ACTIVATION_DIR_PATH = "/etc/activationdata/" 138 139# Redfish variables. 140REDFISH_BASE_URI = '/redfish/v1/' 141REDFISH_SESSION = REDFISH_BASE_URI + 'SessionService/Sessions' 142REDFISH_SESSION_URI = 'SessionService/Sessions/' 143 144# rsyslog variables. 145REMOTE_LOGGING_URI = OPENBMC_BASE_URI + 'logging/config/remote/' 146 147''' 148 QEMU HTTPS variable: 149 150 By default lib/resource.txt AUTH URI construct is as 151 ${AUTH_URI} https://${OPENBMC_HOST}${AUTH_SUFFIX} 152 ${AUTH_SUFFIX} is populated here by default EMPTY else 153 the port from the OS environment 154''' 155 156 157def get_port_https(): 158 # defaulted to empty string 159 l_suffix = '' 160 try: 161 l_https_port = os.getenv('HTTPS_PORT') 162 if l_https_port: 163 l_suffix = ':' + l_https_port 164 except BaseException: 165 print ("Environment variable HTTPS_PORT not set,\ 166 using default HTTPS port") 167 return l_suffix 168 169 170AUTH_SUFFIX = { 171 "https_port": [get_port_https()], 172} 173 174# Update the ':Port number' to this variable 175AUTH_SUFFIX = AUTH_SUFFIX['https_port'][0] 176 177# Here contains a list of valid Properties bases on fru_type after a boot. 178INVENTORY_ITEMS = { 179 "CPU": [ 180 "Custom Field 1", 181 "Custom Field 2", 182 "Custom Field 3", 183 "Custom Field 4", 184 "Custom Field 5", 185 "Custom Field 6", 186 "Custom Field 7", 187 "Custom Field 8", 188 "FRU File ID", 189 "Manufacturer", 190 "Name", 191 "Part Number", 192 "Serial Number", 193 "fault", 194 "fru_type", 195 "is_fru", 196 "present", 197 "version", 198 ], 199 200 "DIMM": [ 201 "Asset Tag", 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 "Model Number", 213 "Name", 214 "Serial Number", 215 "Version", 216 "fault", 217 "fru_type", 218 "is_fru", 219 "present", 220 "version", 221 ], 222 "MEMORY_BUFFER": [ 223 "Custom Field 1", 224 "Custom Field 2", 225 "Custom Field 3", 226 "Custom Field 4", 227 "Custom Field 5", 228 "Custom Field 6", 229 "Custom Field 7", 230 "Custom Field 8", 231 "FRU File ID", 232 "Manufacturer", 233 "Name", 234 "Part Number", 235 "Serial Number", 236 "fault", 237 "fru_type", 238 "is_fru", 239 "present", 240 "version", 241 ], 242 "FAN": [ 243 "fault", 244 "fru_type", 245 "is_fru", 246 "present", 247 "version", 248 ], 249 "DAUGHTER_CARD": [ 250 "Custom Field 1", 251 "Custom Field 2", 252 "Custom Field 3", 253 "Custom Field 4", 254 "Custom Field 5", 255 "Custom Field 6", 256 "Custom Field 7", 257 "Custom Field 8", 258 "FRU File ID", 259 "Manufacturer", 260 "Name", 261 "Part Number", 262 "Serial Number", 263 "fault", 264 "fru_type", 265 "is_fru", 266 "present", 267 "version", 268 ], 269 "BMC": [ 270 "fault", 271 "fru_type", 272 "is_fru", 273 "manufacturer", 274 "present", 275 "version", 276 ], 277 "MAIN_PLANAR": [ 278 "Custom Field 1", 279 "Custom Field 2", 280 "Custom Field 3", 281 "Custom Field 4", 282 "Custom Field 5", 283 "Custom Field 6", 284 "Custom Field 7", 285 "Custom Field 8", 286 "Part Number", 287 "Serial Number", 288 "Type", 289 "fault", 290 "fru_type", 291 "is_fru", 292 "present", 293 "version", 294 ], 295 "SYSTEM": [ 296 "Custom Field 1", 297 "Custom Field 2", 298 "Custom Field 3", 299 "Custom Field 4", 300 "Custom Field 5", 301 "Custom Field 6", 302 "Custom Field 7", 303 "Custom Field 8", 304 "FRU File ID", 305 "Manufacturer", 306 "Model Number", 307 "Name", 308 "Serial Number", 309 "Version", 310 "fault", 311 "fru_type", 312 "is_fru", 313 "present", 314 "version", 315 ], 316 "CORE": [ 317 "fault", 318 "fru_type", 319 "is_fru", 320 "present", 321 "version", 322 ], 323} 324