Модуль sensu.sensu_go.cluster_info – Список доступных кластеров Sensu Go
Примечание
Этот модуль входит в коллекцию sensu.sensu_go (версия 1.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install sensu.sensu_go. Для использования этого модуля необходимы дополнительные требования, см. Требования для подробностей.
Чтобы использовать его в плейбуке, укажите: sensu.sensu_go.cluster_info.
Новая версия в sensu.sensu_go 1.9.0
Обзор
- Получение информации о кластерах Sensu Go.
- Для получения дополнительной информации обратитесь к документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/operations/deploy-sensu/cluster-sensu/.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- 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. По умолчанию: |
|
url строка |
Местоположение API бэкенда Sensu. Если он не задан, проверяется значение переменной среды SENSU_URL. По умолчанию: |
|
user строка |
Имя пользователя для подключения к API Sensu. Если он не задан, проверяется значение переменной среды SENSU_USER. Этот параметр игнорируется, если задан параметр auth.api_key. По умолчанию: |
|
verify булево Добавлен в sensu.sensu_go 1.5.0 |
Флаг, управляющий проверкой сертификатов. Если вы используете самозаверяющие сертификаты, можно установить этот параметр в ИСПОЛЬЗУЙТЕ ЭТОТ ПАРАМЕТР ТОЛЬКО В СЦЕНАРИЯХ РАЗРАБОТКИ! Если вы используете самозаверяющие сертификаты в рабочей среде, см. параметр auth.ca_path. Этот параметр также можно задать через переменную среды SENSU_VERIFY. Варианты:
|
name строка | Получение информации об этом конкретном объекте вместо перечисления всех объектов. |
См. также
См. также
- sensu.sensu_go.cluster
-
Управление кластерами Sensu Go.
Примеры
- name: List all Sensu Go clusters
sensu.sensu_go.etcd_replicator_info:
register: result
- name: Retrieve the selected Sensu Go cluster
sensu.sensu_go.etcd_replicator_info:
name: my-cluster
register: result
- name: Do something with result
ansible.builtin.debug:
msg: "{{ result.objects.0.api_urls }}"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие — поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
objects список / элементы=словарь | Список кластеров Sensu Go etcd. Возвращается: успех Пример: |
Ссылки на коллекцию
© 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/cluster_info_module.html
