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

Примечание

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

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

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

Новое в версии 1.0.0: модуля sensu.sensu_go

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

Обзор

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

Требования

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

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.
filters список / элементы=строка			Список фильтров для использования при определении, следует ли передавать результат проверки этому обработчику.
host строка			Адрес хоста сокета (IP или имя хоста) для подключения. Требуется, если state — `present`.
labels словарь			Дополнительные поля метаданных, к которым можно получить доступ в Sensu в виде пар ключ/значение.
mutator строка			Мутатор для вызова преобразования результата проверки перед его передачей в этот обработчик.
name строка / обязательно			Имя ресурса Sensu. Это имя (в сочетании с пространством имен, где это применимо) однозначно идентифицирует ресурс, с которым взаимодействует Ansible. Если ресурс с выбранным именем уже существует, Ansible-модуль обновит его в соответствии со спецификацией в задаче. См. спецификацию атрибута метаданных name в документации upstream по адресу https://docs.sensu.io/sensu-go/latest/reference/ для получения дополнительной информации о допустимых именах и других ограничениях.
namespace строка		По умолчанию: "default"	Пространство имен RBAC для работы. Если оно не задано, используется значение переменной среды SENSU_NAMESPACE.
port целое число			Порт сокета для подключения. Требуется, если state — `present`.
state строка		Варианты: present ← absent	Целевое состояние объекта Sensu.
timeout целое число			Таймаут для выполнения обработчика.
type строка		Варианты: tcp udp	Тип обработчика. Требуется, если state — `present`.

См. также

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

Примеры

- name: TCP handler
  sensu.sensu_go.socket_handler:
    name: tcp_handler
    type: tcp
    host: 10.0.1.99
    port: 4444

- name: UDP handler
  sensu.sensu_go.socket_handler:
    name: udp_handler
    type: udp
    host: 10.0.1.99
    port: 4444

- name: Delete a handler
  sensu.sensu_go.socket_handler:
    name: udp_handler
    state: absent

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

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

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

Авторы

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