Spec-Zone.ru › Ansible

Модуль splunk.es.splunk_data_inputs_monitor – Модуль ресурсов типа «Монитор» для входных данных Splunk

Примечание

Этот модуль входит в коллекцию splunk.es (версия 3.0.0).

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

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

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

Новое в splunk.es 2.1.0

  • Описание
  • Параметры
  • Примеры
  • Значения возврата

Описание

  • Модуль для добавления/модификации или удаления входных данных мониторинга файлов и каталогов в Splunk.
  • Проверено на Splunk Enterprise Server 8.2.3

Примечание

Данный модуль имеет соответствующий плагин действий.

Псевдонимы: data_inputs_monitor

Параметры

Параметр

Комментарии

config

список / элементы=словарь

Настройка мониторинга файлов и каталогов на системе

blacklist

строка

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

check_index

булево

Если установлено в true, значение индекса проверяется на то, является ли оно именем допустимого индекса.

Этот параметр не возвращается Splunk при получении информации об объекте. Поэтому он исключен при проверке идемпотентности

Варианты:

  • false
  • true

check_path

булево

Если установлено в true, проверяется наличие значения имени.

Этот параметр не возвращается Splunk при получении информации об объекте. Поэтому он исключен при проверке идемпотентности

Варианты:

  • false
  • true

crc_salt

строка

Строка, которая изменяет идентификатор отслеживания файлов для файлов в этом входе. Магическое значение <SOURCE> вызывает специальное поведение (см. документацию по администрированию).

disabled

булево

Указывает, отключен ли мониторинг ввода.

Варианты:

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

follow_tail

булево

Если установлено в true, файлы, которые видятся в первый раз, читаются с конца.

Варианты:

  • false
  • true

host

строка

Значение для заполнения поля хоста для событий из этого источника данных.

По умолчанию: "$decideOnStartup"

host_regex

строка

Укажите регулярное выражение для пути к файлу. Если путь к файлу соответствует этому регулярному выражению, захваченное значение используется для заполнения поля хоста для событий из этого источника данных. Регулярное выражение должно иметь одну группу захвата.

host_segment

целое число

Используйте указанный сегмент пути с косой чертой в качестве значения поля хоста.

ignore_older_than

строка

Укажите значение времени. Если время изменения файла, отслеживаемого в мониторинге, выходит за пределы этого скользящего временного интервала, файл больше не отслеживается.

Этот параметр не возвращается Splunk при получении информации об объекте. Поэтому он исключен при проверке идемпотентности

index

строка

Какой индекс событий из этого ввода должен храниться в нем. По умолчанию — default.

По умолчанию: "default"

name

строка / обязательно

Путь к файлу или каталогу для мониторинга в системе.

recursive

булево

Установка этого значения в False предотвращает мониторинг подкаталогов, встречающихся в этом источнике данных.

Варианты:

  • false
  • true

rename_source

строка

Значение для заполнения поля source для событий из этого источника данных. Один и тот же источник не должен использоваться для нескольких источников данных.

Этот параметр не возвращается Splunk при получении информации об объекте. Поэтому он исключен при проверке идемпотентности

sourcetype

строка

Значение для заполнения поля sourcetype для входящих событий.

time_before_close

целое число

Когда ПО Splunk достигает конца файла, который читается, файл остается открытым как минимум на количество секунд, указанное в этом значении. По истечении этого периода файл проверяется снова на наличие дополнительных данных.

Этот параметр не возвращается Splunk при получении информации об объекте. Поэтому он исключен при проверке идемпотентности

whitelist

строка

Укажите регулярное выражение для пути к файлу. Только пути к файлам, соответствующие этому регулярному выражению, индексируются.
END_OF_DOCUMENT_MARKER

running_config

string

Модуль по умолчанию подключается к удалённому устройству и получает текущую конфигурацию running-config, чтобы использовать её в качестве основы для сравнения с содержимым источника. Иногда нежелательно получать текущую конфигурацию running-config для каждой задачи в playbook. Аргумент running_config позволяет реализатору передать конфигурацию в качестве базовой конфигурации для сравнения. Это значение должно быть выводом устройства, полученным после выполнения команды.

state

string

Состояние, в котором должна оставаться конфигурация

Варианты:

  • "merged" ← (по умолчанию)
  • "replaced"
  • "deleted"
  • "gathered"

Примеры

# Using gathered
# --------------

