Documentation

debug – Print statements during execution

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 ‘when:’ directive.
  • This module is also supported for Windows targets.

Parameters

Parameter Choices/Defaults Comments
msg
-
Default:
Hello world!
The customized message that is printed. If omitted, prints a generic message.
var
-
A variable name to debug. Mutually exclusive with the 'msg' option.
verbosity
-
added in 2.1
Default:
0
A number that controls when the debug is run, if you set to 3 it will only run debug when -vvv or above

Notes

Note

  • This module is also supported for Windows targets.

Examples

# Example that prints the loopback address and gateway for each host
- debug:
    msg: "System {{ inventory_hostname }} has uuid {{ ansible_product_uuid }}"

- debug:
    msg: "System {{ inventory_hostname }} has gateway {{ ansible_default_ipv4.gateway }}"
  when: ansible_default_ipv4.gateway is defined

- shell: /usr/bin/uptime
  register: result

- debug:
    var: result
    verbosity: 2

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

Status

Red Hat Support

More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.

Authors

  • Dag Wieers (@dagwieers)
  • Michael DeHaan

Hint

If you notice any issues in this documentation you can edit this document to improve it.