mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
better sections for module return docs
This commit is contained in:
parent
cc3d131f50
commit
54800ea47c
1 changed files with 9 additions and 5 deletions
|
@ -1,7 +1,5 @@
|
||||||
.. _common_return_values:
|
Return Values
|
||||||
|
-------------
|
||||||
Common Return Values
|
|
||||||
--------------------
|
|
||||||
|
|
||||||
.. contents:: Topics
|
.. contents:: Topics
|
||||||
|
|
||||||
|
@ -13,6 +11,10 @@ This document covers return values common to all modules.
|
||||||
.. note:: Some of these keys might be set by Ansible itself once it processes the module's return information.
|
.. note:: Some of these keys might be set by Ansible itself once it processes the module's return information.
|
||||||
|
|
||||||
|
|
||||||
|
.. _common_return_values:
|
||||||
|
|
||||||
|
Common
|
||||||
|
^^^^^^
|
||||||
|
|
||||||
backup_file
|
backup_file
|
||||||
```````````
|
```````````
|
||||||
|
@ -63,8 +65,10 @@ stdout_lines
|
||||||
When c(stdout) is returned, Ansible always provides a list of strings, each containing one item per line from the original output.
|
When c(stdout) is returned, Ansible always provides a list of strings, each containing one item per line from the original output.
|
||||||
|
|
||||||
|
|
||||||
|
.. _internal_return_values:
|
||||||
|
|
||||||
Internal use
|
Internal use
|
||||||
------------
|
^^^^^^^^^^^^
|
||||||
|
|
||||||
These keys can be added by modules but will be removed from registered variables; they are 'consumed' by Ansible itself.
|
These keys can be added by modules but will be removed from registered variables; they are 'consumed' by Ansible itself.
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue