ansible.plugins.action package¶

class ansible.plugins.action.ActionBase(task, connection, play_context, loader, templar, shared_loader_obj)[source]¶

Bases: object

This class is the base class for all action plugins, and defines code common to all actions. The base class handles the connection by putting/getting files and executing commands based on the current action in use.

run(tmp=None, task_vars=None)[source]¶

Action Plugins should implement this method to perform their tasks. Everything else in this base class is a helper method for the action plugin to do that.

Parameters:	tmp – Temporary directory. Sometimes an action plugin sets up a temporary directory and then calls another module. This parameter allows us to reuse the same directory for both. task_vars – The variables (host vars, group vars, config vars, etc) associated with this task.
Returns:	dictionary of results from the module

Implementors of action modules may find the following variables especially useful:

Module parameters. These are stored in self._task.args

Submodules¶

ansible.plugins.action.add_host module¶

class ansible.plugins.action.add_host.ActionModule(task, connection, play_context, loader, templar, shared_loader_obj)[source]¶

Bases: ansible.plugins.action.ActionBase

Create inventory hosts and groups in the memory inventory

BYPASS_HOST_LOOP = True¶

TRANSFERS_FILES = False¶

run(tmp=None, task_vars=None)[source]¶

ansible.plugins.action.assemble module¶

class ansible.plugins.action.assemble.ActionModule(task, connection, play_context, loader, templar, shared_loader_obj)[source]¶

Bases: ansible.plugins.action.ActionBase

TRANSFERS_FILES = True¶

run(tmp=None, task_vars=None)[source]¶

ansible.plugins.action.assert module¶

class ansible.plugins.action.assert.ActionModule(task, connection, play_context, loader, templar, shared_loader_obj)[source]¶

Bases: ansible.plugins.action.ActionBase

Fail with custom message

TRANSFERS_FILES = False¶

run(tmp=None, task_vars=None)[source]¶

ansible.plugins.action.async module¶

class ansible.plugins.action.async.ActionModule(task, connection, play_context, loader, templar, shared_loader_obj)[source]¶

Bases: ansible.plugins.action.ActionBase

run(tmp=None, task_vars=None)[source]¶: transfer the given module name, plus the async module, then run it

ansible.plugins.action.copy module¶

class ansible.plugins.action.copy.ActionModule(task, connection, play_context, loader, templar, shared_loader_obj)[source]¶

Bases: ansible.plugins.action.ActionBase

run(tmp=None, task_vars=None)[source]¶: handler for file transfer operations

ansible.plugins.action.debug module¶

class ansible.plugins.action.debug.ActionModule(task, connection, play_context, loader, templar, shared_loader_obj)[source]¶

Bases: ansible.plugins.action.ActionBase

Print statements during execution

TRANSFERS_FILES = False¶

VALID_ARGS = set(['msg', 'var', 'verbosity'])¶

run(tmp=None, task_vars=None)[source]¶

ansible.plugins.action.eos_template module¶

class ansible.plugins.action.eos_template.ActionModule(task, connection, play_context, loader, templar, shared_loader_obj)[source]¶: Bases: ansible.plugins.action.net_template.ActionModule, ansible.plugins.action.ActionBase

ansible.plugins.action.fail module¶

class ansible.plugins.action.fail.ActionModule(task, connection, play_context, loader, templar, shared_loader_obj)[source]¶

Bases: ansible.plugins.action.ActionBase

Fail with custom message

TRANSFERS_FILES = False¶

run(tmp=None, task_vars=None)[source]¶

ansible.plugins.action.fetch module¶

class ansible.plugins.action.fetch.ActionModule(task, connection, play_context, loader, templar, shared_loader_obj)[source]¶

Bases: ansible.plugins.action.ActionBase

run(tmp=None, task_vars=None)[source]¶: handler for fetch operations

ansible.plugins.action.group_by module¶

