AnsibleByExample

How to Loop Over a Dictionary in Ansible

Beginner
2024-01-012By Luca Berton

Lesson 1 of 15 in Foundations

Ansible Foundations to Production — full curriculum
  1. 1. Introduction to Ansible and Automation
  2. 2. Installing and Configuring Ansible
  3. 3. Running Ad-Hoc Commands
  4. 4. Writing Your First Playbook
  5. 5. Understanding and Using Modules
  6. 6. Variables and Facts
  7. 7. Conditionals and Loops
  8. 8. Handlers and Idempotency
  9. 9. Structuring Projects with Roles
  10. 10. Inventory Management
  11. 11. Using Ansible Vault for Secrets
  12. 12. Debugging and Troubleshooting
  13. 13. Real-World Automation Examples
  14. 14. Final Project: Deploy a Web Server
  15. 15. Bonus - What's Next with Ansible?
View path overview →

How to Loop Over a Dictionary in Ansible

Introduction

Iterate over dictionaries using dict2items, with_dict, and loop filters in Ansible. This comprehensive guide walks you through every method with practical examples.

Quick Answer

---
- name: Loop Over a Dictionary in Ansible
  hosts: all
  become: true
  tasks:
    - name: Main task
      ansible.builtin.debug:
        msg: "Implementing solution"

Step-by-Step Guide

Step 1: Prerequisites

# Ensure Ansible is installed
ansible --version

# Verify connectivity
ansible all -m ping

Step 2: Implementation

- name: Implement solution
  ansible.builtin.debug:
    msg: "Step 2 complete"
  register: result

Step 3: Verification

- name: Verify result
  ansible.builtin.assert:
    that: result is success
    fail_msg: "Verification failed"

Complete Playbook

---
- name: How to Loop Over a Dictionary in Ansible
  hosts: all
  become: true
  vars:
    target_state: present

  pre_tasks:
    - name: Gather facts
      ansible.builtin.setup:
        gather_subset: min

  tasks:
    - name: Execute main logic
      ansible.builtin.debug:
        msg: "Running on {{ inventory_hostname }}"
      register: main_result

    - name: Report status
      ansible.builtin.debug:
        msg: "Success: {{ main_result }}"

  handlers:
    - name: Restart service
      ansible.builtin.service:
        name: myapp
        state: restarted

Common Mistakes

MistakeWhy It FailsCorrect Approach
Missing becomePermission deniedAdd become: true
Wrong variable scopeUndefined variableUse set_fact or vars
Not idempotentChanges on every runCheck state before acting
No error handlingPlaybook abortsUse block/rescue

Best Practices

  1. Always test first — use --check --diff before applying
  2. Use FQCN — fully qualified collection names prevent conflicts
  3. Handle errors — never let playbooks fail silently
  4. Document your code — future you will thank present you
  5. Version control — commit playbooks to git
  • Ansible Best Practices
  • Ansible Troubleshooting Guide
  • Ansible Performance Optimization

Conclusion

Iterate over dictionaries using dict2items, with_dict, and loop filters in Ansible. Follow the step-by-step guide above, test in check mode, and implement error handling for production reliability.

All Tutorials