2012-10-30 21:36:33 +00:00
|
|
|
# -*- mode: python -*-
|
|
|
|
|
|
|
|
|
|
DOCUMENTATION = '''
|
|
|
|
|
---
|
|
|
|
|
module: add_host
|
|
|
|
|
short_description: add a host (and alternatively a group) to the ansible-playbook in-memory inventory
|
|
|
|
|
description:
|
2013-02-17 01:27:38 +00:00
|
|
|
- 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.
|
2013-03-30 19:44:34 +00:00
|
|
|
version_added: "0.9"
|
2012-10-30 21:36:33 +00:00
|
|
|
options:
|
2013-02-18 01:45:37 +00:00
|
|
|
name:
|
2012-10-30 21:36:33 +00:00
|
|
|
description:
|
2013-02-18 01:45:37 +00:00
|
|
|
- The hostname/ip of the host to add to the inventory, can include a colon and a port number.
|
2013-02-17 01:27:38 +00:00
|
|
|
required: true
|
2013-02-17 16:22:50 +00:00
|
|
|
groups:
|
|
|
|
|
aliases: [ 'groupname' ]
|
2012-10-30 21:36:33 +00:00
|
|
|
description:
|
2013-04-21 19:33:51 +00:00
|
|
|
- The groups to add the hostname to, comma separated.
|
2012-10-30 21:36:33 +00:00
|
|
|
required: false
|
|
|
|
|
author: Seth Vidal
|
|
|
|
|
examples:
|
2013-02-17 16:22:50 +00:00
|
|
|
- description: add host to group 'just_created' with variable foo=42
|
2013-04-18 09:36:07 +00:00
|
|
|
code: add_host hostname=${ip_from_ec2} groups=just_created foo=42
|
2013-02-17 16:22:50 +00:00
|
|
|
- description: add a host with a non-standard port local to your machines
|
|
|
|
|
code: add_host hostname='${new_ip}:${new_port}'
|
2013-02-17 16:25:42 +00:00
|
|
|
- description: add a host alias that we reach through a tunnel
|
|
|
|
|
code: add_host hostname=${new_ip} ansible_ssh_host=${inventory_hostname} ansible_ssh_port=${new_port}'
|
2013-02-17 16:22:50 +00:00
|
|
|
'''
|
