ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

clarify environment (#50987)

Browse source 
* clarify environment

* it does work on windoez
This commit is contained in:
Brian Coca 2019-01-23 14:54:05 -05:00 committed by Alicia Cozine
parent 1b09197244
commit 9793b194b9
2 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/docsite/keyword_desc.yml
View file

@ -27,7 +27,7 @@ delay: Number of seconds to delay between retries. This setting is only used in
delegate_facts: Boolean that allows you to apply facts to a delegated host instead of inventory_hostname.
delegate_to: Host to execute task instead of the target (inventory_hostname). Connection vars from the delegated host will also be used for the task.
diff: "Toggle to make tasks return 'diff' information or not."
environment: A dictionary that gets converted into environment vars to be provided for the task upon execution.
environment: A dictionary that gets converted into environment vars to be provided for the task upon execution. This cannot affect Ansible itself nor its configuration, it just sets the variables for the code responsible for executing the task.
fact_path: Set the fact path option for the fact gathering plugin controlled by :term:`gather_facts`.
failed_when: "Conditional expression that overrides the task's normal 'failed' status."
force_handlers: Will force notified handler execution for hosts even if they failed during the play. Will not trigger if the play itself fails.

4
docs/docsite/rst/user_guide/playbooks_environment.rst
View file

@ -9,7 +9,7 @@ It is quite possible that you may need to get package updates through a proxy, o
updates through a proxy and access other packages not through a proxy. Or maybe a script you might wish to
call may also need certain environment variables set to run properly.
Ansible makes it easy for you to configure your environment by using the 'environment' keyword. Here is an example::
Ansible makes it easy for you to configure the remote execution environment by using the 'environment' keyword. Here is an example::
- hosts: all
remote_user: root
@ -114,7 +114,7 @@ You might also want to simply specify the environment for a single task::
PATH: '{{ rbenv_root }}/bin:{{ rbenv_root }}/shims:{{ rbenv_plugins }}/ruby-build/bin:{{ ansible_env.PATH }}'
.. note::
``environment:`` is not currently supported for Windows targets
``environment:`` does not affect Ansible itself, ONLY the context of the specific task action and this does not include Ansible's own configuration settings.
.. seealso::