82 lines
2.5 KiB
Python
82 lines
2.5 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# Copyright: (c) 2012 Dag Wieers <dag@wieers.com>
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
from __future__ import absolute_import, division, print_function
|
|
__metaclass__ = type
|
|
|
|
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
|
'status': ['stableinterface'],
|
|
'supported_by': 'core'}
|
|
|
|
DOCUMENTATION = r'''
|
|
---
|
|
module: debug
|
|
short_description: Print statements during execution
|
|
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.
|
|
version_added: '0.8'
|
|
options:
|
|
msg:
|
|
description:
|
|
- The customized message that is printed. If omitted, prints a generic message.
|
|
type: str
|
|
default: 'Hello world!'
|
|
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:
|
|
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
|
|
default: 0
|
|
version_added: '2.1'
|
|
notes:
|
|
- This module is also supported for Windows targets.
|
|
seealso:
|
|
- module: assert
|
|
- module: fail
|
|
author:
|
|
- Dag Wieers (@dagwieers)
|
|
- Michael DeHaan
|
|
'''
|
|
|
|
EXAMPLES = r'''
|
|
# 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
|
|
|
|
# Example that prints return information from the previous task
|
|
- 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
|
|
|
|
# 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."
|
|
'''
|