mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-24 11:21:25 -07:00
075ead8fb0
- better variable precedence management - universal plugin option handling - also updated comments for future directions - leverage fragments for plugins - removed fact namespacing - added 'firendly name' field - updated missing descriptions - removed some unused yaml entries, updated others to reflect possible future - documented more plugins - allow reading docs using alias - short licenses - corrected args for 'all plugins' - fixed -a option for ansible-doc - updated vars plugins to allow docs - fixed 'gathering' - only set options IF connection - added path list and renamed pathspec mostly the diff is , vs : as separator - readded removed config entries that were deprecated but had no message ... and deprecated again - now deprecated entries give warning when set
43 lines
1.4 KiB
Python
43 lines
1.4 KiB
Python
#
|
|
# (c) 2016, Sumit Kumar <sumit4@netapp.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/>.
|
|
|
|
|
|
class ModuleDocFragment(object):
|
|
|
|
DOCUMENTATION = """
|
|
options:
|
|
strict:
|
|
description:
|
|
- If true make invalid entries a fatal error, otherwise skip and continue
|
|
- Since it is possible to use facts in the expressions they might not always be available
|
|
and we ignore those errors by default.
|
|
type: boolean
|
|
default: False
|
|
compose:
|
|
description: create vars from jinja2 expressions
|
|
type: dictionary
|
|
default: {}
|
|
groups:
|
|
description: add hosts to group based on Jinja2 conditionals
|
|
type: dictionary
|
|
default: {}
|
|
keyed_groups:
|
|
description: add hosts to group based on the values of a variable
|
|
type: list
|
|
default: []
|
|
"""
|