ansible_runner.config package

Submodules

ansible_runner.config.runner module

class ansible_runner.config.runner.RunnerConfig(private_data_dir, playbook=None, inventory=None, roles_path=None, limit=None, module=None, module_args=None, verbosity=None, host_pattern=None, binary=None, extravars=None, suppress_output_file=False, suppress_ansible_output=False, process_isolation_path=None, process_isolation_hide_paths=None, process_isolation_show_paths=None, process_isolation_ro_paths=None, tags=None, skip_tags=None, directory_isolation_base_path=None, forks=None, cmdline=None, omit_event_data=False, only_failed_event_data=False, **kwargs)[source]

A Runner configuration object that’s meant to encapsulate the configuration used by the ansible_runner.runner.Runner object to launch and manage the invocation of ansible and ansible-playbook

Typically this object is initialized for you when using the standard run interfaces in ansible_runner.interface but can be used to construct the Runner configuration to be invoked elsewhere. It can also be overridden to provide different functionality to the Runner object.

Example:

>>> rc = RunnerConfig(...)
>>> r = Runner(config=rc)
>>> r.run()