ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

Update developing_inventory.rst

Browse source 
Changed a misleading line from returning to printing
This commit is contained in:
nickmisasi13 2016-08-12 08:49:30 -04:00 committed by GitHub
parent 1268f4778d
commit 85dd9aa4ec
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docsite/rst/developing_inventory.rst
View file

@ -8,7 +8,7 @@ As described in :doc:`intro_dynamic_inventory`, ansible can pull inventory infor
How do we write a new one? How do we write a new one?
Simple! We just create a script or program that can return JSON in the right format when fed the proper arguments. Simple! We just create a script or program that can print JSON in the right format when fed the proper arguments.
You can do this in any language. You can do this in any language.
.. _inventory_script_conventions: .. _inventory_script_conventions:
@ -16,7 +16,7 @@ You can do this in any language.
Script Conventions Script Conventions
`````````````````` ``````````````````
When the external node script is called with the single argument ``--list``, the script must return a JSON hash/dictionary of all the groups to be managed. Each group's value should be either a hash/dictionary containing a list of each host/IP, potential child groups, and potential group variables, or simply a list of host/IP addresses, like so:: When the external node script is called with the single argument ``--list``, the script must output a JSON encoded hash/dictionary of all the groups to be managed to stdout. Each group's value should be either a hash/dictionary containing a list of each host/IP, potential child groups, and potential group variables, or simply a list of host/IP addresses, like so::
{ {
"databases" : { "databases" : {
@ -41,9 +41,9 @@ When the external node script is called with the single argument ``--list``, the
Before version 1.0, each group could only have a list of hostnames/IP addresses, like the webservers, marietta, and 5points groups above. Before version 1.0, each group could only have a list of hostnames/IP addresses, like the webservers, marietta, and 5points groups above.
When called with the arguments ``--host <hostname>`` (where <hostname> is a host from above), the script must return either an empty JSON When called with the arguments ``--host <hostname>`` (where <hostname> is a host from above), the script must print either an empty JSON
hash/dictionary, or a hash/dictionary of variables to make available to templates and playbooks. Returning variables is optional, hash/dictionary, or a hash/dictionary of variables to make available to templates and playbooks. Printing variables is optional,
if the script does not wish to do this, returning an empty hash/dictionary is the way to go:: if the script does not wish to do this, printing an empty hash/dictionary is the way to go::
{ {
"favcolor" : "red", "favcolor" : "red",