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

Примечание

Этот модуль входит в коллекцию splunk.es (версия 3.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.

Примечание

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

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

Параметры

Параметр	Комментарии
config list / elements=dictionary	Управление и предварительный просмотр данных протокола ввода.
cipher_suite string	Указывает список допустимых шифров для использования в ssl. Получается только для конфигурации TCP SSL, присутствующей на устройстве.
connection_host string	Устанавливает хост для удаленного сервера, который отправляет данные. `ip` устанавливает хост в IP-адрес удаленного сервера, отправляющего данные. `dns` устанавливает хост в обратную запись DNS для IP-адреса удаленного сервера, отправляющего данные. `none` оставляет хост как указано в inputs.conf, что обычно является именем хоста системы Splunk. Варианты: `"ip"` `"dns"` `"none"`
datatype string	`cooked` позволяет получить доступ к обработанной информации TCP-ввода и создать новые контейнеры для управления обработанными данными. `raw` позволяет управлять необработанными tcp-входами от forwarders. `splunktcptoken` позволяет управлять доступом получателя с помощью токенов. `ssl` Предоставляет доступ к конфигурации SSL сервера Splunk. Этот параметр не поддерживает состояния deleted и replaced. Варианты: `"cooked"` `"raw"` `"splunktcptoken"` `"ssl"`
disabled boolean	Указывает, отключен ли ввод. Варианты: `false` `true`
host string	Хост, с которого индексатор получает данные.
index string	Индекс по умолчанию для хранения созданных событий.
name string / required	Вводной порт, который получает необработанные данные.
no_appending_timestamp boolean	Если установлено в true, предотвращает добавление метки времени и имени хоста к входящим событиям программным обеспечением Splunk. Только для конфигурации ввода данных UDP. Варианты: `false` `true`
no_priority_stripping boolean	Если установлено в true, программное обеспечение Splunk не удаляет поле приоритета из входящих событий syslog. Только для конфигурации ввода данных UDP. Варианты: `false` `true`
password string	Пароль сертификата сервера, если есть. Только для конфигурации TCP SSL.
protocol string / required	Выберите, нужно ли управлять входами TCP или UDP Варианты: `"tcp"` `"udp"`
queue string	Указывает, куда процессор ввода должен помещать считываемые события. По умолчанию parsingQueue. Установите очередь в parsingQueue, чтобы применить props.conf и другие правила анализа к вашим данным. Для получения дополнительной информации о props.conf и правилах для установки меток времени и разрыва строк, см. props.conf и онлайн-документацию по адресу «Мониторинг файлов и каталогов с помощью inputs.conf» Установите очередь в indexQueue, чтобы отправлять данные непосредственно в индекс. Применимо только для API «/tcp/raw» и «/udp» Варианты: `"parsingQueue"` `"indexQueue"`
raw_tcp_done_timeout integer	Указывает в секундах значение времени ожидания для добавления ключа Done. Если соединение через порт, указанный именем, остается бездействующим после получения данных в течение указанного количества секунд, оно добавляет ключ Done. Это означает, что последнее событие полностью получено. Только для конфигурации необработанного ввода TCP.
require_client_cert string	Определяет, должна ли клиентская сторона проходить аутентификацию. Только для конфигурации TCP SSL.
restrict_to_host string	Позволяет ограничить этот вход, чтобы он принимал данные только от хоста, указанного здесь.
root_ca string	Список центров сертификации (корневой файл). Только для конфигурации TCP SSL.
server_cert string	Полный путь к сертификату сервера. Только для конфигурации TCP SSL.

source string	Устанавливает ключ/поле источника для событий из этого входа. По умолчанию используется путь к файлу входа. Устанавливает начальное значение ключа источника. Ключ используется во время разбора/индексирования, в частности для установки поля источника во время индексирования. Это также поле источника, используемое во время поиска. Для удобства выбранная строка предваряется строкой ‘source::’. Обратите внимание, что переопределение ключа источника не рекомендуется. Обычно уровень входа предоставляет более точную строку, которая поможет в анализе и устранении проблем, точно фиксируя файл, из которого были извлечены данные. Перед переопределением этого значения рассмотрите использование типов источников, тегов и поисковых подстановочных знаков.
sourcetype string	Устанавливает тип источника для событий из этого входа. «sourcetype =» автоматически добавляется перед <string>. По умолчанию используется audittrail (если signedaudit=true) или fschange (если signedaudit=false).
ssl boolean	Включить или выключить ssl для потока данных Варианты: `false` `true`
token string	Значение токена для использования с SplunkTcpToken. Если не указано, токен генерируется автоматически.
running_config string	По умолчанию модуль подключается к удаленному устройству и извлекает текущую конфигурацию running-config для использования в качестве основы для сравнения с содержимым источника. Иногда нежелательно получать текущую running-config для каждой задачи в playbook. Аргумент running_config позволяет реализатору передавать конфигурацию для использования в качестве базовой конфигурации сравнения. Это значение должно быть результатом выполнения команды на устройстве.
state string	Состояние, в котором должна быть оставлена конфигурация Варианты: `"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 список / элементы=строка	Конфигурация перед выполнением модуля. Возвращается: когда состояние merged, replaced, deleted Пример: `["This output will always be in the same format as the module argspec.\n"]`
gathered словарь	Факты о сетевом ресурсе, собранные с удаленного устройства в виде структурированных данных. Возвращается: когда состояние gathered Пример: `"This output will always be in the same format as the module argspec.\n"`

Авторы

Команда Ansible по автоматизации безопасности (@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_network_module.html