items¶

Collection Note

This module is part of the ansible.builtin collection. To install the collection, use:

ansible-galaxy collection install ansible.builtin

Added in version historical.

Synopsis¶

this lookup returns a list of items given to it, if any of the top level items is also a list it will flatten it, but it will not recurse

Parameters¶

Parameter	Defaults / Choices	Comments
_terms required		list of items

Notes¶

Note

this is the standard lookup used for loops in most examples
check out the 'flattened' lookup for recursive flattening
if you do not want flattening nor any other transformation look at the 'list' lookup.

Examples¶

- name: "loop through list"
  ansible.builtin.debug:
    msg: "An item: {{ item }}"
  with_items:
    - 1
    - 2
    - 3

- name: add several users
  ansible.builtin.user:
    name: "{{ item }}"
    groups: "wheel"
    state: present
  with_items:
     - testuser1
     - testuser2

- name: "loop through list from a variable"
  ansible.builtin.debug:
    msg: "An item: {{ item }}"
  with_items: "{{ somelist }}"

- name: more complex items to add several users
  ansible.builtin.user:
    name: "{{ item.name }}"
    uid: "{{ item.uid }}"
    groups: "{{ item.groups }}"
    state: present
  with_items:
     - { name: testuser1, uid: 1002, groups: "wheel, staff" }
     - { name: testuser2, uid: 1003, groups: staff }

Return Values¶

Key	Data Type	Description	Returned
_raw	list	once flattened list

Authors¶

Michael Dehaan