clarify registered vs facts (#45432)

* clarify registered vs facts

fixes #45411

* wordsmithing
pull/49331/head
Brian Coca 6 years ago committed by Sandra McCann
parent d1816d4908
commit 8461321a6a

@ -790,12 +790,10 @@ directory (ansible will attempt to create the directory if one does not exist).
Registering variables Registering variables
===================== =====================
Another major use of variables is running a command and registering the result of that command as a variable. Results will vary from module to module. Use of ``-v`` when executing playbooks will show possible values for the results. Another major use of variables is running a command and registering the result of that command as a variable. When you execute a task and save the return value in a variable for use in later tasks, you create a registered variable. There are more examples of this in the
The value of a task being executed in ansible can be saved in a variable and used later. See some examples of this in the
:ref:`playbooks_conditionals` chapter. :ref:`playbooks_conditionals` chapter.
While it's mentioned elsewhere in that document too, here's a quick syntax example:: For example::
- hosts: web_servers - hosts: web_servers
@ -808,10 +806,11 @@ While it's mentioned elsewhere in that document too, here's a quick syntax examp
- shell: /usr/bin/bar - shell: /usr/bin/bar
when: foo_result.rc == 5 when: foo_result.rc == 5
Registered variables are valid on the host the remainder of the playbook run, which is the same as the lifetime of "facts" Results will vary from module to module. Each module's documentation includes a ``RETURN`` section describing that module's return values. To see the values for a particular task, run your playbook with ``-v``.
in Ansible. Effectively registered variables are just like facts.
Registered variables are similar to facts, with a few key differences. Like facts, registered variables are host-level variables. However, registered variables are only stored in memory. (Ansible facts are backed by whatever cache plugin you have configured.) Registered variables are only valid on the host for the rest of the current playbook run. Finally, registered variables and facts have different :ref:`precedence levels <ansible_variable_precedence>`.
When using ``register`` with a loop, the data structure placed in the variable during the loop will contain a ``results`` attribute, that is a list of all responses from the module. For a more in-depth example of how this works, see the :ref:`playbooks_loops` section on using register with a loop. When you register a variable in a task with a loop, the registered variable contains a value for each item in the loop. The data structure placed in the variable during the loop will contain a ``results`` attribute, that is a list of all responses from the module. For a more in-depth example of how this works, see the :ref:`playbooks_loops` section on using register with a loop.
.. note:: If a task fails or is skipped, the variable still is registered with a failure or skipped status, the only way to avoid registering a variable is using tags. .. note:: If a task fails or is skipped, the variable still is registered with a failure or skipped status, the only way to avoid registering a variable is using tags.

Loading…
Cancel
Save