Spec-Zone.ru › Ansible

обратный вызов community.general.splunk – отправляет события с результатами задач в HTTP-сборщик событий Splunk

Примечание

Этот плагин обратного вызова входит в коллекцию community.general (версия 12.6.1).

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

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

Чтобы использовать его в плейбуке, укажите: community.general.splunk.

  • Плагин обратного вызова
  • Краткое описание
  • Требования
  • Параметры
  • Примеры

Плагин обратного вызова

Этот плагин является плагином обратного вызова для уведомлений. Он отправляет сведения о запуске плейбука в другие приложения, службы или системы. Дополнительные сведения о плагинах обратного вызова см. в разделе Плагины обратного вызова.

Краткое описание

  • Этот плагин обратного вызова отправляет результаты задач в виде событий в формате JSON в HTTP-сборщик Splunk.
  • Сопутствующее приложение Splunk Monitoring & Diagnostics App доступно здесь: https://splunkbase.splunk.com/app/4023/.
  • Благодарим «Ryan Currah (@ryancurrah)» за исходный код, на основе которого создан этот плагин.

Требования

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

  • Добавить этот плагин обратного вызова в список разрешённых
  • Создать HTTP-сборщик событий в Splunk
  • Указать URL-адрес и токен в ansible.cfg

Параметры

Параметр

Комментарии

authtoken

строка

Токен для аутентификации подключения к HTTP-сборщику Splunk.

Конфигурация:

  • Запись INI:

    [callback_splunk]
    authtoken = VALUE
    
  • Переменная окружения: SPLUNK_AUTHTOKEN

batch

строка

добавлено в community.general 3.3.0

Идентификатор корреляции, который можно использовать в нескольких запусках плейбука.

Конфигурация:

  • Запись INI:

    [callback_splunk]
    batch = VALUE
    
  • Переменная окружения: SPLUNK_BATCH

include_milliseconds

логическое значение

добавлено в community.general 2.0.0

Указывает, нужно ли включать миллисекунды в поле метки времени, создаваемое для события, отправляемого в HTTP-сборщик Splunk.

Варианты:

  • false ← (по умолчанию)
  • true

Конфигурация:

  • Запись INI:

    [callback_splunk]
    include_milliseconds = false
    
  • Переменная окружения: SPLUNK_INCLUDE_MILLISECONDS

url

строка

URL-адрес источника HTTP-сборщика Splunk.

Конфигурация:

  • Запись INI:

    [callback_splunk]
    url = VALUE
    
  • Переменная окружения: SPLUNK_URL

validate_certs

логическое значение

добавлено в community.general 1.0.0

Указывает, нужно ли проверять сертификаты при подключении к HEC. Не рекомендуется устанавливать значение false, если только вы не уверены, что никто не сможет перехватить соединение между этим плагином и HEC: установка значения false допускает атаки типа «человек посередине»!

Варианты:

  • false
  • true ← (по умолчанию)

Конфигурация:

  • Запись INI:

    [callback_splunk]
    validate_certs = true
    
  • Переменная окружения: SPLUNK_VALIDATE_CERTS

Примечание

Для каждого типа записи конфигурации (переменная Ansible, переменная окружения и т. д.) порядок перечисления выше соответствует приоритету от низкого к высокому. Например, переменная, расположенная ниже в списке, переопределяет переменную, расположенную выше. Типы записей также расположены в порядке возрастания приоритета. Например, запись в ansible.cfg (расположенная выше в списке) переопределяется переменной Ansible (расположенной ниже в списке).

Примеры

examples: >-
  To enable, add this to your ansible.cfg file in the defaults block
    [defaults]
    callback_whitelist = community.general.splunk
  Set the environment variable
    export SPLUNK_URL=http://mysplunkinstance.datapaas.io:8088/services/collector/event
    export SPLUNK_AUTHTOKEN=f23blad6-5965-4537-bf69-5b5a545blabla88
  Set the ansible.cfg variable in the callback_splunk block
    [callback_splunk]
    url = http://mysplunkinstance.datapaas.io:8088/services/collector/event
    authtoken = f23blad6-5965-4537-bf69-5b5a545blabla88

Авторы

  • Stuart Hirst

Ссылки на коллекцию

  • Отслеживание проблем
  • Репозиторий (исходный код)
  • Запросить помощь
  • Сообщить об ошибке
  • Запросить новую функцию
  • Связь

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/splunk_callback.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API