Модуль f5networks.f5_modules.bigip_log_destination — управление местами назначения журналов на BIG-IP.

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.39.0).

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

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

Чтобы использовать коллекцию в плейбуке, укажите: f5networks.f5_modules.bigip_log_destination.

Добавлено в f5networks.f5_modules 1.0.0

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

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

Управление местами назначения журналов на устройстве BIG-IP.

Параметры

Параметр	Комментарии
address строка	Указывает IP-адрес, на который будут поступать сообщения из указанного локального места назначения журналов. Этот параметр доступен только при `type` равно `management-port`. При создании места назначения журналов и если `type` равно `management-port` этот параметр обязателен.
description строка	Описание места назначения журналов.
distribution строка	Указывает метод распределения, используемый удаленным местом назначения журналов с высокой пропускной способностью для отправки сообщений участникам пула. При значении `adaptive` подключения к участникам пула добавляются по мере необходимости, чтобы обеспечить достаточную пропускную способность для ведения журналов. Это может привести к нежелательному накоплению журналов только на одном участнике пула, если его собственной пропускной способности достаточно. При значении `balanced` каждый следующий журнал отправляется новому участнику пула, а журналы распределяются между участниками согласно методу балансировки нагрузки пула. При значении `replicated` каждый журнал копируется всем участникам пула для обеспечения отказоустойчивости. При создании нового места назначения журналов, если `type` равно `remote-high-speed-log` и этот параметр не указан, по умолчанию используется `adaptive`. Варианты: `"adaptive"` `"balanced"` `"replicated"`
forward_to строка	Если `type` равно `remote-syslog`, указывает место назначения журналов на порту управления, которое будет использоваться для пересылки журналов на один сервер журналов, либо удаленное место назначения журналов с высокой пропускной способностью, которое будет использоваться для пересылки журналов в пул удаленных серверов журналов. Если `type` равно `splunk` или `arcsight`, указывает место назначения журналов, куда пересылаются журналы. Это место назначения может быть местом назначения на порту управления, удаленным местом назначения журналов с высокой пропускной способностью или удаленным местом назначения Syslog, настроенным для отправки журналов на сервер ArcSight или Splunk. При создании нового места назначения журналов, если `type` равно `remote-syslog`, `splunk` или `arcsight`, этот параметр обязателен.
name строка / обязательный	Указывает имя места назначения журналов.
partition строка	Раздел устройства для управления ресурсами. По умолчанию: `"Common"`
pool строка	Если `type` равно `remote-high-speed-log`, указывает существующий пул удаленных серверов журналов с высокой пропускной способностью, на которые будут отправляться журналы. Если `type` равно `ipfix`, указывает существующий пул LTM удаленных сборщиков IPFIX. Любое приложение BIG-IP, использующее это место назначения журналов, отправляет в этот пул сборщиков журналы IP-трафика. При создании нового места назначения, если `type` равно `remote-high-speed-log` или `ipfix`, этот параметр обязателен.
port целое число	Указывает порт IP-адреса, на который будут поступать сообщения из указанного локального места назначения журналов. Этот параметр доступен только при `type` равно `management-port`. При создании места назначения журналов и если `type` равно `management-port` этот параметр обязателен.
protocol строка	Если `type` равно `remote-high-speed-log`, указывает протокол, который система будет использовать для отправки журналов в пул удаленных серверов журналов с высокой пропускной способностью, где они хранятся. Если `type` равно `ipfix`, может использоваться IPFIX или Netflow v9 — в зависимости от типа сборщиков в указанном пуле. Если `type` равно `management-port`, указывает протокол для отправки сообщений в заданное место. Если `type` равно `management-port`, допустимы только значения `tcp` и `udp`. Варианты: `"tcp"` `"udp"` `"ipfix"` `"netflow-9"`
provider словарь добавлено в f5networks.f5_modules 1.0.0	Объект dict, содержащий сведения для подключения.
auth_provider строка	Настраивает поставщика аутентификации для получения токенов аутентификации с удаленного устройства. Этот параметр используется главным образом при работе с устройствами BIG-IQ.
no_f5_teem логическое значение	Если `yes`, телеметрические данные TEEM не отправляются в F5. Этот параметр можно не указывать, задав переменную окружения `F5_TELEMETRY_OFF`. Ранее использовавшаяся переменная `F5_TEEM` устарела, поскольку ее название вводило в заблуждение. Варианты: `false` ← (по умолчанию) `true`
password псевдонимы: pass, pwd строка / обязательный	Пароль учетной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную окружения `F5_PASSWORD`.
server строка / обязательный	Имя узла BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную окружения `F5_SERVER`.
server_port целое число	Порт сервера BIG-IP. Этот параметр можно не указывать, задав переменную окружения `F5_SERVER_PORT`. По умолчанию: `443`
timeout целое число	Задает время ожидания в секундах при взаимодействии с сетевым устройством — как при подключении, так и при отправке команд. Если время ожидания истечет до завершения операции, модуль выдаст ошибку.
transport строка	Настраивает транспортное соединение для подключения к удаленному устройству. Варианты: `"rest"` ← (по умолчанию)
user строка / обязательный	Имя пользователя для подключения к BIG-IP или BIG-IQ. У этого пользователя должны быть права администратора на устройстве. Этот параметр можно не указывать, задав переменную окружения `F5_USER`.
validate_certs логическое значение	Если `no`, сертификаты SSL не проверяются. Используйте этот параметр только на контролируемых вами сайтах с самоподписанными сертификатами. Этот параметр можно не указывать, задав переменную окружения `F5_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
server_ssl_profile строка	Если `transport_profile` — это профиль TCP, с помощью этого поля можно выбрать профиль Secure Socket Layer (SSL) для отправки журналов сборщикам IPFIX. Профиль SSL-сервера определяет, как устанавливать защищенное соединение по SSL или Transport Layer Security (TLS). Этот параметр доступен только при `type` равно `ipfix`.
state строка	При значении `present` обеспечивает наличие ресурса. При значении `absent` обеспечивает удаление ресурса. Варианты: `"present"` ← (по умолчанию) `"absent"`
syslog_format строка	Указывает метод форматирования журналов, связанных с удаленным местом назначения журналов Syslog. При создании нового места назначения журналов (если `type` равно `remote-syslog`) и если этот параметр не указан, по умолчанию используется `bsd-syslog`. Варианты `syslog` и `rfc5424` означают одно и то же. Варианты `bsd-syslog` и `rfc3164` означают одно и то же. Варианты: `"bsd-syslog"` `"syslog"` `"legacy-bigip"` `"rfc5424"` `"rfc3164"`
template_delete_delay целое число	Укажите время (в секундах), в течение которого устройство BIG-IP должно ожидать между удалением устаревшего шаблона IPFIX и повторным использованием его идентификатора. Эта функция полезна в системах, где для создания пользовательских шаблонов IPFIX используются iRules.
template_retransmit_interval целое число	Укажите интервал (в секундах) между передачами шаблонов IPFIX в пул сборщиков IPFIX. Место назначения журналов периодически повторно передает все свои шаблоны IPFIX с интервалом, заданным в этом поле. Повторные передачи полезны для UDP — ненадежного транспортного механизма. Этот параметр доступен только при `type` равно `ipfix`.
transport_profile строка	Транспортный профиль на основе TCP или UDP. Этот профиль определяет параметры TCP или UDP, используемые для отправки журналов IP-трафика в пул сборщиков. Этот параметр доступен только при `type` равно `ipfix`.
type строка / обязательный	Указывает тип места назначения журналов. После создания этот параметр нельзя изменить. Варианты: `"remote-high-speed-log"` `"remote-syslog"` `"arcsight"` `"splunk"` `"management-port"` `"ipfix"`

Примечания

Примечание

Дополнительные сведения об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
Требуется версия программного обеспечения BIG-IP >= 12.
Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы обеспечить сохранение специфичной для BIG-IP конфигурации на диске, включите как минимум одну задачу, использующую модуль f5networks.f5_modules.bigip_config для сохранения текущей конфигурации. Инструкции по правильному использованию модуля для сохранения текущей конфигурации см. в документации модуля.

Примеры

- name: Create a high-speed logging destination
  bigip_log_destination:
    name: foo
    type: remote-high-speed-log
    pool: my-ltm-pool
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Create a remote-syslog logging destination
  bigip_log_destination:
    name: foo
    type: remote-syslog
    syslog_format: rfc5424
    forward_to: my-destination
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

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

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

Ключ	Описание
address строка	Новое значение адреса. Возвращается: при изменении Пример: `"1.2.3.2"`
distribution строка	Новое значение метода распределения. Возвращается: при изменении Пример: `"balanced"`
forward_to строка	Новое значение параметра Forward To. Возвращается: при изменении Пример: `"/Common/dest1"`
pool строка	Новое значение пула. Возвращается: при изменении Пример: `"/Common/pool1"`
port целое число	Новое значение порта. Возвращается: при изменении Пример: `2020`
protocol строка	Новое значение протокола. Возвращается: при изменении Пример: `"tcp"`
server_ssl_profile строка	Новое значение профиля SSL-сервера. Возвращается: при изменении Пример: `"/Common/serverssl"`
syslog_format строка	Новое значение формата Syslog. Возвращается: при изменении Пример: `"syslog"`
template_delete_delay целое число	Новое значение задержки удаления шаблона. Возвращается: при изменении Пример: `20`
template_retransmit_interval целое число	Новое значение интервала повторной передачи шаблона. Возвращается: при изменении Пример: `200`
transport_profile строка	Новое значение транспортного профиля. Возвращается: при изменении Пример: `"/Common/tcp"`

Авторы

Tim Rupp (@caphrim007)

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

© 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/f5networks/f5_modules/bigip_log_destination_module.html