ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-07-25 22:30:22 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

Expose loop_control.loop_var as ansible_loop_var (#54240)

Browse source 
* Expose the loop_var as ansible_loop_var

* Add docs

* fix assert test

* Indicate version added
This commit is contained in:
Matt Martz 2019-03-26 11:07:54 -05:00 • committed by GitHub
commit 6996926d89
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 26 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

3
docs/docsite/rst/reference_appendices/special_variables.rst
View file

@ -28,6 +28,9 @@ ansible_limit
ansible_loop
A dictionary/map containing extended loop information when enabled via ``loop_control.extended``
ansible_loop_var
The name of the value provided to ``loop_control.loop_var``. Added in ``2.8``
ansible_play_batch
List of active hosts in the current play run limited by the serial, aka 'batch'. Failed/Unreachable hosts are not considered 'active'.

8
docs/docsite/rst/user_guide/playbooks_loops.rst
View file

@ -400,6 +400,14 @@ Variable Description
loop_control:
extended: yes
.. versionadded:: 2.8
As of Ansible 2.8 you can get the name of the value provided to ``loop_control.loop_var`` using the ``ansible_loop_var`` variable
For role authors, writing roles that allow loops, instead of dictating the required ``loop_var`` value, you can gather the value via::
"{{ lookup('vars', ansible_loop_var) }}"
.. _migrating_to_loop:
Migrating from with_X to loop