sensu.sensu_go.handler_set – Управление набором обработчиков Sensu

Примечание

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

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

Для использования в плейбуке укажите: sensu.sensu_go.handler_set.

Новый в версии 1.0.0: of sensu.sensu_go

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

Описание

Создание, обновление или удаление набора обработчиков Sensu.
Для получения дополнительной информации обратитесь к документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/reference/handlers/#handler-sets.

Требования

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

python >= 2.7

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
annotations словарь			Пользовательские метаданные с меньшими ограничениями, как пары «ключ-значение». Они сохраняются Sensu, но не доступны как токены или идентификаторы, и предназначены в основном для использования с внешними инструментами.
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.
handlers список / элементы=строка			Список обработчиков событий Sensu (имена), которые следует использовать для событий, использующих набор обработчиков. Требуется, если state равен `present`.
labels словарь			Пользовательские поля метаданных, к которым можно получить доступ в Sensu в виде пар «ключ-значение».
name строка / обязательный			Имя ресурса Sensu. Это имя (в сочетании с пространством имен, если применимо) однозначно идентифицирует ресурс, на котором Ansible выполняет операции. Если ресурс с выбранным именем уже существует, модуль Ansible обновит его в соответствии со спецификацией в задаче. Обратитесь к спецификации атрибута метаданных name в документации upstream по https://docs.sensu.io/sensu-go/latest/reference/ для получения более подробной информации о допустимых именах и других ограничениях.
namespace строка		По умолчанию: "default"	Пространство имен RBAC, в котором нужно работать. Если не задан, используется значение переменной среды SENSU_NAMESPACE.
state строка		Варианты: present ← absent	Целевое состояние объекта Sensu.

См. также

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

Примеры

- name: Create a handler set
  sensu.sensu_go.handler_set:
    name: notify_all_the_things
    handlers:
      - slack
      - tcp_handler
      - udp_handler

- name: Delete a handler set
  sensu.sensu_go.handler_set:
    name: notify_all_the_things
    state: absent

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

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

Ключ	Возвращаемое значение	Описание
object словарь	успех	Объект, представляющий набор обработчиков Sensu. Пример: {'handlers': ['slack'], 'metadata': {'name': 'tcp_udp_handler_minimum', 'namespace': 'default'}, 'type': 'set'}

Авторы

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_set_module.html