diff --git a/docs/_static/ansible/create_ansible_group_of_groups.png b/docs/_static/ansible/create_ansible_group_of_groups.png new file mode 100644 index 0000000000000000000000000000000000000000..9eb635c318b60d75a2ed7309e83a879ce58983f8 Binary files /dev/null and b/docs/_static/ansible/create_ansible_group_of_groups.png differ diff --git a/docs/_static/ansible/create_ansible_network_group.png b/docs/_static/ansible/create_ansible_network_group.png new file mode 100644 index 0000000000000000000000000000000000000000..57ea2ad76e33c22c1787a42988bd6c5188a2951c Binary files /dev/null and b/docs/_static/ansible/create_ansible_network_group.png differ diff --git a/docs/_static/ansible/edit_ansible_group.png b/docs/_static/ansible/edit_ansible_group.png index 7592b1bbd81eca6c22475fc316ae683599f6d2b7..7ffba42a48885db038fb641f2834823fef765031 100644 Binary files a/docs/_static/ansible/edit_ansible_group.png and b/docs/_static/ansible/edit_ansible_group.png differ diff --git a/docs/_static/ansible/edit_ansible_host_vars.png b/docs/_static/ansible/edit_ansible_host_vars.png index 9c0a888d9c4287866e5e5785f5c781ee4a7d2fc7..356616f3a17319d11abc88fd131fd3f3e2335035 100644 Binary files a/docs/_static/ansible/edit_ansible_host_vars.png and b/docs/_static/ansible/edit_ansible_host_vars.png differ diff --git a/docs/_static/ansible/list_ansible_groups.png b/docs/_static/ansible/list_ansible_groups.png index 874e0b39a298a9e2ee2353564093327fce96a951..000a7ea179f372a8f49c63e522140a08bf62d88a 100644 Binary files a/docs/_static/ansible/list_ansible_groups.png and b/docs/_static/ansible/list_ansible_groups.png differ diff --git a/docs/_static/ansible/register_ansible_group.png b/docs/_static/ansible/register_ansible_group.png index 0a62dd1fac60a98216823b6c4a31301b0b990a7f..feebaa60e3b1554a231d1e03fb09a4561f463cbd 100644 Binary files a/docs/_static/ansible/register_ansible_group.png and b/docs/_static/ansible/register_ansible_group.png differ diff --git a/docs/_static/ansible/view_ansible_network_group.png b/docs/_static/ansible/view_ansible_network_group.png new file mode 100644 index 0000000000000000000000000000000000000000..408ff78c68217d35892679b58de61d88ff2dc92d Binary files /dev/null and b/docs/_static/ansible/view_ansible_network_group.png differ diff --git a/docs/network.rst b/docs/network.rst index 458a07c66c8de010b70c009cf21763ef8588123b..f7d18c322790eecb4857c0660157049d241aa230 100644 --- a/docs/network.rst +++ b/docs/network.rst @@ -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