Module Expr Str Import alias ImportFrom alias identifier ImportFrom alias ImportFrom alias identifier ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias identifier Assign NameStore Call AttributeLoad NameLoad attr Str If NameLoad body ImportFrom alias identifier ImportFrom alias identifier Assign NameStore ListLoad Call AttributeLoad NameLoad attr Str keyword Num keyword Call NameLoad Str Call AttributeLoad NameLoad attr Str keyword Num keyword Call NameLoad Str Assign NameStore AttributeLoad NameLoad attr Expr Call AttributeLoad NameLoad attr NameLoad keyword Str Assign NameStore Call AttributeLoad NameLoad attr NameLoad Assign NameStore Dict Str Str Str Call NameLoad Str Call NameLoad Str Call NameLoad Str Assign NameStore Dict Str Call NameLoad Str Assign NameStore Call AttributeLoad NameLoad attr Expr Call AttributeLoad NameLoad attr NameLoad Assign NameStore Dict Str Call NameLoad Str Assign NameStore Dict AttributeLoad NameLoad attr AttributeLoad NameLoad attr AttributeLoad NameLoad attr AttributeLoad NameLoad attr Str Str Str Str FunctionDef arguments args NameParam defaults body Expr Str Assign NameStore BoolOpOr AttributeLoad NameLoad attr Dict Assign NameStore ListComp NameLoad comprehension NameStore NameLoad UnaryOpNot Call AttributeLoad NameLoad attr NameLoad If NameLoad body Raise Call AttributeLoad NameLoad attr BinOpMod Call NameLoad Str NameLoad Assign NameStore Dict Assign SubscriptStore NameLoad Index Str Call AttributeLoad NameLoad attr Str Assign SubscriptStore NameLoad Index Str Call AttributeLoad NameLoad attr Str Assign SubscriptStore NameLoad Index Str Call AttributeLoad NameLoad attr Str Assign SubscriptStore NameLoad Index Str Call AttributeLoad NameLoad attr Str NameLoad Assign SubscriptStore NameLoad Index Str AttributeLoad NameLoad attr Assign NameStore Call AttributeLoad NameLoad attr Str If CompareIsNot NameLoad NameLoad body Assign NameStore Call AttributeLoad NameLoad attr NameLoad Str Assign SubscriptStore NameLoad Index Str NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Assign NameStore BinOpMod Str Dict Str NameLoad Return Call AttributeLoad AttributeLoad NameLoad attr attr AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Assign NameStore Call NameLoad Str TryExcept body Assign NameStore Call AttributeLoad NameLoad attr keyword SubscriptLoad NameLoad Index Str keyword SubscriptLoad NameLoad Index Str keyword SubscriptLoad NameLoad Index Str Assign NameStore AttributeLoad AttributeLoad NameLoad attr attr Assign NameStore Call AttributeLoad NameLoad attr Str NameLoad handlers ExceptHandler type AttributeLoad NameLoad attr name NameStore body Assign NameStore BinOpMod NameLoad Dict Str Str SubscriptLoad NameLoad Index Str NameLoad Expr Call AttributeLoad NameLoad attr NameLoad Raise Call AttributeLoad NameLoad attr NameLoad Assign NameStore Call AttributeLoad NameLoad attr Str If CompareEq NameLoad Str body Return AttributeLoad NameLoad attr orelse Assign NameStore BinOpMod Call NameLoad Str NameLoad Expr Call AttributeLoad NameLoad attr NameLoad Dict Str Str SubscriptLoad NameLoad Index Str NameLoad Raise Call AttributeLoad NameLoad attr keyword AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam defaults body Expr Str Assign NameStore Call NameLoad Str TryExcept body Assign NameStore Call AttributeLoad NameLoad attr keyword SubscriptLoad NameLoad Index Str keyword SubscriptLoad NameLoad Index Str keyword SubscriptLoad NameLoad Index Str Assign NameStore AttributeLoad AttributeLoad NameLoad attr attr Assign NameStore Call AttributeLoad NameLoad attr Str NameLoad handlers ExceptHandler type AttributeLoad NameLoad attr name NameStore body Assign NameStore BinOpMod NameLoad Dict Str Str SubscriptLoad NameLoad Index Str NameLoad Expr Call AttributeLoad NameLoad attr NameLoad Raise Call AttributeLoad NameLoad attr NameLoad Assign NameStore Call AttributeLoad NameLoad attr Str If CompareEq NameLoad Str body Return AttributeLoad NameLoad attr orelse Assign NameStore BinOpMod Call NameLoad Str NameLoad Expr Call AttributeLoad NameLoad attr NameLoad Dict Str Str SubscriptLoad NameLoad Index Str NameLoad Raise Call AttributeLoad NameLoad attr keyword AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam defaults body Expr Str Assign NameStore Call NameLoad Str TryExcept body Assign NameStore Call AttributeLoad NameLoad attr keyword SubscriptLoad NameLoad Index Str keyword SubscriptLoad NameLoad Index Str keyword SubscriptLoad NameLoad Index Str Assign NameStore AttributeLoad AttributeLoad NameLoad attr attr Assign NameStore Call AttributeLoad NameLoad attr Str NameLoad handlers ExceptHandler type AttributeLoad NameLoad attr name NameStore body Assign NameStore BinOpMod NameLoad Dict Str Str SubscriptLoad NameLoad Index Str NameLoad Expr Call AttributeLoad NameLoad attr NameLoad Raise Call AttributeLoad NameLoad attr NameLoad If CompareIn Str NameLoad body Assign NameStore BinOpMod Call NameLoad Str NameLoad Expr Call AttributeLoad NameLoad attr NameLoad Dict Str Str SubscriptLoad NameLoad Index Str NameLoad Raise Call AttributeLoad NameLoad attr keyword AttributeLoad NameLoad attr Return AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam defaults body Expr Str TryExcept body Assign NameStore Call AttributeLoad NameLoad attr keyword SubscriptLoad NameLoad Index Str keyword SubscriptLoad NameLoad Index Str keyword SubscriptLoad NameLoad Index Str Assign NameStore Call AttributeLoad NameLoad attr handlers ExceptHandler type AttributeLoad NameLoad attr name NameStore body Assign NameStore BinOpMod Call NameLoad Str Dict Str Str SubscriptLoad NameLoad Index Str NameLoad Expr Call AttributeLoad NameLoad attr NameLoad Raise Call AttributeLoad NameLoad attr NameLoad Assign NameStore Call AttributeLoad NameLoad attr Str If CompareEq NameLoad Str body Return AttributeLoad NameLoad attr orelse If CompareEq NameLoad Str body Return AttributeLoad NameLoad attr orelse Expr Call AttributeLoad NameLoad attr Call NameLoad Str Dict Str Str SubscriptLoad NameLoad Index Str NameLoad Return AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam defaults body Expr Str TryExcept body Assign NameStore Call AttributeLoad NameLoad attr keyword SubscriptLoad NameLoad Index Str keyword SubscriptLoad NameLoad Index Str keyword SubscriptLoad NameLoad Index Str Assign NameStore Call AttributeLoad NameLoad attr handlers ExceptHandler type NameLoad name NameStore body Expr Call AttributeLoad NameLoad attr Call NameLoad Str Dict Str Str SubscriptLoad NameLoad Index Str NameLoad Raise Call AttributeLoad NameLoad attr keyword SubscriptLoad NameLoad Index Str keyword NameLoad If UnaryOpNot NameLoad body Return Dict Assign NameStore Dict For NameStore NameLoad body If UnaryOpNot AttributeLoad NameLoad attr body Continue Assign SubscriptStore Call AttributeLoad NameLoad attr AttributeLoad NameLoad attr Dict Index AttributeLoad NameLoad attr Dict Str Str Str Str Str BinOpMod Str TupleLoad AttributeLoad NameLoad attr AttributeLoad NameLoad attr AttributeLoad NameLoad attr Call NameLoad AttributeLoad NameLoad attr AttributeLoad NameLoad attr Call NameLoad AttributeLoad NameLoad attr Return NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str TryExcept body Assign NameStore ListComp Call NameLoad NameLoad keyword Num comprehension NameStore Call AttributeLoad NameLoad attr Return TupleLoad SubscriptLoad NameLoad Index Num SubscriptLoad NameLoad Index Num SubscriptLoad NameLoad Slice Num handlers ExceptHandler type NameLoad body Raise Call AttributeLoad NameLoad attr BinOpMod Call NameLoad Str NameLoad ExceptHandler type NameLoad body Raise Call AttributeLoad NameLoad attr Call NameLoad Str decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Assign TupleStore NameStore NameStore NameStore Call NameLoad NameLoad Expr Call AttributeLoad NameLoad attr Str Dict Str Str NameLoad SubscriptLoad NameLoad Index Str TryExcept body Assign NameStore Call AttributeLoad NameLoad attr keyword SubscriptLoad NameLoad Index Str keyword SubscriptLoad NameLoad Index Str keyword SubscriptLoad NameLoad Index Str Expr Call AttributeLoad NameLoad attr NameLoad NameLoad keyword NameLoad handlers ExceptHandler type AttributeLoad NameLoad attr name NameStore body Assign NameStore BinOpMod Call NameLoad Str Dict Str Str Str NameLoad SubscriptLoad NameLoad Index Str NameLoad Expr Call AttributeLoad NameLoad attr NameLoad Raise Call AttributeLoad NameLoad attr NameLoad decorator_list ClassDef bases AttributeLoad NameLoad attr body Expr Str FunctionDef arguments args NameParam defaults body Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Expr Call NameLoad AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Assign NameStore Call NameLoad AttributeLoad NameLoad attr Return Call NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults body Expr Str Assign NameStore Call NameLoad AttributeLoad NameLoad attr If CompareEq NameLoad AttributeLoad NameLoad attr body Expr Call AttributeLoad NameLoad attr NameLoad NameLoad Expr Call NameLoad NameLoad orelse If CompareEq NameLoad AttributeLoad NameLoad attr body Expr Call NameLoad NameLoad orelse Raise Call AttributeLoad NameLoad attr BinOpMod Call NameLoad Str NameLoad decorator_list AttributeLoad NameLoad attr FunctionDef arguments args NameParam NameParam defaults body Expr Str Assign NameStore Call NameLoad AttributeLoad NameLoad attr Expr Call AttributeLoad NameLoad attr NameLoad NameLoad Expr Call NameLoad NameLoad decorator_list AttributeLoad NameLoad attr decorator_list ClassDef bases AttributeLoad NameLoad attr body FunctionDef arguments args NameParam defaults body Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Expr Call NameLoad AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Return Call NameLoad Call AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam defaults NameLoad body Expr Str If CompareNotIn NameLoad Call AttributeLoad NameLoad attr NameLoad body Raise Call AttributeLoad NameLoad attr BinOpMod Call NameLoad Str NameLoad If Call AttributeLoad AttributeLoad AttributeLoad NameLoad attr attr attr Str NameLoad body Expr Call AttributeLoad NameLoad attr NameLoad NameLoad NameLoad Assign NameStore NameLoad Assign NameStore Call NameLoad AttributeLoad NameLoad attr TryExcept body Assign NameStore Call AttributeLoad NameLoad attr keyword SubscriptLoad NameLoad Index Str keyword SubscriptLoad NameLoad Index Str keyword SubscriptLoad NameLoad Index Str Assign NameStore SubscriptLoad NameLoad Index NameLoad Expr Call AttributeLoad NameLoad attr NameLoad keyword NameLoad handlers ExceptHandler type AttributeLoad NameLoad attr name NameStore body Expr Call AttributeLoad NameLoad attr Call NameLoad Str Dict Str Str SubscriptLoad NameLoad Index Str NameLoad Raise Call AttributeLoad NameLoad attr keyword NameLoad decorator_list AttributeLoad NameLoad attr FunctionDef arguments args NameParam NameParam defaults body Expr Str Assign NameStore AttributeLoad AttributeLoad NameLoad attr attr Assign NameStore AttributeLoad AttributeLoad NameLoad attr attr If BoolOpAnd Call AttributeLoad NameLoad attr Str NameLoad Call AttributeLoad NameLoad attr Str Call AttributeLoad NameLoad attr Str NameLoad body Return Dict Str Str SubscriptLoad NameLoad Index Str NameLoad Assign NameStore Call NameLoad AttributeLoad NameLoad attr Assign NameStore Dict Str NameLoad TryExcept body Assign NameStore Call AttributeLoad NameLoad attr keyword SubscriptLoad NameLoad Index Str keyword SubscriptLoad NameLoad Index Str keyword SubscriptLoad NameLoad Index Str Assign NameStore Call AttributeLoad NameLoad attr If CompareIn Str NameLoad body Raise Call AttributeLoad NameLoad attr SubscriptLoad NameLoad Index Str handlers ExceptHandler type AttributeLoad NameLoad attr name NameStore body Expr Call AttributeLoad NameLoad attr Call NameLoad Str Dict Str Str SubscriptLoad NameLoad Index Str NameLoad Raise Call AttributeLoad NameLoad attr keyword NameLoad Assign SubscriptStore NameLoad Index Str Call AttributeLoad NameLoad attr Str Assign NameStore Call AttributeLoad NameLoad attr Str If NameLoad body Assign SubscriptStore NameLoad Index Str Call NameLoad GeneratorExp NameLoad comprehension TupleStore NameStore NameStore Call AttributeLoad NameLoad attr CompareEq NameLoad NameLoad NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Assign NameStore Call NameLoad AttributeLoad NameLoad attr Return Call NameLoad NameLoad decorator_list decorator_list ClassDef bases AttributeLoad NameLoad attr body Expr Str FunctionDef arguments args NameParam defaults body Assign NameStore Call AttributeLoad NameLoad attr Expr Call AttributeLoad NameLoad attr NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Assign NameStore Call NameLoad AttributeLoad NameLoad attr If UnaryOpNot SubscriptLoad NameLoad Index Str body Raise Call AttributeLoad NameLoad attr Call NameLoad Str decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Assign NameStore Call NameLoad AttributeLoad NameLoad attr Assign NameStore Call NameLoad SubscriptLoad NameLoad Index Str Assign NameStore Call AttributeLoad NameLoad attr NameLoad SubscriptLoad NameLoad Index Str Assign NameStore BinOpMod Str Dict Str Str Str Str Str Call AttributeLoad NameLoad attr Call AttributeLoad NameLoad attr SubscriptLoad NameLoad Index Str SubscriptLoad NameLoad Index Str NameLoad TryExcept body Expr Call AttributeLoad NameLoad attr SubscriptLoad NameLoad Index Str SubscriptLoad NameLoad Index Str NameLoad handlers ExceptHandler type AttributeLoad NameLoad attr body With Call AttributeLoad NameLoad attr body Expr Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str TryFinally body Expr Call AttributeLoad NameLoad attr AttributeLoad AttributeLoad NameLoad attr attr finalbody Assign NameStore Call NameLoad AttributeLoad AttributeLoad NameLoad attr attr Expr Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Assign NameStore Call NameLoad AttributeLoad NameLoad attr Assign NameStore Call AttributeLoad NameLoad attr SubscriptLoad NameLoad Index Str Return Dict Str Str Str NameLoad decorator_list decorator_list ClassDef bases AttributeLoad NameLoad attr body FunctionDef arguments args NameParam defaults body Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults kwarg body Expr Str If CompareEq NameLoad Str body Assign NameStore Call AttributeLoad NameLoad attr Str If UnaryOpNot NameLoad body Raise Call AttributeLoad NameLoad attr Call NameLoad Str Expr Call NameLoad NameLoad Expr Call NameLoad AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam defaults body Expr Str Assign NameStore Call NameLoad AttributeLoad NameLoad attr Expr Call NameLoad NameLoad NameLoad decorator_list Call AttributeLoad NameLoad attr ListLoad Str AttributeLoad NameLoad attr FunctionDef arguments args NameParam NameParam NameParam NameParam defaults NameLoad body Expr Str Assign NameStore Call NameLoad AttributeLoad NameLoad attr Assign NameStore Call AttributeLoad NameLoad attr NameLoad Assign NameStore IfExp NameLoad Str Str Assign NameStore BinOpAdd Str NameLoad Expr Call NameLoad NameLoad NameLoad decorator_list Call AttributeLoad NameLoad attr ListLoad Str AttributeLoad NameLoad attr decorator_list
N/A N/A 
Ironic Native IPMI power manager.
 N/A os ironic_lib utils ironic_utils oslo_config cfg oslo_log log logging oslo_utils excutils oslo_utils importutils oslo_utils strutils ironic.common boot_devices ironic.common exception ironic.common.i18n _ ironic.common.i18n _LE ironic.common.i18n _LW ironic.common states ironic.common utils ironic.conductor task_manager ironic.drivers base ironic.drivers.modules console_utils ironic.drivers utils driver_utils N/A pyghmi N/A N/A importutils try_import pyghmi N/A pyghmi N/A pyghmi exceptions pyghmi_exception pyghmi.ipmi command ipmi_command N/A opts N/A N/A N/A cfg IntOpt retry_timeout default 60 help N/A _ Maximum time in seconds to retry IPMI operations. There is a tradeoff when setting this value. Setting this too low may cause older BMCs to crash and require a hard reset. However, setting too high can cause the sync power state periodic task to hang when there are slow or unresponsive BMCs. N/A N/A cfg IntOpt min_command_interval default 5 help N/A _ Minimum time, in seconds, between IPMI operations sent to a server. There is a risk with some hardware that setting this too low may cause the BMC to crash. Recommended setting is 5 seconds. N/A CONF N/A cfg CONF N/A N/A N/A CONF register_opts opts group ipmi N/A LOG N/A N/A logging getLogger __name__ N/A REQUIRED_PROPERTIES N/A ipmi_address ipmi_password ipmi_username N/A _ IP of the node's BMC. Required. N/A _ IPMI password. Required. N/A _ IPMI username. Required. N/A OPTIONAL_PROPERTIES N/A ipmi_force_boot_device N/A _ Whether Ironic should specify the boot device to the BMC each time the server is turned on, eg. because the BMC is not capable of remembering the selected boot device across power cycles; default value is False. Optional. N/A COMMON_PROPERTIES N/A N/A REQUIRED_PROPERTIES copy N/A N/A N/A COMMON_PROPERTIES update OPTIONAL_PROPERTIES N/A CONSOLE_PROPERTIES N/A ipmi_terminal_port N/A _ node's UDP port to connect to. Only required for console access. N/A _BOOT_DEVICES_MAP N/A N/A boot_devices DISK N/A boot_devices PXE N/A boot_devices CDROM N/A boot_devices BIOS hd network cdrom setup _parse_driver_info N/A N/A node N/A N/A N/A Gets the bmc access info for the given node.

    :raises: MissingParameterValue when required ipmi credentials
            are missing.
    :raises: InvalidParameterValue when the IPMI terminal port is not an
            integer.
     N/A info N/A N/A node driver_info N/A N/A missing_info N/A key N/A key REQUIRED_PROPERTIES N/A N/A N/A info get key N/A missing_info N/A N/A N/A N/A exception MissingParameterValue N/A N/A _ Missing the following IPMI credentials in node's driver_info: %s. missing_info N/A bmc_info N/A N/A N/A bmc_info N/A address N/A N/A info get ipmi_address N/A N/A bmc_info N/A username N/A N/A info get ipmi_username N/A N/A bmc_info N/A password N/A N/A info get ipmi_password N/A N/A bmc_info N/A force_boot_device N/A N/A info get ipmi_force_boot_device False N/A N/A bmc_info N/A uuid N/A node uuid N/A port N/A N/A info get ipmi_terminal_port N/A N/A port None N/A N/A port N/A N/A utils validate_network_port port ipmi_terminal_port N/A N/A bmc_info N/A port port N/A bmc_info N/A _console_pwfile_path N/A N/A uuid N/A N/A N/A Return the file path for storing the ipmi password. N/A file_name N/A %(uuid)s.pw N/A uuid uuid N/A N/A N/A N/A os path join N/A CONF tempdir file_name N/A _power_on N/A N/A driver_info N/A N/A N/A Turn the power on for this node.

    :param driver_info: the bmc access info for a node.
    :returns: power state POWER_ON, one of :class:`ironic.common.states`.
    :raises: IPMIFailure when the native ipmi call fails.
    :raises: PowerStateFailure when invalid power state is returned
             from ipmi.
     N/A msg N/A _ IPMI power on failed for node %(node_id)s with the following error: %(error)s N/A N/A N/A ipmicmd N/A N/A ipmi_command Command bmc N/A driver_info N/A address userid N/A driver_info N/A username password N/A driver_info N/A password N/A wait N/A N/A CONF ipmi retry_timeout N/A ret N/A N/A ipmicmd set_power on wait N/A N/A N/A N/A pyghmi_exception IpmiException N/A e N/A N/A error N/A msg N/A node_id error N/A driver_info N/A uuid e N/A N/A N/A LOG error error N/A N/A N/A exception IPMIFailure error N/A state N/A N/A ret get powerstate N/A N/A state on N/A N/A N/A states POWER_ON N/A N/A error N/A N/A _ bad response: %s ret N/A N/A N/A LOG error msg N/A node_id error N/A driver_info N/A uuid error N/A N/A N/A exception PowerStateFailure pstate N/A states POWER_ON N/A _power_off N/A N/A driver_info N/A N/A N/A Turn the power off for this node.

    :param driver_info: the bmc access info for a node.
    :returns: power state POWER_OFF, one of :class:`ironic.common.states`.
    :raises: IPMIFailure when the native ipmi call fails.
    :raises: PowerStateFailure when invalid power state is returned
             from ipmi.
     N/A msg N/A _ IPMI power off failed for node %(node_id)s with the following error: %(error)s N/A N/A N/A ipmicmd N/A N/A ipmi_command Command bmc N/A driver_info N/A address userid N/A driver_info N/A username password N/A driver_info N/A password N/A wait N/A N/A CONF ipmi retry_timeout N/A ret N/A N/A ipmicmd set_power off wait N/A N/A N/A N/A pyghmi_exception IpmiException N/A e N/A N/A error N/A msg N/A node_id error N/A driver_info N/A uuid e N/A N/A N/A LOG error error N/A N/A N/A exception IPMIFailure error N/A state N/A N/A ret get powerstate N/A N/A state off N/A N/A N/A states POWER_OFF N/A N/A error N/A N/A _ bad response: %s ret N/A N/A N/A LOG error msg N/A node_id error N/A driver_info N/A uuid error N/A N/A N/A exception PowerStateFailure pstate N/A states POWER_OFF N/A _reboot N/A N/A driver_info N/A N/A N/A Reboot this node.

    If the power is off, turn it on. If the power is on, reset it.

    :param driver_info: the bmc access info for a node.
    :returns: power state POWER_ON, one of :class:`ironic.common.states`.
    :raises: IPMIFailure when the native ipmi call fails.
    :raises: PowerStateFailure when invalid power state is returned
             from ipmi.
     N/A msg N/A _ IPMI power reboot failed for node %(node_id)s with the following error: %(error)s N/A N/A N/A ipmicmd N/A N/A ipmi_command Command bmc N/A driver_info N/A address userid N/A driver_info N/A username password N/A driver_info N/A password N/A wait N/A N/A CONF ipmi retry_timeout N/A ret N/A N/A ipmicmd set_power boot wait N/A N/A N/A N/A pyghmi_exception IpmiException N/A e N/A N/A error N/A msg N/A node_id error N/A driver_info N/A uuid e N/A N/A N/A LOG error error N/A N/A N/A exception IPMIFailure error N/A N/A error ret N/A N/A error N/A N/A _ bad response: %s ret N/A N/A N/A LOG error msg N/A node_id error N/A driver_info N/A uuid error N/A N/A N/A exception PowerStateFailure pstate N/A states REBOOT N/A N/A states POWER_ON N/A _power_status N/A N/A driver_info N/A N/A N/A Get the power status for this node.

    :param driver_info: the bmc access info for a node.
    :returns: power state POWER_ON, POWER_OFF or ERROR defined in
             :class:`ironic.common.states`.
    :raises: IPMIFailure when the native ipmi call fails.
     N/A N/A N/A ipmicmd N/A N/A ipmi_command Command bmc N/A driver_info N/A address userid N/A driver_info N/A username password N/A driver_info N/A password N/A ret N/A N/A ipmicmd get_power N/A N/A N/A N/A pyghmi_exception IpmiException N/A e N/A N/A msg N/A N/A _ IPMI get power state failed for node %(node_id)s with the following error: %(error)s N/A node_id error N/A driver_info N/A uuid e N/A N/A N/A LOG error msg N/A N/A N/A exception IPMIFailure msg N/A state N/A N/A ret get powerstate N/A N/A state on N/A N/A N/A states POWER_ON N/A N/A N/A state off N/A N/A N/A states POWER_OFF N/A N/A N/A N/A LOG warning N/A _LW IPMI get power state for node %(node_id)s returns the following details: %(detail)s N/A node_id detail N/A driver_info N/A uuid ret N/A N/A states ERROR N/A _get_sensors_data N/A N/A driver_info N/A N/A N/A Get sensors data.

    :param driver_info: node's driver info
    :raises: FailedToGetSensorData when getting the sensor data fails.
    :returns: returns a dict of sensor data group by sensor type.
     N/A N/A N/A ipmicmd N/A N/A ipmi_command Command bmc N/A driver_info N/A address userid N/A driver_info N/A username password N/A driver_info N/A password N/A ret N/A N/A ipmicmd get_sensor_data N/A N/A N/A Exception N/A e N/A N/A N/A N/A LOG error N/A _LE IPMI get sensor data failed for node %(node_id)s with the following error: %(error)s N/A node_id error N/A driver_info N/A uuid e N/A N/A N/A exception FailedToGetSensorData node N/A driver_info N/A uuid error e N/A N/A ret N/A N/A N/A N/A sensors_data N/A N/A reading ret N/A N/A N/A N/A reading value N/A N/A N/A N/A N/A N/A sensors_data setdefault N/A reading type N/A N/A N/A reading name N/A Sensor Reading Sensor ID States Units Health N/A %s %s N/A N/A reading value N/A reading units N/A reading name N/A str N/A reading states N/A reading units N/A str N/A reading health N/A sensors_data N/A _parse_raw_bytes N/A N/A raw_bytes N/A N/A N/A Parse raw bytes string.

    :param raw_bytes: a string of hexadecimal raw bytes, e.g. '0x00 0x01'.
    :returns: a tuple containing the arguments for pyghmi call as integers,
             (IPMI net function, IPMI command, list of command's data).
    :raises: InvalidParameterValue when an invalid value is specified.
     N/A N/A N/A bytes_list N/A N/A int x base 16 N/A x N/A N/A raw_bytes split N/A N/A N/A bytes_list N/A 0 N/A bytes_list N/A 1 N/A bytes_list N/A 2 N/A N/A N/A ValueError N/A N/A N/A N/A exception InvalidParameterValue N/A N/A _ Invalid raw bytes string: '%s' raw_bytes N/A N/A IndexError N/A N/A N/A N/A exception InvalidParameterValue N/A _ Raw bytes string requires two bytes at least. N/A _send_raw N/A N/A driver_info raw_bytes N/A N/A N/A Send raw bytes to the BMC. N/A N/A netfn command data N/A _parse_raw_bytes raw_bytes N/A N/A N/A LOG debug Sending raw bytes %(bytes)s to node %(node_id)s N/A bytes node_id raw_bytes N/A driver_info N/A uuid N/A N/A N/A ipmicmd N/A N/A ipmi_command Command bmc N/A driver_info N/A address userid N/A driver_info N/A username password N/A driver_info N/A password N/A N/A N/A ipmicmd xraw_command netfn command data data N/A N/A N/A N/A pyghmi_exception IpmiException N/A e N/A N/A msg N/A N/A _ IPMI send raw bytes '%(bytes)s' failed for node %(node_id)s with the following error: %(error)s N/A bytes node_id error raw_bytes N/A driver_info N/A uuid e N/A N/A N/A LOG error msg N/A N/A N/A exception IPMIFailure msg N/A NativeIPMIPower N/A N/A base PowerInterface N/A N/A The power driver using native python-ipmi library. get_properties N/A N/A self N/A N/A N/A COMMON_PROPERTIES N/A validate N/A N/A self task N/A N/A N/A Check that node['driver_info'] contains IPMI credentials.

        :param task: a TaskManager instance containing the node to act on.
        :raises: MissingParameterValue when required ipmi credentials
                 are missing.
         N/A N/A _parse_driver_info N/A task node N/A get_power_state N/A N/A self task N/A N/A N/A Get the current power state of the task's node.

        :param task: a TaskManager instance containing the node to act on.
        :returns:  power state POWER_ON, POWER_OFF or ERROR defined in
                 :class:`ironic.common.states`.
        :raises: MissingParameterValue when required ipmi credentials
                 are missing.
        :raises: IPMIFailure when the native ipmi call fails.
         N/A driver_info N/A _parse_driver_info N/A task node N/A N/A _power_status driver_info N/A set_power_state N/A N/A self task pstate N/A N/A N/A Turn the power on or off.

        :param task: a TaskManager instance containing the node to act on.
        :param pstate: a power state that will be set on the task's node.
        :raises: IPMIFailure when the native ipmi call fails.
        :raises: MissingParameterValue when required ipmi credentials
                 are missing.
        :raises: InvalidParameterValue when an invalid power state
                 is specified
        :raises: PowerStateFailure when invalid power state is returned
                 from ipmi.
         N/A driver_info N/A _parse_driver_info N/A task node N/A N/A pstate N/A states POWER_ON N/A N/A N/A N/A driver_utils ensure_next_boot_device task driver_info N/A N/A _power_on driver_info N/A N/A N/A pstate N/A states POWER_OFF N/A N/A N/A _power_off driver_info N/A N/A N/A N/A exception InvalidParameterValue N/A N/A _ set_power_state called with an invalid power state: %s. pstate N/A N/A task_manager require_exclusive_lock reboot N/A N/A self task N/A N/A N/A Cycles the power to the task's node.

        :param task: a TaskManager instance containing the node to act on.
        :raises: IPMIFailure when the native ipmi call fails.
        :raises: MissingParameterValue when required ipmi credentials
                 are missing.
        :raises: PowerStateFailure when invalid power state is returned
                 from ipmi.
         N/A driver_info N/A _parse_driver_info N/A task node N/A N/A N/A driver_utils ensure_next_boot_device task driver_info N/A N/A _reboot driver_info N/A N/A task_manager require_exclusive_lock N/A NativeIPMIManagement N/A N/A base ManagementInterface N/A get_properties N/A N/A self N/A N/A N/A COMMON_PROPERTIES N/A validate N/A N/A self task N/A N/A N/A Check that 'driver_info' contains IPMI credentials.

        Validates whether the 'driver_info' property of the supplied
        task's node contains the required credentials information.

        :param task: a task from TaskManager.
        :raises: MissingParameterValue when required ipmi credentials
                 are missing.

         N/A N/A _parse_driver_info N/A task node N/A get_supported_boot_devices N/A N/A self task N/A N/A N/A Get a list of the supported boot devices.

        :param task: a task from TaskManager.
        :returns: A list with the supported boot devices defined
                  in :mod:`ironic.common.boot_devices`.

         N/A N/A list N/A N/A _BOOT_DEVICES_MAP keys N/A set_boot_device N/A N/A self task device persistent N/A False N/A N/A Set the boot device for the task's node.

        Set the boot device to use on next reboot of the node.

        :param task: a task from TaskManager.
        :param device: the boot device, one of
                       :mod:`ironic.common.boot_devices`.
        :param persistent: Boolean value. True if the boot device will
                           persist to all future boots, False if not.
                           Default: False.
        :raises: InvalidParameterValue if an invalid boot device is specified
                 or required ipmi credentials are missing.
        :raises: MissingParameterValue when required ipmi credentials
                 are missing.
        :raises: IPMIFailure on an error from pyghmi.
         N/A N/A device N/A N/A self get_supported_boot_devices task N/A N/A N/A N/A exception InvalidParameterValue N/A N/A _ Invalid boot device %s specified. device N/A N/A N/A N/A N/A task node driver_info get ipmi_force_boot_device False N/A N/A N/A N/A driver_utils force_persistent_boot task device persistent N/A persistent False N/A driver_info N/A _parse_driver_info N/A task node N/A N/A N/A ipmicmd N/A N/A ipmi_command Command bmc N/A driver_info N/A address userid N/A driver_info N/A username password N/A driver_info N/A password N/A bootdev N/A _BOOT_DEVICES_MAP N/A device N/A N/A N/A ipmicmd set_bootdev bootdev persist persistent N/A N/A N/A N/A pyghmi_exception IpmiException N/A e N/A N/A N/A N/A LOG error N/A _LE IPMI set boot device failed for node %(node_id)s with the following error: %(error)s N/A node_id error N/A driver_info N/A uuid e N/A N/A N/A exception IPMIFailure cmd e N/A N/A task_manager require_exclusive_lock get_boot_device N/A N/A self task N/A N/A N/A Get the current boot device for the task's node.

        Returns the current boot device of the node.

        :param task: a task from TaskManager.
        :raises: MissingParameterValue if required IPMI parameters
            are missing.
        :raises: IPMIFailure on an error from pyghmi.
        :returns: a dictionary containing:

            :boot_device: the boot device, one of
                :mod:`ironic.common.boot_devices` or None if it is unknown.
            :persistent: Whether the boot device will persist to all
                future boots or not, None if it is unknown.

         N/A driver_info N/A N/A task node driver_info N/A driver_internal_info N/A N/A task node driver_internal_info N/A N/A N/A N/A driver_info get ipmi_force_boot_device False N/A N/A driver_internal_info get persistent_boot_device N/A N/A driver_internal_info get is_next_boot_persistent True N/A N/A N/A boot_device persistent N/A driver_internal_info N/A persistent_boot_device True N/A driver_info N/A _parse_driver_info N/A task node N/A response N/A boot_device None N/A N/A N/A ipmicmd N/A N/A ipmi_command Command bmc N/A driver_info N/A address userid N/A driver_info N/A username password N/A driver_info N/A password N/A ret N/A N/A ipmicmd get_bootdev N/A N/A error ret N/A N/A N/A N/A pyghmi_exception IpmiException N/A ret N/A error N/A N/A N/A N/A pyghmi_exception IpmiException N/A e N/A N/A N/A N/A LOG error N/A _LE IPMI get boot device failed for node %(node_id)s with the following error: %(error)s N/A node_id error N/A driver_info N/A uuid e N/A N/A N/A exception IPMIFailure cmd e N/A N/A response N/A persistent N/A N/A ret get persistent N/A bootdev N/A N/A ret get bootdev N/A bootdev N/A N/A N/A response N/A boot_device N/A next N/A dev N/A N/A dev hdev N/A N/A _BOOT_DEVICES_MAP items N/A hdev bootdev None N/A response N/A get_sensors_data N/A N/A self task N/A N/A N/A Get sensors data.

        :param task: a TaskManager instance.
        :raises: FailedToGetSensorData when getting the sensor data fails.
        :raises: MissingParameterValue if required ipmi parameters are missing
        :returns: returns a dict of sensor data group by sensor type.

         N/A driver_info N/A _parse_driver_info N/A task node N/A N/A _get_sensors_data driver_info N/A N/A NativeIPMIShellinaboxConsole N/A N/A base ConsoleInterface N/A N/A A ConsoleInterface that uses pyghmi and shellinabox. get_properties N/A N/A self N/A N/A N/A d N/A N/A COMMON_PROPERTIES copy N/A N/A N/A d update CONSOLE_PROPERTIES N/A d N/A validate N/A N/A self task N/A N/A N/A Validate the Node console info.

        :param task: a TaskManager instance containing the node to act on.
        :raises: MissingParameterValue when required IPMI credentials or
            the IPMI terminal port are missing
        :raises: InvalidParameterValue when the IPMI terminal port is not
                an integer.
         N/A driver_info N/A _parse_driver_info N/A task node N/A N/A N/A driver_info N/A port N/A N/A N/A N/A exception MissingParameterValue N/A _ Missing 'ipmi_terminal_port' parameter in node's driver_info. N/A start_console N/A N/A self task N/A N/A N/A Start a remote console for the node.

        :param task: a TaskManager instance containing the node to act on.
        :raises: MissingParameterValue when required ipmi credentials
                are missing.
        :raises: InvalidParameterValue when the IPMI terminal port is not an
                integer.
        :raises: ConsoleError if unable to start the console process.
         N/A driver_info N/A _parse_driver_info N/A task node N/A path N/A _console_pwfile_path N/A driver_info N/A uuid N/A pw_file N/A N/A console_utils make_persistent_password_file path N/A driver_info N/A password N/A console_cmd N/A /:%(uid)s:%(gid)s:HOME:pyghmicons %(bmc)s %(user)s %(passwd_file)s N/A uid gid bmc user passwd_file N/A N/A os getuid N/A N/A os getgid N/A driver_info N/A address N/A driver_info N/A username pw_file N/A N/A N/A N/A N/A console_utils start_shellinabox_console N/A driver_info N/A uuid N/A driver_info N/A port console_cmd N/A N/A N/A N/A exception ConsoleError N/A N/A N/A N/A excutils save_and_reraise_exception N/A N/A N/A N/A ironic_utils unlink_without_raise path N/A stop_console N/A N/A self task N/A N/A N/A Stop the remote console session for the node.

        :param task: a TaskManager instance containing the node to act on.
        :raises: ConsoleError if unable to stop the console process.
         N/A N/A N/A N/A N/A console_utils stop_shellinabox_console N/A N/A task node uuid N/A N/A password_file N/A _console_pwfile_path N/A N/A task node uuid N/A N/A N/A ironic_utils unlink_without_raise password_file N/A get_console N/A N/A self task N/A N/A N/A Get the type and connection information about the console.

        :param task: a TaskManager instance containing the node to act on.
        :raises: MissingParameterValue when required IPMI credentials or
            the IPMI terminal port are missing
        :raises: InvalidParameterValue when the IPMI terminal port is not
                an integer.
         N/A driver_info N/A _parse_driver_info N/A task node N/A url N/A N/A console_utils get_shellinabox_console_url N/A driver_info N/A port N/A N/A type url shellinabox url N/A N/A VendorPassthru N/A N/A base VendorInterface N/A get_properties N/A N/A self N/A N/A N/A COMMON_PROPERTIES N/A validate N/A N/A self task method N/A kwargs N/A N/A Validate vendor-specific actions.

        :param task: a task from TaskManager.
        :param method: method to be validated
        :param kwargs: info for action.
        :raises: InvalidParameterValue when an invalid parameter value is
                 specified.
        :raises: MissingParameterValue if a required parameter is missing.

         N/A N/A method send_raw N/A N/A raw_bytes N/A N/A kwargs get raw_bytes N/A N/A raw_bytes N/A N/A N/A N/A exception MissingParameterValue N/A _ Parameter raw_bytes (string of bytes) was not specified. N/A N/A _parse_raw_bytes raw_bytes N/A N/A _parse_driver_info N/A task node N/A send_raw N/A N/A self task http_method raw_bytes N/A N/A N/A Send raw bytes to the BMC. Bytes should be a string of bytes.

        :param task: a TaskManager instance.
        :param http_method: the HTTP method used on the request.
        :param raw_bytes: a string of raw bytes to send, e.g. '0x00 0x01'
        :raises: IPMIFailure on an error from native IPMI call.
        :raises: MissingParameterValue if a required parameter is missing.
        :raises: InvalidParameterValue when an invalid value is specified.

         N/A driver_info N/A _parse_driver_info N/A task node N/A N/A _send_raw driver_info raw_bytes N/A N/A N/A base passthru N/A POST N/A task_manager require_exclusive_lock bmc_reset N/A N/A self task http_method warm N/A True N/A N/A Reset BMC via IPMI command.

        :param task: a TaskManager instance.
        :param http_method: the HTTP method used on the request.
        :param warm: boolean parameter to decide on warm or cold reset.
        :raises: IPMIFailure on an error from native IPMI call.
        :raises: MissingParameterValue if a required parameter is missing.
        :raises: InvalidParameterValue when an invalid value is specified

         N/A driver_info N/A _parse_driver_info N/A task node N/A warm N/A N/A strutils bool_from_string warm N/A command N/A warm 0x03 0x02 N/A raw_command N/A 0x06  command N/A N/A _send_raw driver_info raw_command N/A N/A N/A base passthru N/A POST N/A task_manager require_exclusive_lock N/A