The ironic_python_agent.extensions.base Module

class ironic_python_agent.extensions.base.AgentCommandStatus

Bases: object

Mapping of agent command statuses.

class ironic_python_agent.extensions.base.AsyncCommandResult(command_name, command_params, execute_method, agent=None)

Bases: ironic_python_agent.extensions.base.BaseCommandResult

A command that executes asynchronously in the background.

is_done()

Checks to see if command is still RUNNING.

Returns:True if command is done, False if still RUNNING

join(timeout=None)

Block until command has completed, and return result.

Parameters:timeout – float indicating max seconds to wait for command to complete. Defaults to None.

run()

Run a command.

serialize()

Serializes the AsyncCommandResult into a dict.

Returns:dict containing serializable fields in AsyncCommandResult

start()

Begin background execution of command.

class ironic_python_agent.extensions.base.BaseAgentExtension(agent=None)

Bases: object

check_cmd_presence(ext_obj, ext, cmd)

execute(command_name, **kwargs)

class ironic_python_agent.extensions.base.BaseCommandResult(command_name, command_params)

Bases: ironic_python_agent.encoding.SerializableComparable

Base class for command result.

is_done()

Checks to see if command is still RUNNING.

Returns:True if command is done, False if still RUNNING

join()

Returns:result of completed command.

class ironic_python_agent.extensions.base.ExecuteCommandMixin

Bases: object

execute_command(command_name, **kwargs)

Execute an agent command.

get_extension(extension_name)

split_command(command_name)

class ironic_python_agent.extensions.base.SyncCommandResult(command_name, command_params, success, result_or_error)

Bases: ironic_python_agent.extensions.base.BaseCommandResult

A result from a command that executes synchronously.