shkatara.demo_collection.debug (1.0.0) — module

Install collection

Install with ansible-galaxy collection install shkatara.demo_collection:==1.0.0

Add to requirements.yml

  collections:
    - name: shkatara.demo_collection
      version: 1.0.0

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.

# Example that prints return information from the previous task
- 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

Scanned by Steampunk Spotter

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

# Example that prints two lines of messages, but only if there is an environment value set
- debug:
    msg:
    - "Provisioning based on YOUR_KEY which is: {{ lookup('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 C(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: shkatara.demo_collection

See also

• assert
• fail