From 1f06b3ca7d701719b81abb1c8fe258a403b7d8dc Mon Sep 17 00:00:00 2001 From: Divided by Zer0 Date: Fri, 22 Feb 2019 21:57:35 +0100 Subject: [PATCH] ungrouped as a list (#50593) * update the developing_inventory docs to show ungrouped as a dict with a "children" key; avoid [WARNING]: Found both group and host with same name: ungrouped --- .../rst/dev_guide/developing_inventory.rst | 29 +++++++++++-------- 1 file changed, 17 insertions(+), 12 deletions(-) diff --git a/docs/docsite/rst/dev_guide/developing_inventory.rst b/docs/docsite/rst/dev_guide/developing_inventory.rst index b212039cd4..3b62bbed9c 100644 --- a/docs/docsite/rst/dev_guide/developing_inventory.rst +++ b/docs/docsite/rst/dev_guide/developing_inventory.rst @@ -318,19 +318,24 @@ If you intend to replace an existing static inventory file with an inventory scr it must return a JSON object which contains an 'all' group that includes every host in the inventory as a member and every group in the inventory as a child. It should also include an 'ungrouped' group which contains all hosts which are not members of any other group. -A skeleton example of this JSON object is:: +A skeleton example of this JSON object is: - { - "_meta": { - "hostvars": {} - }, - "all": { - "children": [ - "ungrouped" - ] - }, - "ungrouped": {} - } +.. code-block:: json + + { + "_meta": { + "hostvars": {} + }, + "all": { + "children": [ + "ungrouped" + ] + }, + "ungrouped": { + "children": [ + ] + } + } An easy way to see how this should look is using :ref:`ansible-inventory`, which also supports ``--list`` and ``--host`` parameters like an inventory script would.