Skip to content
Snippets Groups Projects
Commit 39217a8a authored by Benjamin Bertrand's avatar Benjamin Bertrand
Browse files

Update Ansible groups documentation

parent aba0bd30
No related branches found
No related tags found
No related merge requests found
docs/_static/ansible/create_ansible_group_of_groups.png

363 KiB

docs/_static/ansible/create_ansible_network_group.png

365 KiB

docs/_static/ansible/edit_ansible_group.png

366 KiB | W: | H:

docs/_static/ansible/edit_ansible_group.png

408 KiB | W: | H:

docs/_static/ansible/edit_ansible_group.png
docs/_static/ansible/edit_ansible_group.png
docs/_static/ansible/edit_ansible_group.png
docs/_static/ansible/edit_ansible_group.png
  • 2-up
  • Swipe
  • Onion skin
docs/_static/ansible/edit_ansible_host_vars.png

411 KiB | W: | H:

docs/_static/ansible/edit_ansible_host_vars.png

418 KiB | W: | H:

docs/_static/ansible/edit_ansible_host_vars.png
docs/_static/ansible/edit_ansible_host_vars.png
docs/_static/ansible/edit_ansible_host_vars.png
docs/_static/ansible/edit_ansible_host_vars.png
  • 2-up
  • Swipe
  • Onion skin
docs/_static/ansible/list_ansible_groups.png

343 KiB | W: | H:

docs/_static/ansible/list_ansible_groups.png

435 KiB | W: | H:

docs/_static/ansible/list_ansible_groups.png
docs/_static/ansible/list_ansible_groups.png
docs/_static/ansible/list_ansible_groups.png
docs/_static/ansible/list_ansible_groups.png
  • 2-up
  • Swipe
  • Onion skin
docs/_static/ansible/register_ansible_group.png

354 KiB | W: | H:

docs/_static/ansible/register_ansible_group.png

400 KiB | W: | H:

docs/_static/ansible/register_ansible_group.png
docs/_static/ansible/register_ansible_group.png
docs/_static/ansible/register_ansible_group.png
docs/_static/ansible/register_ansible_group.png
  • 2-up
  • Swipe
  • Onion skin
docs/_static/ansible/view_ansible_network_group.png

438 KiB

......@@ -86,6 +86,9 @@ The main *Ansible groups* page lists all the groups with their variables and ass
.. image:: _static/ansible/list_ansible_groups.png
Static groups
~~~~~~~~~~~~~
New group can be added from the *Register Ansible group* page:
.. image:: _static/ansible/register_ansible_group.png
......@@ -99,3 +102,26 @@ Hosts can be associated to a group from the *Edit Ansible group* page or from th
Variables should be entered in YAML format. `CodeMirror <http://codemirror.net>`_ is used to provide a text editor with syntax higlighting
in the register/edit pages.
Refer to Ansible documentation for more information about `YAML Syntax <https://docs.ansible.com/ansible/latest/reference_appendices/YAMLSyntax.html>`_.
Dynamic groups
~~~~~~~~~~~~~~
By default, groups are *static*. It is possible to create dynamic groups based on the *Network scope*, *Network* or *device type*.
When creating a dynamic group, the name of the group should match the name of the type you target.
Let's take an example. To create a group based on the **ICSVMs** Vlan name, create a group named **icsvms** (a group name is always in lower-case)
and choose the type **NETWORK**. Note that you can't select any hosts.
.. image:: _static/ansible/create_ansible_network_group.png
Click submit. You can see the list of hosts part of the ICSVMs network:
.. image:: _static/ansible/view_ansible_network_group.png
Groups of groups
~~~~~~~~~~~~~~~~
You can also create `groups of groups <https://docs.ansible.com/ansible/latest/user_guide/intro_inventory.html#groups-of-groups-and-group-variables>`_.
To do so, just select the group names in the *Children* field when registering a new group:
.. image:: _static/ansible/create_ansible_group_of_groups.png
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment