модуль splunk.es.splunk_data_inputs_network — управление сетевыми источниками данных Splunk типа TCP или UDP

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install splunk.es.

Чтобы использовать её в плейбуке, укажите: splunk.es.splunk_data_inputs_network.

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

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

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

Модуль позволяет добавлять, обновлять и удалять источники данных TCP и UDP в Splunk.

Примечание

Этому модулю соответствует модуль действий.

Параметры

Параметр	Комментарии
config список / элементы=словарь	Управление данными протокольных входных потоков и их предварительный просмотр.
cipher_suite строка	Задаёт список допустимых шифров для использования в SSL. Доступно только при наличии на устройстве конфигурации TCP SSL.
connection_host строка	Задаёт имя узла удалённого сервера, отправляющего данные. `ip` задаёт в качестве имени узла IP-адрес удалённого сервера, отправляющего данные. `dns` задаёт в качестве имени узла обратную DNS-запись IP-адреса удалённого сервера, отправляющего данные. `none` оставляет имя узла таким, как указано в inputs.conf; обычно это имя хоста системы Splunk. Варианты: `"ip"` `"dns"` `"none"`
datatype строка	`cooked` позволяет получать сведения о подготовленных входных данных TCP и создавать новые контейнеры для управления подготовленными данными. `raw` позволяет управлять необработанными входными данными TCP от форвардеров. `splunktcptoken` позволяет управлять доступом получателей с помощью токенов. `ssl` предоставляет доступ к конфигурации SSL сервера Splunk. Этот параметр не поддерживает состояния deleted и replaced. Варианты: `"cooked"` `"raw"` `"splunktcptoken"` `"ssl"`
disabled логический	Указывает, отключён ли входной поток. Варианты: `false` `true`
host строка	Хост, с которого индексатор получает данные.
index строка	Индекс по умолчанию для хранения созданных событий.
name строка / обязательный	Порт входного потока, принимающий необработанные данные.
no_appending_timestamp логический	Если задано значение true, программное обеспечение Splunk не добавляет временную метку и имя хоста в начало входящих событий. Применяется только для конфигурации входных данных UDP. Варианты: `false` `true`
no_priority_stripping логический	Если задано значение true, программное обеспечение Splunk не удаляет поле приоритета из входящих событий syslog. Применяется только для конфигурации входных данных UDP. Варианты: `false` `true`
password строка	Пароль сертификата сервера, если он задан. Только для конфигурации TCP SSL.
protocol строка / обязательный	Выберите, какими входными потоками управлять: TCP или UDP Варианты: `"tcp"` `"udp"`
queue строка	Указывает, куда обработчик входных данных должен помещать считываемые события. По умолчанию используется parsingQueue. Задайте для queue значение parsingQueue, чтобы применить к данным props.conf и другие правила синтаксического анализа. Дополнительные сведения о props.conf и правилах для временных меток и разбиения на строки см. в props.conf и онлайн-документации «Мониторинг файлов и каталогов с помощью inputs.conf». Задайте для queue значение indexQueue, чтобы отправлять данные непосредственно в индекс. Применимо только для API «/tcp/raw» и «/udp» Варианты: `"parsingQueue"` `"indexQueue"`
raw_tcp_done_timeout целое число	Задаёт время ожидания в секундах перед добавлением ключа Done. Если соединение через указанный параметром name порт остаётся бездействующим в течение заданного числа секунд после получения данных, добавляется ключ Done. Это означает, что последнее событие получено полностью. Только для конфигурации входных данных TCP raw.
require_client_cert строка	Определяет, должен ли клиент проходить аутентификацию. Только для конфигурации TCP SSL.
restrict_to_host строка	Ограничивает этот входной поток приёмом данных только от указанного здесь хоста.
root_ca строка	Список центров сертификации (файл корневого сертификата). Только для конфигурации TCP SSL.
server_cert строка	Полный путь к сертификату сервера. Только для конфигурации TCP SSL.
source строка	Задаёт ключ/поле source для событий из этого входного потока. По умолчанию используется путь к файлу входных данных. Задаёт исходное значение ключа source. Ключ используется при синтаксическом анализе и индексировании, в частности для задания поля source во время индексирования. Это также поле source, используемое во время поиска. Для удобства к выбранной строке добавляется префикс «source::». Обратите внимание: переопределять ключ source обычно не рекомендуется. Как правило, уровень входных данных предоставляет более точную строку, помогающую анализировать и исследовать проблемы, поскольку в ней точно указывается файл, из которого получены данные. Прежде чем переопределять это значение, рассмотрите возможность использования типов источников, тегов и шаблонов поиска.
sourcetype строка	Задаёт тип источника для событий из этого входного потока. К строке <string> автоматически добавляется префикс «sourcetype=». По умолчанию используется audittrail (если signedaudit=true) или fschange (если signedaudit=false).
ssl логический	Включает или отключает SSL для потока данных Варианты: `false` `true`
token строка	Значение токена для SplunkTcpToken. Если значение не задано, токен создаётся автоматически.
running_config строка	По умолчанию модуль подключается к удалённому устройству и получает текущую running-config, которая используется как основа для сравнения с содержимым source. В некоторых случаях нежелательно, чтобы задача получала текущую running-config при каждом запуске задачи в плейбуке. Аргумент running_config позволяет передать конфигурацию, которая будет использоваться в качестве базовой для сравнения. Значением этого параметра должен быть вывод, полученный от устройства при выполнении команды.
state строка	Состояние, в котором должна остаться конфигурация Варианты: `"merged"` ← (по умолчанию) `"replaced"` `"deleted"` `"gathered"`

Примеры

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

- name: Gathering information about TCP Cooked Inputs
  splunk.es.splunk_data_inputs_network:
    config:
      - protocol: tcp
        datatype: cooked
    state: gathered

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

# "gathered": [
#     {
#         "connection_host": "ip",
#         "disabled": true,
#         "host": "$decideOnStartup",
#         "index": "default",
#         "name": "8101"
#     },
#     {
#         "disabled": false,
#         "host": "$decideOnStartup",
#         "index": "default",
#         "name": "9997"
#     },
#     {
#         "connection_host": "ip",
#         "disabled": true,
#         "host": "$decideOnStartup",
#         "index": "default",
#         "name": "default:8101",
#         "restrict_to_host": "default"
#     }
# ]


- name: Gathering information about TCP Cooked Inputs by Name
  splunk.es.splunk_data_inputs_network:
    config:
      - protocol: tcp
        datatype: cooked
        name: 9997
    state: gathered

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

# "gathered": [
#     {
#         "datatype": "cooked",
#         "disabled": false,
#         "host": "$decideOnStartup",
#         "name": "9997",
#         "protocol": "tcp"
#     }
# ]


- name: Gathering information about TCP Raw Inputs
  splunk.es.splunk_data_inputs_network:
    config:
      - protocol: tcp
        datatype: raw
    state: gathered

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

# "gathered": [
#     {
#         "connection_host": "ip",
#         "disabled": false,
#         "host": "$decideOnStartup",
#         "index": "default",
#         "name": "8099",
#         "queue": "parsingQueue",
#         "raw_tcp_done_timeout": 10
#     },
#     {
#         "connection_host": "ip",
#         "disabled": true,
#         "host": "$decideOnStartup",
#         "index": "default",
#         "name": "default:8100",
#         "queue": "parsingQueue",
#         "raw_tcp_done_timeout": 10,
#         "restrict_to_host": "default",
#         "source": "test_source",
#         "sourcetype": "test_source_type"
#     }
# ]

- name: Gathering information about TCP Raw inputs by Name
  splunk.es.splunk_data_inputs_network:
    config:
      - protocol: tcp
        datatype: raw
        name: 8099
    state: gathered

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

# "gathered": [
#     {
#         "connection_host": "ip",
#         "datatype": "raw",
#         "disabled": false,
#         "host": "$decideOnStartup",
#         "index": "default",
#         "name": "8099",
#         "protocol": "tcp",
#         "queue": "parsingQueue",
#         "raw_tcp_done_timeout": 10
#     }
# ]

- name: Gathering information about TCP SSL configuration
  splunk.es.splunk_data_inputs_network:
    config:
      - protocol: tcp
        datatype: ssl
    state: gathered

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

# "gathered": [
#     {
#         "cipher_suite": <cipher-suites>,
#         "disabled": true,
#         "host": "$decideOnStartup",
#         "index": "default",
#         "name": "test_host"
#     }
# ]

- name: Gathering information about TCP SplunkTcpTokens
  splunk.es.splunk_data_inputs_network:
    config:
      - protocol: tcp
        datatype: splunktcptoken
    state: gathered

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

# "gathered": [
#     {
#         "disabled": false,
#         "host": "$decideOnStartup",
#         "index": "default",
#         "name": "splunktcptoken://test_token1",
#         "token": <token1>
#     },
#     {
#         "disabled": false,
#         "host": "$decideOnStartup",
#         "index": "default",
#         "name": "splunktcptoken://test_token2",
#         "token": <token2>
#     }
# ]

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

- name: To add the TCP raw config
  splunk.es.splunk_data_inputs_network:
    config:
      - protocol: tcp
        datatype: raw
        name: 8100
        connection_host: ip
        disabled: true
        raw_tcp_done_timeout: 9
        restrict_to_host: default
        queue: parsingQueue
        source: test_source
        sourcetype: test_source_type
    state: merged

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

