community.general.etcd lookup – get info from an etcd server

Note

This lookup plugin is part of the community.general collection (version 9.4.0).

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.etcd.

Synopsis

  • Retrieves data from an etcd server

Terms

Parameter

Comments

Terms

list / elements=string / required

the list of keys to lookup on the etcd server

Keyword parameters

This describes keyword parameters of the lookup. These are the values key1=value1, key2=value2 and so on in the following examples: lookup('community.general.etcd', key1=value1, key2=value2, ...) and query('community.general.etcd', key1=value1, key2=value2, ...)

Parameter

Comments

url

string

Environment variable with the URL for the etcd server

Default: "http://127.0.0.1:4001"

Configuration:

validate_certs

boolean

toggle checking that the ssl certificates are valid, you normally only want to turn this off with self-signed certs.

Choices:

  • false

  • true ← (default)

version

string

Environment variable with the etcd protocol version

Default: "v1"

Configuration:

Notes

Note

  • When keyword and positional parameters are used together, positional parameters must be listed before keyword parameters: lookup('community.general.etcd', term1, term2, key1=value1, key2=value2) and query('community.general.etcd', term1, term2, key1=value1, key2=value2)

See Also

See also

community.general.etcd3

Set or delete key value pairs from an etcd3 cluster.

community.general.etcd3 lookup plugin

Get key values from etcd3 server.

Examples

- name: "a value from a locally running etcd"
  ansible.builtin.debug:
    msg: "{{ lookup('community.general.etcd', 'foo/bar') }}"

- name: "values from multiple folders on a locally running etcd"
  ansible.builtin.debug:
    msg: "{{ lookup('community.general.etcd', 'foo', 'bar', 'baz') }}"

- name: "you can set server options inline"
  ansible.builtin.debug:
    msg: "{{ lookup('community.general.etcd', 'foo', version='v2', url='http://192.168.0.27:4001') }}"

Return Value

Key

Description

Return value

list / elements=string

List of values associated with input keys.

Returned: success

Authors

  • Jan-Piet Mens (@jpmens)

Hint

Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.