splunk.es.splunk_data_inputs_monitor 模块 – Splunk Monitor 类型数据输入资源模块

注意

此模块是 splunk.es 集合 (版本 4.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 进行测试

注意

此模块具有相应的 action 插件。

参数

参数	注释
config 列表 / 元素=字典	配置系统上的文件和目录监控
blacklist 字符串	指定文件路径的正则表达式。匹配此正则表达式的文件路径不会被索引。
check_index 布尔值	如果设置为 true，则会检查索引值以确保它是有效索引的名称。 获取对象信息时，Splunk 不会返回此参数。因此，在执行幂等性检查时将其忽略。 选项 false true
check_path 布尔值	如果设置为 true，则会检查 name 值以确保其存在。 获取对象信息时，Splunk 不会返回此参数。因此，在执行幂等性检查时将其忽略。 选项 false true
crc_salt 字符串	修改此输入中文件的跟踪标识的字符串。魔法值 <SOURCE> 会调用特殊行为（参见管理员文档）。
disabled 布尔值	指示输入监控是否已禁用。 选项 false ← (默认) true
follow_tail 布尔值	如果设置为 true，则首次看到的文件将从结尾读取。 选项 false true
host 字符串	为此数据输入的事件填充 host 字段的值。 默认值： "$decideOnStartup"
host_regex 字符串	指定文件路径的正则表达式。如果文件的路径与该正则表达式匹配，则捕获的值将用于为此数据输入的事件填充 host 字段。正则表达式必须具有一个捕获组。
host_segment 整数	使用文件路径的指定斜杠分隔段作为 host 字段值。
ignore_older_than 字符串	指定一个时间值。如果正在监控的文件的修改时间在此滚动时间窗口之外，则不再监控该文件。 获取对象信息时，Splunk 不会返回此参数。因此，在执行幂等性检查时将其忽略。
index 字符串	此输入的事件应存储在哪个索引中。默认为 default。 默认值： "default"
name 字符串 / 必需	要监控的系统上的文件或目录路径。
recursive 布尔值	将其设置为 False 可防止监控在此数据输入中遇到的任何子目录。 选项 false true
rename_source 字符串	为此数据输入的事件填充 source 字段的值。同一 source 不应用于多个数据输入。 获取对象信息时，Splunk 不会返回此参数。因此，在执行幂等性检查时将其忽略。
sourcetype 字符串	用于填充传入事件的 sourcetype 字段的值。
time_before_close 整数	当 Splunk 软件到达正在读取的文件的结尾时，该文件将至少保持打开指定此值中秒数的最小时间。此时间段过后，将再次检查文件是否有更多数据。 获取对象信息时，Splunk 不会返回此参数。因此，在执行幂等性检查时将其忽略。
whitelist 字符串	指定文件路径的正则表达式。仅索引与该正则表达式匹配的文件路径。
running_config 字符串	默认情况下，模块将连接到远程设备并检索当前运行配置，将其用作与源内容进行比较的基准。有时，不希望任务为剧本中的每个任务获取当前运行配置。 *running_config* 参数允许实现者传入用作比较基准配置的配置。此选项的值应该是通过执行命令从设备接收的输出。
state 字符串	配置应保留的状态 选项 "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 安全自动化团队 (@pranav-bhatt) <https://github.com/ansible-security>

资源链接

• 问题追踪器
• 代码仓库 (源代码)