Skip to content

Commit 5be39ee

Browse files
[PR #11089/c26a4e61 backport][stable-12] consul_kv: adjust RV in docs (#11092)
consul_kv: adjust RV in docs (#11089) (cherry picked from commit c26a4e6) Co-authored-by: Alexei Znamensky <[email protected]>
1 parent 9db4aad commit 5be39ee

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

plugins/modules/consul_kv.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
short_description: Manipulate entries in the key/value store of a Consul cluster
1414
description:
1515
- Allows the retrieval, addition, modification and deletion of key/value entries in a Consul cluster using the agent. The
16-
entire contents of the record, including the indices, flags and session are returned as C(value).
16+
entire contents of the record, including the indices, flags and session are returned as RV(ignore:value).
1717
- If the O(key) represents a prefix then note that when a value is removed, the existing value if any is returned as part
1818
of the results.
1919
- See http://www.consul.io/docs/agent/http.html#kv for more details.
@@ -34,11 +34,11 @@
3434
state:
3535
description:
3636
- The action to take with the supplied key and value. If the state is V(present) and O(value) is set, the key contents
37-
is set to the value supplied and C(changed) is set to V(true) only if the value was different to the current contents.
37+
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.
3838
If the state is V(present) and O(value) is not set, the existing value associated to the key is returned. The state
39-
V(absent) is used to remove the key/value pair, again C(changed) is set to V(true) only if the key actually existed
39+
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
4040
prior to the removal. An attempt can be made to obtain or free the lock associated with a key/value pair with the
41-
states V(acquire) or V(release) respectively. A valid session must be supplied to make the attempt C(changed) is V(true)
41+
states V(acquire) or V(release) respectively. A valid session must be supplied to make the attempt RV(ignore:changed) is V(true)
4242
if the attempt is successful, V(false) otherwise.
4343
type: str
4444
choices: [absent, acquire, present, release]

0 commit comments

Comments
 (0)