Documentation

etcd - get info from etcd server

New in version 2.1.

Synopsis

  • Retrieves data from an etcd server

Parameters

Parameter
Choices/Defaults
Configuration
Comments
_terms
required
the list of keys to lookup on the etcd server
url
Default:
http://127.0.0.1:4001
env:ANSIBLE_ETCD_URL
Environment variable with the url for the etcd server
validate_certs
Default:
yes
toggle checking that the ssl ceritificates are valid, you normally only want to turn this off with self-signed certs.
version
Default:
v1
env:ANSIBLE_ETCD_VERSION
Environment variable with the etcd protocol version

Examples

- name: "a value from a locally running etcd"
  debug: msg={{ lookup('etcd', 'foo/bar') }}

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

- name: "since Ansible 2.5 you can set server options inline"
  debug: msg="{{ lookup('etcd', 'foo', version='v2', url='http://192.168.0.27:4001') }}"

Return Values

Common return values are documented here, the following are the fields unique to this lookup:

Key
Returned
Description
_raw
list
list of values associated with input keys



Status

Author

  • Jan-Piet Mens (@jpmens)

Hint

If you notice any issues in this documentation you can edit this document to improve it.