=========

 Ansible

=========

.. contents::

   :local:

Debugging Ansible

=================

Pass ``-vvv`` to Ansible utilities::

  ansible -vvv ...

  ansible-playbook -vvv ...

To debug connection use ``-vvvv``::

  ansible -vvvv ...

To debug Python modules set ``ANSIBLE_KEEP_REMOTE_FILES`` to ``1`` (it causes Ansible to leave the

exact copy of the Python scripts it executed on the target machine)::

  ANSIBLE_KEEP_REMOTE_FILES=1  ansible ...

There is ``debugger`` keyword that triggers debugger, see `Ansible Debugger

<https://docs.ansible.com/ansible/latest/user_guide/playbooks_debugger.html>`_

To activate debugger on task::

  - name: Execute a command

    command: false

    debugger: on_failed

To activate debugger in ``ansible.cfg``::

  [defaults]

  enable_task_debugger = True

To activate debugger via env var::

  ANSIBLE_ENABLE_TASK_DEBUGGER=True ansible-playbook -i hosts site.yml

Use ``ansible-lint``::

  $ sudo apt install ansible-lint

  $ ansible-lint site.yml

https://docs.ansible.com/ansible/latest/network/user_guide/network_debug_troubleshooting.html

  Network Debug and Troubleshooting Guide.

https://stackoverflow.com/questions/42417079/how-to-debug-ansible-issues

  How to debug Ansible issues?

Bash completion

===============

https://github.com/ansible/ansible/issues/36397

  Provide bash-completion script for ansible commands.

https://docs.ansible.com/ansible/devel/installation_guide/intro_installation.html#shell-completion

  As of Ansible 2.9 shell completion of the ansible command line utilities is available and provided

  through an optional dependency called argcomplete.

Ansible language

================

https://docs.ansible.com/ansible/latest/user_guide/playbooks_module_defaults.html

  Module defaults.

https://docs.ansible.com/ansible/latest/reference_appendices/playbooks_keywords.html

  Reserved keywords.

https://docs.ansible.com/ansible/latest/user_guide/intro_patterns.html

  Patterns: targeting hosts and groups.

https://docs.ansible.com/ansible/latest/network/getting_started/first_inventory.html

  Using aliases & groups for hosts.

Search path

===========

Files, templates, variables definitions are looked in ``files``, ``templates``, ``vars`` role / play

directories first, then in the base directory for role / play.

https://docs.ansible.com/ansible/latest/user_guide/playbook_pathing.html

  Search paths in Ansible.

Templates

=========

https://docs.ansible.com/ansible/latest/user_guide/playbooks_templating.html

  Templating (Jinja2).