From f1ad6cf479b60dde4f0cf66843104c9521be9e09 Mon Sep 17 00:00:00 2001 From: Brian Coca Date: Fri, 6 Aug 2021 13:23:24 -0400 Subject: [PATCH] added more attributes for existing facilities (#74331) --- lib/ansible/modules/copy.py | 5 +- .../doc_fragments/action_common_attributes.py | 48 +++++++++++++++---- 2 files changed, 43 insertions(+), 10 deletions(-) diff --git a/lib/ansible/modules/copy.py b/lib/ansible/modules/copy.py index dda38400994..80012de6583 100644 --- a/lib/ansible/modules/copy.py +++ b/lib/ansible/modules/copy.py @@ -138,11 +138,12 @@ attributes: action: support: full check_mode: - version_added: '0.9' support: full diff_mode: support: full - version_added: '0.9' + vault: + support: full + version_added: '2.2' ''' EXAMPLES = r''' diff --git a/lib/ansible/plugins/doc_fragments/action_common_attributes.py b/lib/ansible/plugins/doc_fragments/action_common_attributes.py index 31113f2e865..116e881f4db 100644 --- a/lib/ansible/plugins/doc_fragments/action_common_attributes.py +++ b/lib/ansible/plugins/doc_fragments/action_common_attributes.py @@ -14,6 +14,13 @@ attributes: action: description: Indicates this has a corresponding action plugin so some parts of the options can be executed on the controller support: none + action_group: + description: Action is part of action_group(s), for convenient setting of module_defaults. + support: none + membership: [] + api: + description: Instead of executing code on a target, this action interacts with an API on behalf of the target. + support: none async: description: Supports being used with the ``async`` keyword support: full @@ -21,10 +28,11 @@ attributes: description: Is usable alongside become keywords support: full bypass_host_loop: - description: Forces a 'global' task that does not execute per host, cannot be used in non lockstep strategies + description: Forces a 'global' task that does not execute per host, this bypasses per host templating and serial, + throttle and other loop considerations. Also, this action cannot be used in non lockstep strategies support: none check_mode: - description: Can run in check_mode and return changed status prediction + description: Can run in check_mode and return changed status prediction withought modifying target support: none connection: description: Uses the target's configured connection information to execute code on it @@ -35,27 +43,51 @@ attributes: delegation: description: Can be used in conjunction with delegate_to and related keywords support: full - diff: - description: Will return details on what has changed when in diff is enabled + diff_mode: + description: Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode support: none facts: description: Action returns an ``ansible_facts`` dictionary that will update existing host facts support: none + forced_local: + description: The connection itself is passed to the action while the code is still executed on the controller + support: none + forced_action_plugin: + description: This action uses a specific action plugin instead of 'normal' or matching by name + support: none + action_plugin: none + info: + description: This returns general info (not facts) that you might want to register into a variable for later use + support: none loops: - description: both ``loop`` and ``with_`` looping keywords will be honored. + description: both ``loop`` and ``with_`` looping keywords will be honored support: full proprietary: - description: Can only be run against specific proprietary OS, normally a network appliance or similar + description: Designed to only be run against specific proprietary OS(s), normally a network appliance or similar support: none + platforms: [] posix: description: Can be run against most POSIX (and GNU/Linux) OS targets support: full + safe_file_operations: + description: Uses Ansbile's strict file operation functions to ensure proper permissions and avoid data corruption + support: none tags: - description: Tags will determine if this task considered for execution + description: Tags will be evaluated to determine if this task considered for execution support: full + tty: + description: requires direct access to a TTY + support: none + turbo: + description: Uses an Ansible supplied caching mechanism (Turbo!) on the remote for authentication and + 3rd party libraries to speed up recurrent execution + support: none until: - description: Usable inside until/retry loops + description: Usable with until/retry loops support: full + vault: + description: Can automatically decrypt Ansible vaulted files + support: none windows: description: Can be run against Windows OS targets support: none