# "after": [
#     {
#         "connection_host": "ip",
#         "datatype": "raw",
#         "disabled": true,
#         "host": "$decideOnStartup",
#         "index": "default",
#         "name": "default:8100",
#         "protocol": "tcp",
#         "queue": "parsingQueue",
#         "raw_tcp_done_timeout": 9,
#         "restrict_to_host": "default",
#         "source": "test_source",
#         "sourcetype": "test_source_type"
#     }
# ],
# "before": [
#     {
#         "connection_host": "ip",
#         "datatype": "raw",
#         "disabled": true,
#         "host": "$decideOnStartup",
#         "index": "default",
#         "name": "default:8100",
#         "protocol": "tcp",
#         "queue": "parsingQueue",
#         "raw_tcp_done_timeout": 10,
#         "restrict_to_host": "default",
#         "source": "test_source",
#         "sourcetype": "test_source_type"
#     }
# ]

- name: To add the TCP cooked config
  splunk.es.splunk_data_inputs_network:
    config:
      - protocol: tcp
        datatype: cooked
        name: 8101
        connection_host: ip
        disabled: false
        restrict_to_host: default
    state: merged

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

# "after": [
#     {
#         "connection_host": "ip",
#         "datatype": "cooked",
#         "disabled": false,
#         "host": "$decideOnStartup",
#         "name": "default:8101",
#         "protocol": "tcp",
#         "restrict_to_host": "default"
#     }
# ],
# "before": [
#     {
#         "connection_host": "ip",
#         "datatype": "cooked",
#         "disabled": true,
#         "host": "$decideOnStartup",
#         "name": "default:8101",
#         "protocol": "tcp",
#         "restrict_to_host": "default"
#     }
# ],

- name: To add the Splunk TCP token
  splunk.es.splunk_data_inputs_network:
    config:
      - protocol: tcp
        datatype: splunktcptoken
        name: test_token
    state: merged

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

# "after": [
#     {
#         "datatype": "splunktcptoken",
#         "name": "splunktcptoken://test_token",
#         "protocol": "tcp",
#         "token": <token>
#     }
# ],
# "before": [],

- name: To add the Splunk SSL
  splunk.es.splunk_data_inputs_network:
    config:
      - protocol: tcp
        datatype: ssl
        name: test_host
        root_ca: {root CA directory}
        server_cert: {server cretificate directory}
    state: merged

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

# "after": [
#     {
#         "cipher_suite": <cipher suite>,
#         "datatype": "ssl",
#         "disabled": true,
#         "host": "$decideOnStartup",
#         "index": "default",
#         "name": "test_host",
#         "protocol": "tcp"
#     }
# ],
# "before": []


# Using deleted
# -------------

- name: To Delete TCP Raw
  splunk.es.splunk_data_inputs_network:
    config:
      - protocol: tcp
        datatype: raw
        name: default:8100
    state: deleted

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

# "after": [],
# "before": [
#     {
#         "connection_host": "ip",
#         "datatype": "raw",
#         "disabled": true,
#         "host": "$decideOnStartup",
#         "index": "default",
#         "name": "default:8100",
#         "protocol": "tcp",
#         "queue": "parsingQueue",
#         "raw_tcp_done_timeout": 9,
#         "restrict_to_host": "default",
#         "source": "test_source",
#         "sourcetype": "test_source_type"
#     }
# ]

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

- name: Replace existing data inputs networks configuration
  register: result
  splunk.es.splunk_data_inputs_network:
    state: replaced
    config:
      - protocol: tcp
        datatype: raw
        name: 8100
        connection_host: ip
        disabled: true
        host: "$decideOnStartup"
        index: default
        queue: parsingQueue
        raw_tcp_done_timeout: 10
        restrict_to_host: default
        source: test_source
        sourcetype: test_source_type

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

# "after": [
#     {
#         "connection_host": "ip",
#         "datatype": "raw",
#         "disabled": true,
#         "host": "$decideOnStartup",
#         "index": "default",
#         "name": "default:8100",
#         "protocol": "tcp",
#         "queue": "parsingQueue",
#         "raw_tcp_done_timeout": 9,
#         "restrict_to_host": "default",
#         "source": "test_source",
#         "sourcetype": "test_source_type"
#     }
# ],
# "before": [
#     {
#         "connection_host": "ip",
#         "datatype": "raw",
#         "disabled": true,
#         "host": "$decideOnStartup",
#         "index": "default",
#         "name": "default:8100",
#         "protocol": "tcp",
#         "queue": "parsingQueue",
#         "raw_tcp_done_timeout": 10,
#         "restrict_to_host": "default",
#         "source": "test_source",
#         "sourcetype": "test_source_type"
#     }
# ],

Возвращаемые значения

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

Ключ	Описание
after список / элементы=строка	Конфигурация после выполнения модуля. Возвращается: при изменении Пример: `["This output will always be in the same format as the module argspec.\n"]`
before список / элементы=строка	Конфигурация до выполнения модуля. Возвращается: если state равен merged, replaced или deleted Пример: `["This output will always be in the same format as the module argspec.\n"]`
gathered словарь	Факты о сетевом ресурсе, полученные с удалённого устройства в виде структурированных данных. Возвращается: если state равен gathered Пример: `"This output will always be in the same format as the module argspec.\n"`

Авторы

Команда Ansible Security Automation (@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_network_module.html