Ansible Task Looping Directives: Difference between revisions

From NovaOrdis Knowledge Base
Jump to navigation Jump to search
Line 31: Line 31:
==<tt>with_items</tt>==
==<tt>with_items</tt>==
An iterator whose elements can be accessed with <code>item.<element></code>. The content to iterate over may came from in-line declaration or from a variable.
An iterator whose elements can be accessed with <code>item.<element></code>. The content to iterate over may came from in-line declaration or from a variable.
 
===In-line Declaration===
In-line declaration:
<syntaxhighlight lang='yaml'>
<syntaxhighlight lang='yaml'>
- name: debug
- name: debug
Line 42: Line 41:
     - C   
     - C   
</syntaxhighlight>
</syntaxhighlight>
Variable:
===Variable===
<syntaxhighlight lang='yaml'>
<syntaxhighlight lang='yaml'>
- name: Find some files
- name: Find some files

Revision as of 05:18, 5 July 2021

External

Internal

Overview

Loops

loop

Takes a list for the task to iterate over, saving each list element into the item variable (configurable via loop_control)


jdks:
  - corretto8
  - corretto11
...
- name: Multiple items in a loop
  homebrew_cask:
    name: "{{ item }}"
    state: present
  loop: "{{ jdks }}"

An existing variable's field that reference a list can be used:

- name: Debug
  debug:
    var: item.path
    loop: "{{ some_task_result.files }}"

with_items

An iterator whose elements can be accessed with item.<element>. The content to iterate over may came from in-line declaration or from a variable.

In-line Declaration

- name: debug
  debug:
    msg: "{{ item }}"
  with_items:
    - A
    - B
    - C

Variable

- name: Find some files
  find:
    paths: '/some/dir'
    patterns: '*.txt'
  register: find_result
- name: debug
  debug:
    msg: "{{ item }}"
  with_items: "{{ find_result.files | json_query('[*].path') }}"

loop_control

with_<lookup_plugin>

The same as loop but adds the output of any lookup plugin to generate the item list.