mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
5c69918d53
Migrated all examples: in DOCUMENTATION=''' string to standalone EXAMPLES=''' string Added deprecation warning to moduledev.rst and remove deprecated example from it Fixed up a few typos and uppercased some acronyms. add consistency to how EXAMPLES are formatted
33 lines
1.1 KiB
Python
33 lines
1.1 KiB
Python
# -*- mode: python -*-
|
|
|
|
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:
|
|
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' ]
|
|
description:
|
|
- The groups to add the hostname to, comma separated.
|
|
required: false
|
|
author: Seth Vidal
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
# add host to group 'just_created' with variable foo=42
|
|
- add_host: hostname=${ip_from_ec2} groups=just_created foo=42
|
|
|
|
# add a host with a non-standard port local to your machines
|
|
- add_host: hostname='${new_ip}:${new_port}'
|
|
|
|
# add a host alias that we reach through a tunnel
|
|
- add_host: hostname=${new_ip} ansible_ssh_host=${inventory_hostname} ansible_ssh_port=${new_port}'
|
|
'''
|