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

Install Ansible via pip

Install with pip install ansible==2.7.17

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- debug:
    var: result
    verbosity: 2

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

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

var:
    description:
    - A variable name to debug.  Mutually exclusive with the 'msg' option.

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
    required: false
    version_added: '2.1'
    version_added_collection: ansible.builtin