cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Merge pull request #782 from bcoca/add_host_docs

Browse source 
added note to add_hosts about loop bypass
This commit is contained in:
Brian Coca 2015-02-25 10:39:04 -05:00
commit 1f5bbd4bf3
1 changed files with 5 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
inventory/add_host.py
View file

@ -5,7 +5,7 @@ DOCUMENTATION = '''
module: add_host module: add_host
short_description: add a host (and alternatively a group) to the ansible-playbook in-memory inventory short_description: add a host (and alternatively a group) to the ansible-playbook in-memory inventory
description: description:
- Use variables to create new hosts and groups in inventory for use in later plays of the same playbook. - 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. Takes variables so you can define the new hosts more fully.
version_added: "0.9" version_added: "0.9"
options: options:
@ -13,12 +13,15 @@ options:
aliases: [ 'hostname', 'host' ] aliases: [ 'hostname', 'host' ]
description: description:
- The hostname/ip of the host to add to the inventory, can include a colon and a port number. - The hostname/ip of the host to add to the inventory, can include a colon and a port number.
required: true required: true
groups: groups:
aliases: [ 'groupname', 'group' ] aliases: [ 'groupname', 'group' ]
description: description:
- The groups to add the hostname to, comma separated. - The groups to add the hostname to, comma separated.
required: false 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: Seth Vidal author: Seth Vidal
''' '''