sensu.sensu_go.handler_info – Список обработчиков Sensu

Примечание

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

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

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

В версии 1.0.0: of sensu.sensu_go

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

Описание

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

Требования

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

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	Варианты: нет да ←	Флаг, который управляет проверкой сертификата. Если вы используете самоподписанные сертификаты, можно установить этот параметр в `false`. Используйте этот параметр ТОЛЬКО в сценариях разработки! Если вы используете самоподписанные сертификаты в производстве, см. параметр auth.ca_path. Также можно установить этот параметр через переменную среды SENSU_VERIFY.
name строка			Получить информацию об этом конкретном объекте вместо списка всех объектов.
namespace строка		Значение по умолчанию: "default"	Пространство имен RBAC для работы. Если не указано, используется значение переменной среды SENSU_NAMESPACE.

См. также

sensu.sensu_go.socket_handler: Официальная документация модуля sensu.sensu_go.socket_handler.
sensu.sensu_go.pipe_handler: Официальная документация модуля sensu.sensu_go.pipe_handler.
sensu.sensu_go.handler_set: Официальная документация модуля sensu.sensu_go.handler_set.

Примеры

- name: List all Sensu handlers
  sensu.sensu_go.handler_info:
  register: result

- name: Retrieve info for a specific Sensu handler
  sensu.sensu_go.handler_info:
    name: my-handler
  register: result

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

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

Ключ	Возвращаемое значение	Описание
objects список / элементы=словарь	успех	Список обработчиков Sensu. Пример: [{'metadata': {'name': 'tcp_udp_handler_minimum', 'namespace': 'default'}, 'socket': {'host': '10.0.1.99', 'port': 4444}, 'type': 'tcp'}]

Авторы

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/handler_info_module.html