mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-26 12:21:26 -07:00
utilities: Clean up parameter types and add seealso (#53063)
* utilities: Clean up parameter types and add seealso * Add inventory modules * Add more references, clarify with-loops
This commit is contained in:
parent
77a03af394
commit
f47191674e
21 changed files with 468 additions and 321 deletions
|
@ -1,37 +1,38 @@
|
|||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# Copyright: Ansible Project
|
||||
# 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 = '''
|
||||
DOCUMENTATION = r'''
|
||||
---
|
||||
author: Ansible Core Team (@ansible)
|
||||
module: include_tasks
|
||||
short_description: Dynamically include a task list
|
||||
description:
|
||||
- Includes a file with a list of tasks to be executed in the current playbook.
|
||||
version_added: "2.4"
|
||||
version_added: '2.4'
|
||||
options:
|
||||
file:
|
||||
description:
|
||||
- The name of the imported file is specified directly without any other option.
|
||||
- Unlike M(import_tasks), most keywords, including loop, with_items, and conditionals, apply to this statement.
|
||||
- The do until loop is not supported on M(include_tasks).
|
||||
type: str
|
||||
version_added: '2.7'
|
||||
apply:
|
||||
description:
|
||||
- Accepts a hash of task keywords (e.g. C(tags), C(become)) that will be applied to the tasks within the include.
|
||||
type: str
|
||||
version_added: '2.7'
|
||||
free-form:
|
||||
description:
|
||||
|
@ -40,9 +41,16 @@ options:
|
|||
of specifying an argument of I(file).
|
||||
notes:
|
||||
- This is a core feature of the Ansible, rather than a module, and cannot be overridden like a module.
|
||||
seealso:
|
||||
- module: import_playbook
|
||||
- module: import_role
|
||||
- module: import_tasks
|
||||
- module: include_role
|
||||
- ref: playbooks_reuse_includes
|
||||
description: More information related to including and importing playbooks, roles and tasks.
|
||||
'''
|
||||
|
||||
EXAMPLES = """
|
||||
EXAMPLES = r'''
|
||||
- hosts: all
|
||||
tasks:
|
||||
- debug:
|
||||
|
@ -80,8 +88,8 @@ EXAMPLES = """
|
|||
- install
|
||||
tags:
|
||||
- always
|
||||
"""
|
||||
'''
|
||||
|
||||
RETURN = """
|
||||
RETURN = r'''
|
||||
# This module does not return anything except tasks to execute.
|
||||
"""
|
||||
'''
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue