ansible.builtin.group_by - Create Ansible groups based on facts

This module is part of ansible-base and included in all Ansible installations. In most cases, you can use the short module name group_by even without specifying the collections: keyword. Despite that, we recommend you use the FQCN for easy linking to the module documentation and to avoid conflicting with other collections that may have the same module name.

New in version 0.9: of ansible.builtin

• Synopsis
• Parameters
• Notes
• See Also
• Examples

Synopsis

• Use facts to create ad-hoc groups that can be used later in a playbook.

• This module is also supported for Windows targets.

This module has a corresponding action plugin.

Parameters

Parameter	Choices/Defaults	Comments
key string / required		The variables whose values will be used as groups.
parents list / elements=string	Default: "all"	The list of the parent groups.

Notes

• Spaces in group names are converted to dashes '-'.

• This module is also supported for Windows targets.

See Also

See also

ansible.builtin.add_host

The official documentation on the ansible.builtin.add_host module.

Examples

- name: Create groups based on the machine architecture
  group_by:
    key: machine_{{ ansible_machine }}- name: Create groups like 'virt_kvm_host'
  group_by:
    key: virt_{{ ansible_virtualization_type }}_{{ ansible_virtualization_role }}- name: Create nested groups
  group_by:
    key: el{{ ansible_distribution_major_version }}-{{ ansible_architecture }}    parents:
      - el{{ ansible_distribution_major_version }}# Add all active hosts to a static group
- group_by:
    key: done

Authors

• Jeroen Hoekx (@jhoekx)

---