- name: Gather config for specified Data inputs monitors
  splunk.es.splunk_data_inputs_monitor:
    config:
      - name: "/var/log"
      - name: "/var"
    state: gathered

# RUN output:
# -----------

# "gathered": [
#     {
#         "blacklist": "//var/log/[a-z0-9]/gm",
#         "crc_salt": "<SOURCE>",
#         "disabled": false,
#         "host": "$decideOnStartup",
#         "host_regex": "/(test_host)/gm",
#         "host_segment": 3,
#         "index": "default",
#         "name": "/var/log",
#         "recursive": true,
#         "sourcetype": "test_source",
#         "whitelist": "//var/log/[0-9]/gm"
#     }
# ]
#

# Using merged
# ------------

- name: Update Data inputs monitors config
  splunk.es.splunk_data_inputs_monitor:
    config:
      - name: "/var/log"
        blacklist: "//var/log/[a-z]/gm"
        check_index: true
        check_path: true
        crc_salt: <SOURCE>
        rename_source: "test"
        whitelist: "//var/log/[0-9]/gm"
    state: merged

# RUN output:
# -----------

# "after": [
#     {
#         "blacklist": "//var/log/[a-z]/gm",
#         "crc_salt": "<SOURCE>",
#         "disabled": false,
#         "host": "$decideOnStartup",
#         "host_regex": "/(test_host)/gm",
#         "host_segment": 3,
#         "index": "default",
#         "name": "/var/log",
#         "recursive": true,
#         "sourcetype": "test_source",
#         "whitelist": "//var/log/[0-9]/gm"
#     }
# ],
# "before": [
#     {
#         "blacklist": "//var/log/[a-z0-9]/gm",
#         "crc_salt": "<SOURCE>",
#         "disabled": false,
#         "host": "$decideOnStartup",
#         "host_regex": "/(test_host)/gm",
#         "host_segment": 3,
#         "index": "default",
#         "name": "/var/log",
#         "recursive": true,
#         "sourcetype": "test_source",
#         "whitelist": "//var/log/[0-9]/gm"
#     }
# ],

# Using replaced
# --------------

- name: To Replace Data inputs monitors config
  splunk.es.splunk_data_inputs_monitor:
    config:
      - name: "/var/log"
        blacklist: "//var/log/[a-z0-9]/gm"
        crc_salt: <SOURCE>
        index: default
    state: replaced

# RUN output:
# -----------

# "after": [
#     {
#         "blacklist": "//var/log/[a-z0-9]/gm",
#         "crc_salt": "<SOURCE>",
#         "disabled": false,
#         "host": "$decideOnStartup",
#         "index": "default",
#         "name": "/var/log"
#     }
# ],
# "before": [
#     {
#         "blacklist": "//var/log/[a-z0-9]/gm",
#         "crc_salt": "<SOURCE>",
#         "disabled": false,
#         "host": "$decideOnStartup",
#         "host_regex": "/(test_host)/gm",
#         "host_segment": 3,
#         "index": "default",
#         "name": "/var/log",
#         "recursive": true,
#         "sourcetype": "test_source",
#         "whitelist": "//var/log/[0-9]/gm"
#     }
# ],

# Using deleted
# -----------
- name: To Delete Data inpur monitor config
  splunk.es.splunk_data_inputs_monitor:
    config:
      - name: "/var/log"
    state: deleted

# RUN output:
# -----------
#
# "after": [],
# "before": [
#     {
#         "blacklist": "//var/log/[a-z0-9]/gm",
#         "crc_salt": "<SOURCE>",
#         "disabled": false,
#         "host": "$decideOnStartup",
#         "index": "default",
#         "name": "/var/log"
#     }
# ],

Значения возврата

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

Ключ

Описание

after

список / элементы=строка

Конфигурация в виде структурированных данных после завершения модуля.

Возвращается: при изменении

Пример: ["The configuration returned will always be in the same format of the parameters above."]

before

список / элементы=строка

Конфигурация в виде структурированных данных перед вызовом модуля.

Возвращается: всегда

Пример: ["The configuration returned will always be in the same format of the parameters above."]

Авторы

  • Команда Ansible Security Automation (@pranav-bhatt) <https://github.com/ansible-security>

Ссылки на сборку

  • Система отслеживания ошибок
  • Репозиторий (источники)

© 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/splunk/es/splunk_data_inputs_monitor_module.html

Spec-Zone.ru

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