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.

Options

parameter required default choices comments
key
yes
    The variables whose values will be used as 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 }}
    

    Notes

    Note

    Spaces in group names are converted to dashes ‘-‘.

    This is a Core Module

    For more information on what this means please read Core Modules

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