etcd3 - Set or delete key value pairs from an etcd3 cluster
New in version 2.5.
Synopsis
- Sets or deletes values in etcd3 cluster using its v3 api.
- Needs python etcd3 lib to work
Requirements
The below requirements are needed on the host that executes this module.
- etcd3
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
host | Default: localhost | the IP address of the cluster |
key required | the key where the information is stored in the cluster | |
port | Default: 2379 | the port number used to connect to the cluster |
state required | the state of the value for the key. can be present or absent | |
value required | the information stored |
Examples
# Store a value "bar" under the key "foo" for a cluster located "http://localhost:2379" - etcd3: key: "foo" value: "baz3" host: "localhost" port: 2379 state: "present"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
key str | always | The key that was queried |
old_value str | always | The previous value in the cluster |
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Author
- Jean-Philippe Evrard (@evrardjp)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/etcd3_module.html