mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-28 07:31:23 -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,43 +1,46 @@
|
|||
# -*- mode: python -*-
|
||||
#
|
||||
|
||||
# Copyright: (c) 2012, Jeroen Hoekx (@jhoekx)
|
||||
# Copyright: Ansible Team
|
||||
# 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'''
|
||||
---
|
||||
module: group_by
|
||||
short_description: Create Ansible groups based on facts
|
||||
description:
|
||||
- Use facts to create ad-hoc groups that can be used later in a playbook.
|
||||
- This module is also supported for Windows targets.
|
||||
- Use facts to create ad-hoc groups that can be used later in a playbook.
|
||||
- This module is also supported for Windows targets.
|
||||
version_added: "0.9"
|
||||
options:
|
||||
key:
|
||||
description:
|
||||
- The variables whose values will be used as groups
|
||||
- The variables whose values will be used as groups.
|
||||
type: str
|
||||
required: true
|
||||
parents:
|
||||
description:
|
||||
- The list of the parent groups
|
||||
required: false
|
||||
default: "all"
|
||||
- The list of the parent groups.
|
||||
type: list
|
||||
default: all
|
||||
version_added: "2.4"
|
||||
author: "Jeroen Hoekx (@jhoekx)"
|
||||
notes:
|
||||
- Spaces in group names are converted to dashes '-'.
|
||||
- This module is also supported for Windows targets.
|
||||
- Spaces in group names are converted to dashes '-'.
|
||||
- This module is also supported for Windows targets.
|
||||
seealso:
|
||||
- module: add_host
|
||||
author:
|
||||
- Jeroen Hoekx (@jhoekx)
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
EXAMPLES = r'''
|
||||
# Create groups based on the machine architecture
|
||||
- group_by:
|
||||
key: machine_{{ ansible_machine }}
|
||||
|
@ -51,5 +54,4 @@ EXAMPLES = '''
|
|||
key: el{{ ansible_distribution_major_version }}-{{ ansible_architecture }}
|
||||
parents:
|
||||
- el{{ ansible_distribution_major_version }}
|
||||
|
||||
'''
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue