Модуль sensu.sensu_go.check_info – Список проверок Sensu

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: sensu.sensu_go.check_info.

Добавлена в sensu.sensu_go 1.0.0

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

Описание

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

Требования

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

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 строка	Получение информации об этом конкретном объекте вместо перечисления всех объектов.
namespace строка	Пространство имен RBAC для работы. Если не задано, используется значение переменной среды SENSU_NAMESPACE. По умолчанию: `"default"`

См. также

sensu.sensu_go.check: Управление проверками Sensu.

Примеры

- name: List all Sensu checks
  sensu.sensu_go.check_info:
  register: result

- name: Obtain a specific check
  sensu.sensu_go.check_info:
    name: my-check
  register: result

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

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

Ключ	Описание
objects список / элементы=словарь	Список проверок Sensu. Возвращается: успех Пример: `[{"command": "collect.sh", "handlers": ["slack"], "interval": 10, "metadata": {"name": "check_minimum", "namespace": "default"}, "publish": true, "subscriptions": ["system"]}]`

Авторы

Paul Arthur (@flowerysong)
Aljaz Kosir (@aljazkosir)
Miha Plesko (@miha-plesko)
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/check_info_module.html