mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-28 21:31:26 -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
72 lines
2.3 KiB
Python
72 lines
2.3 KiB
Python
# -*- mode: python -*-
|
|
|
|
# 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: add_host
|
|
short_description: add a host (and alternatively a group) to the ansible-playbook in-memory inventory
|
|
description:
|
|
- Use variables to create new hosts and groups in inventory for use in later plays of the same playbook.
|
|
Takes variables so you can define the new hosts more fully.
|
|
version_added: "0.9"
|
|
options:
|
|
name:
|
|
aliases: [ 'hostname', 'host' ]
|
|
description:
|
|
- The hostname/ip of the host to add to the inventory, can include a colon and a port number.
|
|
required: true
|
|
groups:
|
|
aliases: [ 'groupname', 'group' ]
|
|
description:
|
|
- The groups to add the hostname to, comma separated.
|
|
required: false
|
|
notes:
|
|
- This module bypasses the play host loop and only runs once for all the hosts in the play, if you need it
|
|
to iterate use a with\_ directive.
|
|
author:
|
|
- "Ansible Core Team"
|
|
- "Seth Vidal"
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
# add host to group 'just_created' with variable foo=42
|
|
- add_host:
|
|
name: "{{ ip_from_ec2 }}"
|
|
groups: just_created
|
|
foo: 42
|
|
|
|
# add a host with a non-standard port local to your machines
|
|
- add_host:
|
|
name: "{{ new_ip }}:{{ new_port }}"
|
|
|
|
# add a host alias that we reach through a tunnel (Ansible <= 1.9)
|
|
- add_host:
|
|
hostname: "{{ new_ip }}"
|
|
ansible_ssh_host: "{{ inventory_hostname }}"
|
|
ansible_ssh_port: "{{ new_port }}"
|
|
|
|
# add a host alias that we reach through a tunnel (Ansible >= 2.0)
|
|
- add_host:
|
|
hostname: "{{ new_ip }}"
|
|
ansible_host: "{{ inventory_hostname }}"
|
|
ansible_port: "{{ new_port }}"
|
|
'''
|