class ansible.plugins.action.group_by.ActionModule(task, connection, play_context, loader, templar, shared_loader_obj)[source]¶

Bases: ansible.plugins.action.ActionBase

Create inventory groups based on variables

TRANSFERS_FILES = False¶

run(tmp=None, task_vars=None)[source]¶

ansible.plugins.action.include_vars module¶

class ansible.plugins.action.include_vars.ActionModule(task, connection, play_context, loader, templar, shared_loader_obj)[source]¶

Bases: ansible.plugins.action.ActionBase

TRANSFERS_FILES = False¶

run(tmp=None, task_vars=None)[source]¶

ansible.plugins.action.ios_template module¶

class ansible.plugins.action.ios_template.ActionModule(task, connection, play_context, loader, templar, shared_loader_obj)[source]¶: Bases: ansible.plugins.action.net_template.ActionModule, ansible.plugins.action.ActionBase

ansible.plugins.action.iosxr_template module¶

class ansible.plugins.action.iosxr_template.ActionModule(task, connection, play_context, loader, templar, shared_loader_obj)[source]¶: Bases: ansible.plugins.action.net_template.ActionModule, ansible.plugins.action.ActionBase

ansible.plugins.action.junos_template module¶

class ansible.plugins.action.junos_template.ActionModule(task, connection, play_context, loader, templar, shared_loader_obj)[source]¶

Bases: ansible.plugins.action.net_template.ActionModule, ansible.plugins.action.ActionBase

run(tmp=None, task_vars=None)[source]¶

ansible.plugins.action.net_template module¶

class ansible.plugins.action.net_template.ActionModule(task, connection, play_context, loader, templar, shared_loader_obj)[source]¶

Bases: ansible.plugins.action.ActionBase

TRANSFERS_FILES = False¶

run(tmp=None, task_vars=None)[source]¶

ansible.plugins.action.normal module¶

class ansible.plugins.action.normal.ActionModule(task, connection, play_context, loader, templar, shared_loader_obj)[source]¶

Bases: ansible.plugins.action.ActionBase

run(tmp=None, task_vars=None)[source]¶

ansible.plugins.action.nxos_template module¶

class ansible.plugins.action.nxos_template.ActionModule(task, connection, play_context, loader, templar, shared_loader_obj)[source]¶: Bases: ansible.plugins.action.net_template.ActionModule, ansible.plugins.action.ActionBase

ansible.plugins.action.ops_template module¶

class ansible.plugins.action.ops_template.ActionModule(task, connection, play_context, loader, templar, shared_loader_obj)[source]¶

Bases: ansible.plugins.action.net_template.ActionModule, ansible.plugins.action.ActionBase

run(tmp=None, task_vars=None)[source]¶

ansible.plugins.action.package module¶

class ansible.plugins.action.package.ActionModule(task, connection, play_context, loader, templar, shared_loader_obj)[source]¶

Bases: ansible.plugins.action.ActionBase

TRANSFERS_FILES = False¶

run(tmp=None, task_vars=None)[source]¶: handler for package operations

ansible.plugins.action.patch module¶

class ansible.plugins.action.patch.ActionModule(task, connection, play_context, loader, templar, shared_loader_obj)[source]¶

Bases: ansible.plugins.action.ActionBase

run(tmp=None, task_vars=None)[source]¶

ansible.plugins.action.pause module¶

exception ansible.plugins.action.pause.AnsibleTimeoutExceeded[source]¶: Bases: exceptions.Exception

ansible.plugins.action.pause.timeout_handler(signum, frame)[source]¶

class ansible.plugins.action.pause.ActionModule(task, connection, play_context, loader, templar, shared_loader_obj)[source]¶

Bases: ansible.plugins.action.ActionBase

pauses execution for a length or time, or until input is received

PAUSE_TYPES = ['seconds', 'minutes', 'prompt', '']¶

BYPASS_HOST_LOOP = True¶

run(tmp=None, task_vars=None)[source]¶: run the pause action module

ansible.plugins.action.raw module¶

class ansible.plugins.action.raw.ActionModule(task, connection, play_context, loader, templar, shared_loader_obj)[source]¶

Bases: ansible.plugins.action.ActionBase

TRANSFERS_FILES = False¶

run(tmp=None, task_vars=None)[source]¶

ansible.plugins.action.script module¶

class ansible.plugins.action.script.ActionModule(task, connection, play_context, loader, templar, shared_loader_obj)[source]¶

Bases: ansible.plugins.action.ActionBase

TRANSFERS_FILES = True¶

run(tmp=None, task_vars=None)[source]¶: handler for file transfer operations

ansible.plugins.action.service module¶

class ansible.plugins.action.service.ActionModule(task, connection, play_context, loader, templar, shared_loader_obj)[source]¶

Bases: ansible.plugins.action.ActionBase

TRANSFERS_FILES = False¶

run(tmp=None, task_vars=None)[source]¶: handler for package operations

ansible.plugins.action.set_fact module¶

class ansible.plugins.action.set_fact.ActionModule(task, connection, play_context, loader, templar, shared_loader_obj)[source]¶

Bases: ansible.plugins.action.ActionBase

TRANSFERS_FILES = False¶

run(tmp=None, task_vars=None)[source]¶

ansible.plugins.action.synchronize module¶

class ansible.plugins.action.synchronize.ActionModule(task, connection, play_context, loader, templar, shared_loader_obj)[source]¶

Bases: ansible.plugins.action.ActionBase

run(tmp=None, task_vars=None)[source]¶: generates params and passes them on to the rsync module

ansible.plugins.action.template module¶

class ansible.plugins.action.template.ActionModule(task, connection, play_context, loader, templar, shared_loader_obj)[source]¶

Bases: ansible.plugins.action.ActionBase

TRANSFERS_FILES = True¶

get_checksum(dest, all_vars, try_directory=False, source=None, tmp=None)[source]¶

run(tmp=None, task_vars=None)[source]¶: handler for template operations

ansible.plugins.action.unarchive module¶

class ansible.plugins.action.unarchive.ActionModule(task, connection, play_context, loader, templar, shared_loader_obj)[source]¶

Bases: ansible.plugins.action.ActionBase

TRANSFERS_FILES = True¶

run(tmp=None, task_vars=None)[source]¶: handler for unarchive operations

ansible.plugins.action.win_copy module¶

class ansible.plugins.action.win_copy.ActionModule(task, connection, play_context, loader, templar, shared_loader_obj)[source]¶: Bases: ansible.plugins.action.copy.ActionModule, ansible.plugins.action.ActionBase

ansible.plugins.action.win_reboot module¶

exception ansible.plugins.action.win_reboot.TimedOutException[source]¶: Bases: exceptions.Exception

class ansible.plugins.action.win_reboot.ActionModule(task, connection, play_context, loader, templar, shared_loader_obj)[source]¶

Bases: ansible.plugins.action.ActionBase

TRANSFERS_FILES = False¶

DEFAULT_SHUTDOWN_TIMEOUT_SEC = 600¶

DEFAULT_REBOOT_TIMEOUT_SEC = 600¶

DEFAULT_CONNECT_TIMEOUT_SEC = 5¶

DEFAULT_PRE_REBOOT_DELAY_SEC = 2¶

DEFAULT_TEST_COMMAND = 'whoami'¶

do_until_success_or_timeout(what, timeout_sec, what_desc, fail_sleep_sec=1)[source]¶

run(tmp=None, task_vars=None)[source]¶

ansible.plugins.action.win_template module¶

class ansible.plugins.action.win_template.ActionModule(task, connection, play_context, loader, templar, shared_loader_obj)[source]¶: Bases: ansible.plugins.action.template.ActionModule, ansible.plugins.action.ActionBase