Documentation

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.

Parameters

Parameter
Choices/Defaults
Comments
key
required
The variables whose values will be used as groups
parents
(added in 2.4)
Default:
all
The list of the parent groups

Notes

Note

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

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 }}

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.

Support

For more information about Red Hat’s support of this module, please refer to this Knowledge Base article

Author

  • Jeroen Hoekx (@jhoekx)

Hint

If you notice any issues in this documentation you can edit this document to improve it.