ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-10-04 07:24:00 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

[PR #10397/5e2ffb84 backport][stable-11] doc style adjustments: modules [cd]* (#10405)

Browse source 
doc style adjustments: modules [cd]* (#10397)

* doc style adjustments: modules c*

* doc style adjustments: modules d*

* Update plugins/modules/consul_agent_check.py



---------


(cherry picked from commit 5e2ffb845f)

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
patchback[bot] 2025-07-14 07:23:02 +02:00 • committed by GitHub
commit d385c47d0b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
36 changed files with 237 additions and 240 deletions
Download patch file Download diff file Expand all files Collapse all files

20
plugins/modules/consul_kv.py
View file

@ -36,12 +36,12 @@ 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
will be set to the value supplied and C(changed) will be 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 will be returned.
The state V(absent) will remove the key/value pair, again C(changed) will be 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)
will be V(true) if the attempt is successful, V(false) otherwise.
is set to the value supplied and C(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
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)
if the attempt is successful, V(false) otherwise.
type: str
choices: [absent, acquire, present, release]
default: present
@ -73,9 +73,8 @@ options:
type: str
cas:
description:
- Used when acquiring a lock with a session. If the O(cas) is V(0), then Consul will only put the key if it does not
already exist. If the O(cas) value is non-zero, then the key is only set if the index matches the ModifyIndex of that
key.
- Used when acquiring a lock with a session. If the O(cas) is V(0), then Consul only puts the key if it does not already
exist. If the O(cas) value is non-zero, then the key is only set if the index matches the ModifyIndex of that key.
type: str
flags:
description:
@ -103,8 +102,7 @@ options:
default: true
datacenter:
description:
- The name of the datacenter to query. If unspecified, the query will default to the datacenter of the Consul agent
on O(host).
- The name of the datacenter to query. If unspecified, the query defaults to the datacenter of the Consul agent on O(host).
type: str
version_added: 10.0.0
"""