community.general.etcd3 module – Set or delete key value pairs from an etcd3 cluster
Note
This module is part of the community.general collection (version 9.4.0).
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
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.general.etcd3
.
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 |
Comments |
---|---|
The Certificate Authority to use to verify the etcd host. Required if |
|
PEM formatted certificate chain file to be used for SSL client authentication. Required if |
|
PEM formatted file that contains your private key to be used for SSL client authentication. Required if |
|
the IP address of the cluster Default: |
|
the key where the information is stored in the cluster |
|
The password to use for authentication. Required if |
|
the port number used to connect to the cluster Default: |
|
the state of the value for the key. can be present or absent Choices:
|
|
The socket level timeout in seconds. |
|
The etcd user to authenticate with. |
|
the information stored |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Examples
- name: Store a value "bar" under the key "foo" for a cluster located "http://localhost:2379"
community.general.etcd3:
key: "foo"
value: "baz3"
host: "localhost"
port: 2379
state: "present"
- name: Authenticate using user/password combination with a timeout of 10 seconds
community.general.etcd3:
key: "foo"
value: "baz3"
state: "present"
user: "someone"
password: "password123"
timeout: 10
- name: Authenticate using TLS certificates
community.general.etcd3:
key: "foo"
value: "baz3"
state: "present"
ca_cert: "/etc/ssl/certs/CA_CERT.pem"
client_cert: "/etc/ssl/certs/cert.crt"
client_key: "/etc/ssl/private/key.pem"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The key that was queried Returned: always |
|
The previous value in the cluster Returned: always |