Модуль f5networks.f5_modules.bigip_firewall_log_profile — управление профилями ведения журнала AFM, настроенными в системе

Примечание

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

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

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

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

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

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Управляет профилями ведения журнала AFM (Advanced Firewall Manager), настроенными в системе, а также основной информацией о каждом профиле.

Параметры

Параметр	Описание
description string	Описание профиля ведения журнала.
dos_protection dictionary	Настраивает параметры защиты от DoS для профиля ведения журнала.
dns_publisher string	Указывает имя издателя журнала, используемого для событий DNS DoS. Чтобы указать log_publisher в разделе, отличном от раздела профиля ведения журнала AFM, укажите имя в формате полного пути, например `/Foobar/log-publisher`; в противном случае раздел для издателя журнала определяется по параметру модуля `partition`.
network_publisher string	Указывает имя издателя журнала, используемого для сетевых событий DoS. Чтобы указать log_publisher в разделе, отличном от раздела профиля ведения журнала AFM, укажите имя в формате полного пути, например `/Foobar/log-publisher`; в противном случае раздел для издателя журнала определяется по параметру модуля `partition`.
sip_publisher string	Указывает имя издателя журнала, используемого для событий SIP DoS. Чтобы указать log_publisher в разделе, отличном от раздела профиля ведения журнала AFM, укажите имя в формате полного пути, например `/Foobar/log-publisher`; в противном случае раздел для издателя журнала определяется по параметру модуля `partition`.
ip_intelligence dictionary	Настраивает параметры IP Intelligence для профиля ведения журнала.
log_publisher string	Указывает имя издателя журнала, используемого для событий IP Intelligence. Чтобы указать log_publisher в разделе, отличном от раздела профиля ведения журнала AFM, укажите имя в формате полного пути, например `/Foobar/log-publisher`; в противном случае раздел для издателя журнала определяется по параметру модуля `partition`.
log_rtbh boolean	Если `true`, указывает, что события удалённого включения фильтрации трафика (blackholing) регистрируются в журнале. Допустимые значения: `false` `true`
log_shun boolean	Если `true`, указывает, что события списка блокировок IP Intelligence регистрируются в журнале. Этот параметр можно задать только для встроенного профиля `global-network`. Допустимые значения: `false` `true`
log_translation_fields boolean	Этот параметр используется для включения или отключения регистрации преобразованных (то есть серверных) полей в сообщениях журнала IP Intelligence. К преобразованным полям относятся, помимо прочего, адрес/порт источника, адрес/порт назначения, протокол IP, домен маршрутизации и VLAN. Допустимые значения: `false` `true`
rate_limit string	Задаёт ограничение частоты для общего количества сообщений журнала IP Intelligence в секунду. При превышении этого ограничения сообщения не регистрируются, пока пороговое значение не опустится ниже заданной частоты. Чтобы задать неограниченную частоту, используйте значение `indefinite`. Если указана числовая частота, её значение должно находиться в диапазоне от `1` до `4294967295`.
name string / обязательный	Указывает имя профиля ведения журнала.
partition string	Раздел устройства, в котором создаётся профиль ведения журнала. Этот параметр также используется при указании имён издателей журнала, если только имена издателей не заданы в формате полного пути. По умолчанию: `"Common"`
port_misuse dictionary	Настройки ведения журнала для случаев неправильного использования портов.
log_publisher string	Указывает имя издателя журнала, используемого для событий неправильного использования портов. Чтобы указать log_publisher в разделе, отличном от раздела профиля ведения журнала AFM, укажите имя в формате полного пути, например `/Foobar/log-publisher`; в противном случае раздел для издателя журнала определяется по параметру модуля `partition`.
rate_limit string	Задаёт ограничение частоты для общего количества сообщений журнала о неправильном использовании портов в секунду. При превышении этого ограничения сообщения не регистрируются, пока пороговое значение не опустится ниже заданной частоты. Чтобы задать неограниченную частоту, используйте значение `indefinite`. Если указана числовая частота, её значение должно находиться в диапазоне от `1` до `4294967295`.
provider dictionary добавлено в f5networks.f5_modules 1.0.0	Объект dict с параметрами подключения.
auth_provider string	Настраивает поставщика аутентификации, используемого для получения токенов аутентификации с удалённого устройства. Этот параметр применяется при работе с устройствами BIG-IQ.
no_f5_teem boolean	Если `yes`, телеметрические данные TEEM не отправляются в F5. Этот параметр можно не указывать, задав переменную среды `F5_TELEMETRY_OFF`. Ранее использовавшаяся переменная `F5_TEEM` объявлена устаревшей, поскольку её имя было неоднозначным. Допустимые значения: `false` ← (по умолчанию) `true`
password псевдонимы: pass, pwd string / обязательный	Пароль учётной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную среды `F5_PASSWORD`.
server string / обязательный	Узел BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную среды `F5_SERVER`.
server_port integer	Порт сервера BIG-IP. Этот параметр можно не указывать, задав переменную среды `F5_SERVER_PORT`. По умолчанию: `443`
timeout integer	Задаёт время ожидания в секундах при взаимодействии с сетевым устройством — для подключения или отправки команд. Если время ожидания истечёт до завершения операции, модуль выдаст ошибку.
transport string	Настраивает транспортное соединение, используемое для подключения к удалённому устройству. Допустимые значения: `"rest"` ← (по умолчанию)
user string / обязательный	Имя пользователя для подключения к BIG-IP или BIG-IQ. У этого пользователя должны быть административные привилегии на устройстве. Этот параметр можно не указывать, задав переменную среды `F5_USER`.
validate_certs boolean	Если `no`, сертификаты SSL не проверяются. Используйте этот параметр только на контролируемых вами сайтах с самоподписанными сертификатами. Этот параметр можно не указывать, задав переменную среды `F5_VALIDATE_CERTS`. Допустимые значения: `false` `true` ← (по умолчанию)
state string	Если для `state` задано значение `present`, обеспечивает наличие ресурса. Если для `state` задано значение `absent`, обеспечивает удаление ресурса. Попытки удалить встроенные системные профили игнорируются, и изменения не возвращаются. Допустимые значения: `"present"` ← (по умолчанию) `"absent"`

