From 008de3e245f1b19e68e9605d8d728b979d4cc8ba Mon Sep 17 00:00:00 2001 From: "patchback[bot]" <45432694+patchback[bot]@users.noreply.github.com> Date: Tue, 11 Nov 2025 06:09:15 +0100 Subject: [PATCH] [PR #11089/c26a4e61 backport][stable-11] consul_kv: adjust RV in docs (#11091) consul_kv: adjust RV in docs (#11089) (cherry picked from commit c26a4e613b7151ab79e22a08bc5b03d8a68c24a7) Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com> --- plugins/modules/consul_kv.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/plugins/modules/consul_kv.py b/plugins/modules/consul_kv.py index d0dd003e34..534e0a4617 100644 --- a/plugins/modules/consul_kv.py +++ b/plugins/modules/consul_kv.py @@ -15,7 +15,7 @@ module: consul_kv short_description: Manipulate entries in the key/value store of a Consul cluster description: - Allows the retrieval, addition, modification and deletion of key/value entries in a Consul cluster using the agent. The - entire contents of the record, including the indices, flags and session are returned as C(value). + entire contents of the record, including the indices, flags and session are returned as RV(ignore:value). - If the O(key) represents a prefix then note that when a value is removed, the existing value if any is returned as part of the results. - See http://www.consul.io/docs/agent/http.html#kv for more details. @@ -36,11 +36,11 @@ options: state: description: - The action to take with the supplied key and value. If the state is V(present) and O(value) is set, the key contents - is set to the value supplied and C(changed) is set to V(true) only if the value was different to the current contents. + is set to the value supplied and RV(ignore:changed) is set to V(true) only if the value was different to the current contents. If the state is V(present) and O(value) is not set, the existing value associated to the key is returned. The state - V(absent) is used to remove the key/value pair, again C(changed) is set to V(true) only if the key actually existed + V(absent) is used to remove the key/value pair, again RV(ignore:changed) is set to V(true) only if the key actually existed prior to the removal. An attempt can be made to obtain or free the lock associated with a key/value pair with the - states V(acquire) or V(release) respectively. A valid session must be supplied to make the attempt C(changed) is V(true) + states V(acquire) or V(release) respectively. A valid session must be supplied to make the attempt RV(ignore:changed) is V(true) if the attempt is successful, V(false) otherwise. type: str choices: [absent, acquire, present, release]