debug¶

Collection Note

This module is part of the ansible.builtin collection. To install the collection, use:

ansible-galaxy collection install ansible.builtin

Added in version 0.8.

Synopsis¶

This module prints statements during execution and can be useful for debugging variables or expressions without necessarily halting the playbook.
Useful for debugging together with the C(when:) directive.
This module is also supported for Windows targets.

Parameters¶

Parameter	Defaults / Choices	Comments
msg str	Default: Hello world!	The customized message that is printed. If omitted, prints a generic message.
var str		A variable name to debug. Mutually exclusive with the O(msg) option. Be aware that this option already runs in Jinja2 context and has an implicit C({{ }}) wrapping, so you should not be using Jinja2 delimiters unless you are looking for double interpolation.
verbosity int		A number that controls when the debug is run, if you set to 3 it will only run debug when -vvv or above. Version Added: 2.1

Examples¶

- name: Print the gateway for each host when defined
  ansible.builtin.debug:
    msg: System {{ inventory_hostname }} has gateway {{ ansible_default_ipv4.gateway }}
  when: ansible_default_ipv4.gateway is defined

- name: Get uptime information
  ansible.builtin.shell: /usr/bin/uptime
  register: result

- name: Print return information from the previous task
  ansible.builtin.debug:
    var: result
    verbosity: 2

- name: Display all variables/facts known for a host
  ansible.builtin.debug:
    var: hostvars[inventory_hostname]
    verbosity: 4

- name: Prints two lines of messages, but only if there is an environment value set
  ansible.builtin.debug:
    msg:
    - "Provisioning based on YOUR_KEY which is: {{ lookup('ansible.builtin.env', 'YOUR_KEY') }}"
    - "These servers were built using the password of '{{ password_used }}'. Please retain this for later use."

Authors¶

Dag Wieers (@dagwieers)
Michael Dehaan