Note
This plugin is part of the community.general collection (version 3.8.1).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install community.general.
To use it in a playbook, specify: community.general.consul_kv.
value.key represents a prefix then note that when a value is removed, the existing value if any is returned as part of the results.The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| cas string | 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. | |
| flags string | Opaque positive integer value that can be passed when setting a value. | |
| host string | Default: "localhost" | Host of the consul agent. |
| key string / required | The key at which the value should be stored. | |
| port integer | Default: 8500 | The port on which the consul agent is running. |
| recurse boolean |
| If the key represents a prefix, each entry with the prefix can be retrieved by setting this to yes. |
| retrieve boolean |
| If the state is present and value is set, perform a read after setting the value and return this value. |
| scheme string | Default: "http" | The protocol scheme on which the consul agent is running. |
| session string | The session that should be used to acquire or release a lock associated with a key/value pair. | |
| state string |
| The action to take with the supplied key and value. If the state is 'present' and `value` is set, the key contents will be set to the value supplied and `changed` will be set to `true` only if the value was different to the current contents. If the state is 'present' and `value` is not set, the existing value associated to the key will be returned. 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. |
| token string | The token key identifying an ACL rule set that controls access to the key value pair | |
| validate_certs boolean |
| Whether to verify the tls certificate of the consul agent. |
| value string | The value should be associated with the given key, required if state is present. |
# If the key does not exist, the value associated to the "data" property in `retrieved_key` will be `None`
# If the key value is empty string, `retrieved_key["data"]["Value"]` will be `None`
- name: Retrieve a value from the key/value store
community.general.consul_kv:
key: somekey
register: retrieved_key
- name: Add or update the value associated with a key in the key/value store
community.general.consul_kv:
key: somekey
value: somevalue
- name: Remove a key from the store
community.general.consul_kv:
key: somekey
state: absent
- name: Add a node to an arbitrary group via consul inventory (see consul.ini)
community.general.consul_kv:
key: ansible/groups/dc1/somenode
value: top_secret
- name: Register a key/value pair with an associated session
community.general.consul_kv:
key: stg/node/server_birthday
value: 20160509
session: "{{ sessionid }}"
state: acquire
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/consul_kv_module.html