Add 'idempotent' attribute (#833)

* Add 'idempotent' attribute.

* Mention check mode in attribute description.

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>

---------

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
Felix Fontein
2024-12-30 21:11:12 +01:00
committed by GitHub
parent 0d4b16aadb
commit 3f0e292246
34 changed files with 108 additions and 0 deletions

View File

@@ -18,6 +18,20 @@ attributes:
description: Can run in C(check_mode) and return changed status prediction without modifying target.
diff_mode:
description: Will return details on what has changed (or possibly needs changing in C(check_mode)), when in diff mode.
idempotent:
description:
- When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.
- This assumes that the system controlled/queried by the module has not changed in a relevant way.
"""
# Should be used together with the standard fragment
IDEMPOTENT_NOT_MODIFY_STATE = r"""
options: {}
attributes:
idempotent:
support: full
details:
- This action does not modify state.
"""
# Should be used together with the standard fragment

View File

@@ -19,6 +19,11 @@ description:
attributes:
diff_mode:
support: full
idempotent:
support: partial
details:
- If relative timestamps are used and O(ignore_timestamps=false), the module is not idempotent.
- The option O(force=true) generally disables idempotency.
requirements:
- cryptography >= 1.6 (if using V(selfsigned) or V(ownca) provider)
options:

View File

@@ -18,6 +18,8 @@ description:
attributes:
diff_mode:
support: full
idempotent:
support: full
requirements:
- cryptography >= 1.3
options:

View File

@@ -20,6 +20,10 @@ description:
attributes:
diff_mode:
support: full
idempotent:
support: partial
details:
- The option O(regenerate=always) generally disables idempotency.
requirements:
- cryptography >= 1.2.3 (older versions might work as well)
options:

View File

@@ -17,6 +17,8 @@ requirements:
attributes:
diff_mode:
support: none
idempotent:
support: full
options:
src_path:
description: