Модуль community.general.etcd3 — установка или удаление пар «ключ — значение» в кластере etcd3

Примечание

Этот модуль входит в коллекцию community.general (версия 12.6.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.general.etcd3.

Краткое описание
Требования
Параметры
Атрибуты
Примеры
Возвращаемые значения

Краткое описание

Устанавливает или удаляет значения в кластере etcd3 с помощью API v3.
Для работы необходима библиотека python etcd3.

Требования

На узле, выполняющем этот модуль, необходимы следующие компоненты.

etcd3

Параметры

Параметр	Комментарии
ca_cert path	Центр сертификации, используемый для проверки узла etcd. Обязателен, если определены `client_cert` и `client_key`.
client_cert path	Файл цепочки сертификатов в формате PEM для аутентификации SSL-клиента. Обязателен, если определён `client_key`.
client_key path	Файл в формате PEM, содержащий закрытый ключ для аутентификации SSL-клиента. Обязателен, если определён `client_cert`.
host string	IP-адрес кластера. По умолчанию: `"localhost"`
key string / обязательный	Ключ, по которому информация хранится в кластере.
password string	Пароль для аутентификации. Обязателен, если определён `user`.
port integer	Номер порта для подключения к кластеру. По умолчанию: `2379`
state string / обязательный	Состояние значения для ключа. Может быть present или absent. Варианты: `"present"` `"absent"`
timeout integer	Тайм-аут на уровне сокета в секундах.
user string	Пользователь etcd для аутентификации.
value string / обязательный	Сохраняемая информация.

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в режиме `check_mode` и возвращать прогноз изменения состояния, не изменяя целевой узел.
diff_mode	Поддержка: отсутствует	В режиме diff возвращает сведения об изменениях (или о возможных изменениях в `check_mode`).

Примеры

- 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"

Возвращаемые значения

Общие возвращаемые значения описаны здесь. Ниже приведены поля, уникальные для этого модуля:

Ключ	Описание
key string	Запрошенный ключ. Возвращается: всегда
old_value string	Предыдущее значение в кластере. Возвращается: всегда

Авторы

Jean-Philippe Evrard (@evrardjp)
Victor Fauth (@vfauth)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/etcd3_module.html