a-c-m
/
community.general
mirror of https://github.com/ansible-collections/community.general.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
community.general/lib/ansible/modules/utilities/logic/debug.py

70 lines
1.9 KiB
Python
Raw Normal View History

Moving snapshot of modules back from core
2014-09-26 01:01:01 +00:00
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright 2012 Dag Wieers <dag@wieers.com>
Remove wildcard imports Made the following changes: * Removed wildcard imports * Replaced long form of GPL header with short form * Removed get_exception usage * Added from __future__ boilerplate * Adjust division operator to // where necessary For the following files: * web_infrastructure modules * system modules * linode, lxc, lxd, atomic, cloudscale, dimensiondata, ovh, packet, profitbricks, pubnub, smartos, softlayer, univention modules * compat dirs (disabled as its used intentionally)
2017-07-28 05:55:24 +00:00
# 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
Moving snapshot of modules back from core
2014-09-26 01:01:01 +00:00
Update metadata to 1.1
2017-08-16 03:16:38 +00:00
ANSIBLE_METADATA = {'metadata_version': '1.1',
New metadata 1.0 (#22587) Changes to the metadata format were approved here: https://github.com/ansible/proposals/issues/54 * Update documentation to the new metadata format * Changes to metadata-tool to account for new metadata * Add GPL license header * Add upgrade subcommand to upgrade metadata version * Change default metadata to the new format * Fix exclusion of non-modules from the metadata report * Fix ansible-doc for new module metadata * Exclude metadata version from ansible-doc output * Fix website docs generation for the new metadata * Update metadata schema in valiate-modules test * Update the metadata in all modules to the new version
2017-03-14 16:07:22 +00:00
'status': ['stableinterface'],
'supported_by': 'core'}
Refreshed metadata for core modules
2016-12-06 10:35:05 +00:00
Moving snapshot of modules back from core
2014-09-26 01:01:01 +00:00
DOCUMENTATION = '''
---
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.
Mutually reference Windows and non-Windows modules (#25482) * Mutually reference Windows and non-Windows modules To make it easier for Windows or non-Windows users to find the relevant module information, we are mutually referencing both variants in their documentation. We are also adding a special note if a module works on both Windows and non-Windows targets. * Mutually reference Windows and non-Windows modules To make it easier for Windows or non-Windows users to find the relevant module information, we are mutually referencing both variants in their documentation. We are also adding a special note if a module works on both Windows and non-Windows targets. * Replace 'look at' with 'use', as requested ci_complete
2017-06-26 15:26:53 +00:00
- This module is also supported for Windows targets.
Moving snapshot of modules back from core
2014-09-26 01:01:01 +00:00
version_added: "0.8"
options:
msg:
description:
- The customized message that is printed. If omitted, prints a generic
message.
required: false
default: "Hello world!"
var:
description:
- A variable name to debug. Mutually exclusive with the 'msg' option.
documented new verbosity option
2016-02-18 15:01:39 +00:00
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
required: False
default: 0
version_added: "2.1"
Mutually reference Windows and non-Windows modules (#25482) * Mutually reference Windows and non-Windows modules To make it easier for Windows or non-Windows users to find the relevant module information, we are mutually referencing both variants in their documentation. We are also adding a special note if a module works on both Windows and non-Windows targets. * Mutually reference Windows and non-Windows modules To make it easier for Windows or non-Windows users to find the relevant module information, we are mutually referencing both variants in their documentation. We are also adding a special note if a module works on both Windows and non-Windows targets. * Replace 'look at' with 'use', as requested ci_complete
2017-06-26 15:26:53 +00:00
notes:
- This module is also supported for Windows targets.
Examples syntax batch4 (#5620) * Change example syntax on authorized_key module * Change example syntax on cron module * Change example syntax on group module * Change example syntax on hostname module * Change example syntax on seboolean module * Change example syntax on selinux module * Change example syntax on service module * Change example syntax on sysctl module * Change example syntax on systemd module * Change example syntax on user module * Change example syntax on debug module * Change example syntax on fail module * Change example syntax on include module * Change example syntax on include_role module * Change example syntax on include_vars module * Change example syntax on pause module * Change example syntax on wait_for module * Change example syntax on apache2_module module * > Change example syntax on django_manage module * Change example syntax on htpasswd module
2016-11-15 20:21:47 +00:00
author:
Proper author info for all remaining modules
2015-06-15 19:53:30 +00:00
- "Dag Wieers (@dagwieers)"
- "Michael DeHaan"
Moving snapshot of modules back from core
2014-09-26 01:01:01 +00:00
'''
EXAMPLES = '''
# Example that prints the loopback address and gateway for each host
Examples syntax batch4 (#5620) * Change example syntax on authorized_key module * Change example syntax on cron module * Change example syntax on group module * Change example syntax on hostname module * Change example syntax on seboolean module * Change example syntax on selinux module * Change example syntax on service module * Change example syntax on sysctl module * Change example syntax on systemd module * Change example syntax on user module * Change example syntax on debug module * Change example syntax on fail module * Change example syntax on include module * Change example syntax on include_role module * Change example syntax on include_vars module * Change example syntax on pause module * Change example syntax on wait_for module * Change example syntax on apache2_module module * > Change example syntax on django_manage module * Change example syntax on htpasswd module
2016-11-15 20:21:47 +00:00
- debug:
msg: "System {{ inventory_hostname }} has uuid {{ ansible_product_uuid }}"
Moving snapshot of modules back from core
2014-09-26 01:01:01 +00:00
Examples syntax batch4 (#5620) * Change example syntax on authorized_key module * Change example syntax on cron module * Change example syntax on group module * Change example syntax on hostname module * Change example syntax on seboolean module * Change example syntax on selinux module * Change example syntax on service module * Change example syntax on sysctl module * Change example syntax on systemd module * Change example syntax on user module * Change example syntax on debug module * Change example syntax on fail module * Change example syntax on include module * Change example syntax on include_role module * Change example syntax on include_vars module * Change example syntax on pause module * Change example syntax on wait_for module * Change example syntax on apache2_module module * > Change example syntax on django_manage module * Change example syntax on htpasswd module
2016-11-15 20:21:47 +00:00
- debug:
msg: "System {{ inventory_hostname }} has gateway {{ ansible_default_ipv4.gateway }}"
Moving snapshot of modules back from core
2014-09-26 01:01:01 +00:00
when: ansible_default_ipv4.gateway is defined
- shell: /usr/bin/uptime
register: result
Examples syntax batch4 (#5620) * Change example syntax on authorized_key module * Change example syntax on cron module * Change example syntax on group module * Change example syntax on hostname module * Change example syntax on seboolean module * Change example syntax on selinux module * Change example syntax on service module * Change example syntax on sysctl module * Change example syntax on systemd module * Change example syntax on user module * Change example syntax on debug module * Change example syntax on fail module * Change example syntax on include module * Change example syntax on include_role module * Change example syntax on include_vars module * Change example syntax on pause module * Change example syntax on wait_for module * Change example syntax on apache2_module module * > Change example syntax on django_manage module * Change example syntax on htpasswd module
2016-11-15 20:21:47 +00:00
- debug:
var: result
verbosity: 2
Moving snapshot of modules back from core
2014-09-26 01:01:01 +00:00
- name: Display all variables/facts known for a host
Examples syntax batch4 (#5620) * Change example syntax on authorized_key module * Change example syntax on cron module * Change example syntax on group module * Change example syntax on hostname module * Change example syntax on seboolean module * Change example syntax on selinux module * Change example syntax on service module * Change example syntax on sysctl module * Change example syntax on systemd module * Change example syntax on user module * Change example syntax on debug module * Change example syntax on fail module * Change example syntax on include module * Change example syntax on include_role module * Change example syntax on include_vars module * Change example syntax on pause module * Change example syntax on wait_for module * Change example syntax on apache2_module module * > Change example syntax on django_manage module * Change example syntax on htpasswd module
2016-11-15 20:21:47 +00:00
debug:
var: hostvars[inventory_hostname]
verbosity: 4
Moving snapshot of modules back from core
2014-09-26 01:01:01 +00:00
'''