Примечания

Примечание

Дополнительную информацию об использовании 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 basic log profile with port misuse
  bigip_firewall_log_profile:
    name: barbaz
    port_misuse:
      rate_limit: 30000
      log_publisher: local-db-pub
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Change ip_intelligence settings, publisher on different partition, remove port misuse
  bigip_firewall_log_profile:
    name: barbaz
    ip_intelligence:
      rate_limit: 400000
      log_translation_fields: true
      log_rtbh: true
      log_publisher: "/foobar/non-local-db"
    port_misuse:
      log_publisher: ""
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Create a log profile with dos protection, different partition
  bigip_firewall_log_profile:
    name: foobar
    partition: foobar
    dos_protection:
      dns_publisher: "/Common/local-db-pub"
      sip_publisher: "non-local-db"
      network_publisher: "/Common/local-db-pub"
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Remove log profile
  bigip_firewall_log_profile:
    name: barbaz
    partition: Common
    state: absent
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

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

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

Ключ	Описание
description string	Новое описание профиля ведения журнала AFM. Возвращается: changed Пример: `"This is my description"`
dos_protection complex	Издатели журнала, используемые в параметрах защиты от DoS профиля ведения журнала. Возвращается: changed Пример: `"hash/dictionary of values"`
dns_publisher string	Имя издателя журнала, используемого для событий DNS DoS. Возвращается: changed Пример: `"/Common/local-db-publisher"`
network_publisher string	Имя издателя журнала, используемого для сетевых событий DoS. Возвращается: changed Пример: `"/Common/local-db-publisher"`
sip_publisher string	Имя издателя журнала, используемого для событий SIP DoS. Возвращается: changed Пример: `"/Common/local-db-publisher"`
ip_intelligence complex	Параметры IP Intelligence для профиля ведения журнала. Возвращается: changed Пример: `"hash/dictionary of values"`
log_publisher string	Имя издателя журнала, используемого для событий IP Intelligence. Возвращается: changed Пример: `"/Common/local-db-publisher"`
log_rtbh boolean	Регистрация в журнале событий удалённого включения фильтрации трафика (blackholing). Возвращается: changed Пример: `true`
log_shun boolean	Регистрация в журнале событий списка блокировок IP Intelligence. Возвращается: changed Пример: `false`
log_translation_fields boolean	Регистрация преобразованных полей в сообщениях журнала IP Intelligence. Возвращается: changed Пример: `false`
rate_limit string	Ограничение частоты для общего количества сообщений журнала IP Intelligence в секунду. Возвращается: changed Пример: `"indefinite"`
port_misuse complex	Параметры профиля ведения журнала, связанные с неправильным использованием портов. Возвращается: changed Пример: `"hash/dictionary of values"`
log_publisher string	Имя издателя журнала, используемого для событий неправильного использования портов. Возвращается: changed Пример: `"/Common/local-db-publisher"`
rate_limit string	Ограничение частоты для общего количества сообщений журнала о неправильном использовании портов в секунду. Возвращается: changed Пример: `"indefinite"`

Авторы

Wojciech Wypior (@wojtek0806)

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

© 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_firewall_log_profile_module.html