From c1493e5267b1d3bf47b1b288846166a1533dd854 Mon Sep 17 00:00:00 2001 From: Brian Coca Date: Mon, 11 Nov 2019 16:04:31 -0500 Subject: [PATCH] really clarify environment (#62531) Co-Authored-By: John R Barker --- docs/docsite/keyword_desc.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docsite/keyword_desc.yml b/docs/docsite/keyword_desc.yml index af78d97fc3f..d0e50cd3c70 100644 --- a/docs/docsite/keyword_desc.yml +++ b/docs/docsite/keyword_desc.yml @@ -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. This cannot affect Ansible itself nor its configuration, it just sets the variables for the code responsible for executing the task. +environment: A dictionary that gets converted into environment vars to be provided for the task upon execution. This can ONLY be used with modules. This isn't supported for any other type of plugins nor 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.