mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-25 20:01:25 -07:00
eb1214baad
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
77 lines
2.3 KiB
Python
77 lines
2.3 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# Copyright 2012 Dag Wieers <dag@wieers.com>
|
|
#
|
|
# This file is part of Ansible
|
|
#
|
|
# Ansible is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# Ansible is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
ANSIBLE_METADATA = {'metadata_version': '1.0',
|
|
'status': ['stableinterface'],
|
|
'supported_by': 'core'}
|
|
|
|
|
|
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.
|
|
|
|
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.
|
|
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"
|
|
author:
|
|
- "Dag Wieers (@dagwieers)"
|
|
- "Michael DeHaan"
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
# 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
|
|
|
|
- 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
|
|
'''
|