|
13 | 13 | short_description: Manipulate entries in the key/value store of a Consul cluster |
14 | 14 | description: |
15 | 15 | - 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). |
17 | 17 | - If the O(key) represents a prefix then note that when a value is removed, the existing value if any is returned as part |
18 | 18 | of the results. |
19 | 19 | - See http://www.consul.io/docs/agent/http.html#kv for more details. |
|
34 | 34 | state: |
35 | 35 | description: |
36 | 36 | - 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. |
38 | 38 | 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 |
40 | 40 | 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) |
42 | 42 | if the attempt is successful, V(false) otherwise. |
43 | 43 | type: str |
44 | 44 | choices: [absent, acquire, present, release] |
|
0 commit comments