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

Примечание

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

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

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

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

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

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

Описание

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

Требования

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

python >= 2.7

Параметры

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

См. также

sensu.sensu_go.socket_handler: Управление обработчиком Sensu TCP/UDP.
sensu.sensu_go.pipe_handler: Управление обработчиком Sensu pipe.
sensu.sensu_go.handler_info: Список обработчиков Sensu.

Примеры

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