Note
This module is part of ansible-base
and included in all Ansible installations. In most cases, you can use the short module name dict 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 1.5: of ansible.builtin
Parameter | Choices/Defaults | Configuration | Comments |
---|---|---|---|
_terms string / required | A list of dictionaries |
vars: users: alice: name: Alice Appleworth telephone: 123-456-7890 bob: name: Bob Bananarama telephone: 987-654-3210 tasks: # with predefined vars - name: Print phone records debug: msg: "User {{ item.key }} is {{ item.value.name }} ({{ item.value.telephone }})" loop: "{{ lookup('dict', users) }}" # with inline dictionary - name: show dictionary debug: msg: "{{item.key}}: {{item.value}}" with_dict: {a: 1, b: 2, c: 3} # Items from loop can be used in when: statements - name: set_fact when alice in key set_fact: alice_exists: true loop: "{{ lookup('dict', users) }}" when: "'alice' in item.key"
Common return values are documented here, the following are the fields unique to this lookup:
Key | Returned | Description |
---|---|---|
_list list / elements=string | success | list of composed dictonaries with key and value |
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/ansible/builtin/dict_lookup.html