indexed_items – rewrites lists to return ‘indexed items’

Synopsis

  • use this lookup if you want to loop over an array and also get the numeric index of where you are in the array as you go
  • any list given will be transformed with each resulting element having the it’s previous position in item.0 and its value in item.1

Parameters

Parameter Choices/Defaults Configuration Comments
_terms
- / required
list of items

Examples

- name: indexed loop demo
  debug:
    msg: "at array position {{ item.0 }} there is a value {{ item.1 }}"
  with_indexed_items:
    - "{{ some_list }}"

Return Values

Common return values are documented here, the following are the fields unique to this lookup:

Key Returned Description
_raw
list
list with each item.0 giving you the position and item.1 the value



Status

Authors

Hint

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

Hint

Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/plugins/lookup/indexed_items.html