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

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: sensu.sensu_go.socket_handler.

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

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

Описание

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

Требования

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

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

END_OF_DOCUMENT_MARKER

См. также

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

Примеры

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