W3cubDocs

/Ansible

group_by - Create Ansible groups based on facts

Synopsis

  • Use facts to create ad-hoc groups that can be used later in a playbook.
  • This module is also supported for Windows targets.

Options

parameter required default choices comments
key
yes
The variables whose values will be used as groups
parents
(added in 2.4)
no all
The list of the parent groups

Examples

# Create groups based on the machine architecture
- group_by:
    key: machine_{{ ansible_machine }}

# Create groups like 'kvm-host'
- group_by:
    key: virt_{{ ansible_virtualization_type }}_{{ ansible_virtualization_role }}

# Create nested groups
- group_by:
    key: el{{ ansible_distribution_major_version }}-{{ ansible_architecture }}
    parents:
      - el{{ ansible_distribution_major_version }}

Notes

Note

  • Spaces in group names are converted to dashes ‘-‘.
  • This module is also supported for Windows targets.

Status

This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.

Maintenance Info

For more information about Red Hat’s this support of this module, please refer to this knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/group_by_module.html