sensu.sensu_go.check_info – Список проверок Sensu

Примечание

Этот плагин входит в сборку sensu.sensu_go (версия 1.8.0).

Для его установки используйте: ansible-galaxy collection install sensu.sensu_go.

Для использования в книге задач укажите: sensu.sensu_go.check_info.

Новое в версии 1.0.0: из sensu.sensu_go

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

Описание

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

Требования

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

python >= 2.7

Параметры

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

См. также

sensu.sensu_go.check: Официальная документация по модулю sensu.sensu_go.check.

Примеры

- 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/sensu/sensu_go/check_info_module.html