Модуль sensu.sensu_go.etcd_replicator_info – Список доступных репликаторов Sensu Go etcd

Примечание

Этот модуль входит в коллекцию sensu.sensu_go (версия 1.14.0).

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

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

Чтобы использовать его в книге задач, укажите: sensu.sensu_go.etcd_replicator_info.

Введено в sensu.sensu_go 1.9.0

Описание
Требования
Параметры
См. также
Примеры
Возвращаемые значения

Описание

Получить информацию о репликаторах Sensu Go etcd.
Дополнительную информацию см. в документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/operations/deploy-sensu/etcdreplicators/.

Требования

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

python >= 2.7

Параметры

Параметр	Комментарии
auth словарь	Параметры аутентификации. Каждый из них можно также задать через переменные окружения.
api_key строка добавлен в sensu.sensu_go 1.3.0	Ключ API, который следует использовать при аутентификации. Если он не задан, проверяется значение переменной среды SENSU_API_KEY. Заменяет параметры auth.user и auth.password. Дополнительную информацию о ключе API см. в официальной документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/guides/use-apikey-feature/.
ca_path путь добавлен в sensu.sensu_go 1.5.0	Путь к пакету сертификатов CA, который следует использовать для проверки сертификата бэкенда. Если этот параметр не задан, модуль использует пакет CA, используемый python. Также можно задать этот параметр через переменную среды SENSU_CA_PATH.
password строка	Пароль пользователя Sensu. Если не задан, проверяется значение переменной среды SENSU_PASSWORD. Этот параметр игнорируется, если задан параметр auth.api_key. По умолчанию: `"P@ssw0rd!"`
url строка	Расположение API Sensu бэкенда. Если не задан, проверяется значение переменной среды SENSU_URL. По умолчанию: `"http://localhost:8080"`
user строка	Имя пользователя для подключения к API Sensu. Если не задан, проверяется значение переменной среды SENSU_USER. Этот параметр игнорируется, если задан параметр auth.api_key. По умолчанию: `"admin"`
verify булево добавлен в sensu.sensu_go 1.5.0	Флаг, контролирующий проверку сертификатов. Если вы используете самозаверяемые сертификаты, можно установить этот параметр в `false`. ИСПОЛЬЗУЙТЕ ЭТОТ ПАРАМЕТР ТОЛЬКО В СЦЕНАРИЯХ РАЗРАБОТКИ! При использовании самозаверяемых сертификатов в производственной среде обратитесь к параметру auth.ca_path. Также можно установить этот параметр через переменную среды SENSU_VERIFY. Доступные значения: `false` `true` ← (по умолчанию)
name строка	Получить информацию об этом конкретном объекте вместо перечисления всех объектов.

См. также

sensu.sensu_go.etcd_replicator: Управление репликаторами Sensu Go etcd.

Примеры

- name: List all Sensu Go etcd replicators
  sensu.sensu_go.etcd_replicator_info:
  register: result

- name: Retrieve the selected Sensu Go etcd replicator
  sensu.sensu_go.etcd_replicator_info:
    name: role_replicator
  register: result

- name: Do something with result
  ansible.builtin.debug:
    msg: "{{ result.objects.0.resource }}"

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

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

Ключ	Описание
objects список / элементы=словарь	Список репликаторов Sensu Go etcd. Возвращается: успех Пример: `[{"api_version": "core/v2", "ca_cert": "/etc/sensu/certs/ca.pem", "cert": "/etc/sensu/certs/cert.pem", "insecure": false, "key": "/etc/sensu/certs/key.pem", "metadata": {"created_by": "admin", "name": "cluster-role-replicator"}, "namespace": "", "replication_interval_seconds": 30, "resource": "ClusterRole", "url": "https://sensu.alpha.example.com:2379"}]`

Ключ

Описание

objects

список / элементы=словарь

Список репликаторов Sensu Go etcd.

Возвращается: успех

Пример: [{"api_version": "core/v2", "ca_cert": "/etc/sensu/certs/ca.pem", "cert": "/etc/sensu/certs/cert.pem", "insecure": false, "key": "/etc/sensu/certs/key.pem", "metadata": {"created_by": "admin", "name": "cluster-role-replicator"}, "namespace": "", "replication_interval_seconds": 30, "resource": "ClusterRole", "url": "https://sensu.alpha.example.com:2379"}]

Авторы

Tadej Borovsak (@tadeboro)

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

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/sensu/sensu_go/etcd_replicator_info_module.html