ansible / ansible.builtin / v2.3.3.0-1 / module / consul_kv Manipulate entries in the key/value store of a consul cluster. | "added in version" 2.0 of ansible.builtin" Authors: Steve Gargan (@sgargan) preview | supported by communityansible.builtin.consul_kv (v2.3.3.0-1) — module
pip
Install with pip install ansible==2.3.3.0.post1
Allows the addition, modification and deletion of key/value entries in a consul cluster via the agent. The entire contents of the record, including the indices, flags and session are returned as 'value'.
If the 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.
- name: add or update the value associated with a key in the key/value store consul_kv: key: somekey value: somevalue
- name: remove a key from the store consul_kv: key: somekey state: absent
- name: add a node to an arbitrary group via consul inventory (see consul.ini) consul_kv: key: ansible/groups/dc1/somenode value: 'top_secret'
- name: Register a key/value pair with an associated session consul_kv: key: stg/node/server_birthday value: 20160509 session: "{{ sessionid }}" state: acquire
cas: default: None description: - used when acquiring a lock with a session. If the cas is 0, then Consul will only put the key if it does not already exist. If the cas value is non-zero, then the key is only set if the index matches the ModifyIndex of that key. required: false key: description: - the key at which the value should be stored. required: true host: default: localhost description: - host of the consul agent defaults to localhost required: false port: default: 8500 description: - the port on which the consul agent is running required: false flags: default: None description: - opaque integer value that can be passed when setting a value. required: false state: choices: - present - absent - acquire - release default: present description: - the action to take with the supplied key and value. If the state is 'present', the key contents will be set to the value supplied, 'changed' will be set to true only if the value was different to the current contents. The state 'absent' will remove the key/value pair, again 'changed' will be set to 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 'acquire' or 'release' respectively. a valid session must be supplied to make the attempt changed will be true if the attempt is successful, false otherwise. required: false token: default: None description: - the token key indentifying an ACL rule set that controls access to the key value pair required: false value: description: - the value should be associated with the given key, required if state is present required: true scheme: default: http description: - the protocol scheme on which the consul agent is running required: false version_added: '2.1' version_added_collection: ansible.builtin recurse: default: false description: - if the key represents a prefix, each entry with the prefix can be retrieved by setting this to true. required: false session: default: None description: - the session that should be used to acquire or release a lock associated with a key/value pair required: false validate_certs: default: true description: - whether to verify the tls certificate of the consul agent required: false version_added: '2.1' version_added_collection: ansible.builtin