модуль splunk.es.splunk_data_inputs_monitor — модуль ресурса Splunk Data Inputs типа Monitor

Примечание

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

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

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

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

Добавлено в splunk.es 2.1.0

Краткое описание
Параметры
Примеры
Возвращаемые значения

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

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

Примечание

Этому модулю соответствует плагин действий.

Параметры

Параметр	Комментарии
config list / elements=dictionary	Настройка мониторинга файлов и каталогов в системе
blacklist string	Задайте регулярное выражение для пути к файлу. Файл, путь к которому соответствует этому регулярному выражению, не индексируется.
check_index boolean	Если задано значение `true`, проверяется, что значение index является именем допустимого индекса. При получении сведений об объекте Splunk не возвращает этот параметр. Поэтому он не учитывается при проверках идемпотентности Варианты: `false` `true`
check_path boolean	Если задано значение `true`, проверяется, что значение name существует. При получении сведений об объекте Splunk не возвращает этот параметр. Поэтому он не учитывается при проверках идемпотентности Варианты: `false` `true`
crc_salt string	Строка, изменяющая идентификатор отслеживания файлов для файлов в этом источнике данных. Специальное значение <SOURCE> запускает особое поведение (см. документацию администратора).
disabled boolean	Указывает, отключен ли мониторинг входных данных. Варианты: `false` ← (по умолчанию) `true`
follow_tail boolean	Если задано значение `true`, впервые обнаруженные файлы считываются с конца. Варианты: `false` `true`
host string	Значение, записываемое в поле host для событий из этого источника данных. По умолчанию: `"$decideOnStartup"`
host_regex string	Задайте регулярное выражение для пути к файлу. Если путь к файлу соответствует этому регулярному выражению, захваченное значение используется для заполнения поля host событий из этого источника данных. Регулярное выражение должно содержать одну группу захвата.
host_segment integer	Используйте указанный сегмент пути к файлу, отделенный косой чертой, в качестве значения поля host.
ignore_older_than string	Задайте временной интервал. Если время изменения отслеживаемого файла выходит за пределы этого скользящего интервала, мониторинг файла прекращается. При получении сведений об объекте Splunk не возвращает этот параметр. Поэтому он не учитывается при проверках идемпотентности
index string	Индекс, в котором следует хранить события из этого источника данных. По умолчанию используется индекс default. По умолчанию: `"default"`
name string / обязательно	Путь к файлу или каталогу в системе, за которым нужно следить.
recursive boolean	Значение False запрещает мониторинг любых подкаталогов, обнаруженных в этом источнике данных. Варианты: `false` `true`
rename_source string	Значение, записываемое в поле source для событий из этого источника данных. Одно и то же значение source не следует использовать для нескольких источников данных. При получении сведений об объекте Splunk не возвращает этот параметр. Поэтому он не учитывается при проверках идемпотентности
sourcetype string	Значение, записываемое в поле sourcetype для входящих событий.
time_before_close integer	Когда программное обеспечение Splunk достигает конца считываемого файла, он остается открытым не менее указанного здесь количества секунд. По истечении этого времени файл повторно проверяется на наличие новых данных. При получении сведений об объекте Splunk не возвращает этот параметр. Поэтому он не учитывается при проверках идемпотентности
whitelist string	Задайте регулярное выражение для пути к файлу. Индексируются только файлы, пути к которым соответствуют этому регулярному выражению.
running_config string	По умолчанию модуль подключается к удаленному устройству и получает текущую конфигурацию running-config, используемую как основу для сравнения с содержимым source. Иногда нежелательно, чтобы задача получала текущую конфигурацию 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 list / elements=string	Конфигурация в виде структурированных данных после выполнения модуля. Возвращается: если были изменения Пример: `["The configuration returned will always be in the same format of the parameters above."]`
before list / elements=string	Конфигурация в виде структурированных данных до вызова модуля. Возвращается: всегда Пример: `["The configuration returned will always be in the same format of the parameters above."]`

Авторы

Команда автоматизации безопасности Ansible (@pranav-bhatt) <https://github.com/ansible-security>

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

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