ansible.builtin.debug (v2.16.5) — module

Print statements during execution

| "added in version" 0.8 of ansible.builtin"

Authors: Dag Wieers (@dagwieers), Michael DeHaan

This plugin has a corresponding action plugin.

Install Ansible via pip

Install with pip install ansible-core==2.16.5

Description

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.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get uptime information
  ansible.builtin.shell: /usr/bin/uptime
  register: result
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Print return information from the previous task
  ansible.builtin.debug:
    var: result
    verbosity: 2
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Display all variables/facts known for a host
  ansible.builtin.debug:
    var: hostvars[inventory_hostname]
    verbosity: 4
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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."

Inputs

    
msg:
    default: Hello world!
    description:
    - The customized message that is printed. If omitted, prints a generic message.
    type: str

var:
    description:
    - 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.
    type: str

verbosity:
    default: 0
    description:
    - A number that controls when the debug is run, if you set to 3 it will only run debug
      when -vvv or above.
    type: int
    version_added: '2.1'
    version_added_collection: ansible.builtin

See also