Documentation

indexed_items - rewrites lists to return ‘indexed items’

New in version 1.3.

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 postiion and item.1 the value



Status

Author

Hint

If you notice any issues in this documentation you can edit this document <https://github.com/ansible/ansible/edit/devel/lib/ansible/plugins/lookup/indexed_items.py_ to improve it.