Spec-Zone.ru › Ansible

Модуль f5networks.f5_modules.bigip_firewall_log_profile_network — настройка параметров межсетевого экрана Network Firewall в профиле журнала

Примечание

Этот модуль входит в коллекцию 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_network.

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

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

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

  • Настраивает параметры межсетевого экрана Network Firewall в профиле журнала.

Параметры

Параметр

Комментарии

log_format_delimiter

string

Задает строку-разделитель при использовании log_storage_format из field-list.

При создании нового профиля, если этот параметр не указан, используется значение по умолчанию , (символ запятой).

Этот параметр действителен, если для log_storage_format задано значение field-list. В противном случае он игнорируется.

В зависимости от используемого разделителя может потребоваться заключить его в кавычки, чтобы избежать ошибок YAML.

Специальный символ $ зарезервирован для внутреннего использования; его использование приведет к ошибке.

Максимальная допустимая длина этого параметра — 31 символов.

log_ip_errors

dictionary

Изменяет параметры ведения журнала для регистрации пакетов с ошибками IP.

enabled

boolean

Этот параметр включает или отключает регистрацию пакетов с ошибками IP.

Варианты:

  • false
  • true

rate_limit

string

Этот параметр задает ограничения частоты регистрации пакетов с ошибками IP.

Параметр действует, только если включена регистрация сообщений этого типа.

log_matches_accept_rule

dictionary

Изменяет параметры ведения журнала для правил ACL, настроенных с действием «accept» или «accept decisively».

enabled

boolean

Этот параметр включает или отключает регистрацию пакетов, соответствующих правилам ACL, настроенным с действием «accept» или «accept decisively».

Варианты:

  • false
  • true

rate_limit

string

Этот параметр задает ограничения частоты регистрации пакетов, соответствующих правилам ACL, настроенным с действием «accept» или «accept decisively».

Параметр действует, только если включена регистрация сообщений этого типа.

log_matches_drop_rule

dictionary

Изменяет параметры ведения журнала для правил ACL, настроенных с действием drop.

enabled

boolean

Этот параметр включает или отключает регистрацию пакетов, соответствующих правилам ACL, настроенным с действием drop.

Варианты:

  • false
  • true

rate_limit

string

Этот параметр задает ограничения частоты регистрации пакетов, соответствующих правилам ACL, настроенным с действием drop.

Параметр действует, только если включена регистрация сообщений этого типа.

log_matches_reject_rule

dictionary

Изменяет параметры ведения журнала для правил ACL, настроенных с действием reject.

enabled

boolean

Этот параметр включает или отключает регистрацию пакетов, соответствующих правилам ACL, настроенным с действием reject.

Варианты:

  • false
  • true

rate_limit

string

Этот параметр задает ограничения частоты регистрации пакетов, соответствующих правилам ACL, настроенным с действием reject.

Параметр действует, только если включена регистрация сообщений этого типа.

log_message_fields

list / elements=string

Задает набор полей для регистрации.

Этот параметр действителен, если для log_storage_format задано значение field-list. В противном случае он игнорируется.

Порядок элементов списка важен, поскольку сервер последовательно отображает в журнале выбранные элементы трафика в соответствии с этим порядком.

Варианты:

  • "acl_policy_name"
  • "acl_policy_type"
  • "acl_rule_name"
  • "action"
  • "bigip_hostname"
  • "context_name"
  • "context_type"
  • "date_time"
  • "dest_fqdn"
  • "dest_geo"
  • "dest_ip"
  • "dest_port"
  • "drop_reason"
  • "management_ip_address"
  • "protocol"
  • "route_domain"
  • "sa_translation_pool"
  • "sa_translation_type"
  • "source_fqdn"
  • "source_user"
  • "src_geo"
  • "src_ip"
  • "src_port"
  • "translated_dest_ip"
  • "translated_dest_port"
  • "translated_ip_protocol"
  • "translated_route_domain"
  • "translated_src_ip"
  • "translated_src_port"
  • "translated_vlan"
  • "vlan"

log_publisher

string

Задает имя издателя журналов, используемого для сетевых событий.

Чтобы указать log_publisher в разделе, отличном от раздела профиля журнала AFM, укажите имя в формате полного пути, например /Foobar/log-publisher; в противном случае раздел для издателя журналов определяется по параметру модуля partition.

log_storage_format

string

Задает тип формата хранения.

При создании нового профиля журнала, если этот параметр не указан, используется значение по умолчанию none.

Если задано field-list, в журнале отображаются только элементы, указанные в списке log_message_fields, с разделителем log_format_delimiter между элементами.

Если задано none, сообщения записываются в формате по умолчанию, то есть "management_ip_address", "bigip_hostname","context_type", "context_name","src_geo","src_ip", "dest_geo","dest_ip","src_port", "dest_port","vlan","protocol","route_domain", "translated_src_ip", "translated_dest_ip", "translated_src_port","translated_dest_port", "translated_vlan","translated_ip_protocol", "translated_route_domain", "acl_policy_type", "acl_policy_name","acl_rule_name","action", "drop_reason","sa_translation_type", "sa_translation_pool","flow_id", "source_user", "source_fqdn","dest_fqdn".

Варианты:

  • "field-list"
  • "none"

log_tcp_errors

dictionary

Изменяет параметры ведения журнала для регистрации пакетов с ошибками TCP.

enabled

boolean

Этот параметр включает или отключает регистрацию пакетов с ошибками TCP.

Варианты:

  • false
  • true

rate_limit

string

Этот параметр задает ограничения частоты регистрации пакетов с ошибками TCP.

Параметр действует, только если включена регистрация сообщений этого типа.

log_tcp_events

dictionary

Изменяет параметры ведения журнала для регистрации событий TCP на стороне клиента.

enabled

boolean

Этот параметр включает или отключает регистрацию событий TCP на стороне клиента.

Если этот параметр включен, регистрируются только состояния TCP-сеанса Установленное и Закрытое.

Варианты:

  • false
  • true

rate_limit

string

Этот параметр задает ограничения частоты регистрации событий TCP на стороне клиента.

Параметр действует, только если включена регистрация сообщений этого типа.

log_translation_fields

boolean

Этот параметр включает или отключает регистрацию преобразованных полей (то есть полей на стороне сервера) в событиях совпадения ACL и TCP.

К преобразованным полям относятся, помимо прочего, адрес/порт источника, адрес/порт назначения, протокол IP, домен маршрутизации и VLAN.

Варианты:

  • false
  • true

partition

string

Раздел устройства, в котором создается профиль ведения журнала.

Этот параметр также используется при указании имен издателей журналов, если их имена не заданы в формате полного пути.

По умолчанию: "Common"

profile_name

string / обязательный

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

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 ← (по умолчанию)

rate_limit

string

Задает ограничение частоты для всех объединенных сообщений журнала сетевого межсетевого экрана в секунду. При превышении этого ограничения сообщения журнала не регистрируются.

Чтобы задать неограниченную частоту, используйте значение indefinite.

Если указано числовое значение частоты, оно должно находиться в диапазоне от 1 до 4294967295.

state

string

Если state равно present, гарантирует существование ресурса.

Единственный встроенный профиль, для которого разрешено обновление параметров ведения журнала сети, — global-network. Попытки сделать это для других встроенных профилей игнорируются.

Если state равно absent, гарантирует удаление ресурса.

Состояние absent игнорируется для профиля журнала global-network.

Варианты:

  • "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: Add network settings to log profile
  bigip_firewall_log_profile_network:
    profile_name: barbaz
    rate_limit: "150000"
    log_publisher: local-db-pub
    log_tcp_errors:
      enabled: true
      rate_limit: "10000"
    log_tcp_events:
      enabled: true
      rate_limit: "40000"
    log_storage_format: "field-list"
    log_message_fields:
      - vlan
      - translated_vlan
      - src_ip
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Change delimiter and log fields
  bigip_firewall_log_profile_network:
    profile_name: barbaz
    log_format_delimiter: '.'
    log_message_fields:
      - translated_dest_ip
      - translated_dest_port
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Modify built-in profile
  bigip_firewall_log_profile_network:
    profile_name: "global-network"
    log_publisher: "/foobar/log1"
    log_ip_errors:
      enabled: true
      rate_limit: "60000"
    log_matches_reject_rule:
      enabled: true
      rate_limit: "2000"
    log_translation_fields: true
    log_storage_format: "field-list"
    log_format_delimiter: '.'
    log_message_fields:
      - protocol
      - dest_ip
      - dest_port
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Remove custom log profile network log settings
  bigip_firewall_log_profile_network:
    profile_name: "{{ log_profile }}"
    state: absent
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

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

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

Ключ

Описание

log_format_delimiter

string

Строка-разделитель при использовании формата хранения журнала field-list.

Возвращается: изменено

Пример: "."

log_ip_errors

complex

Настройки журнала для регистрации пакетов с ошибками IP.

Возвращается: изменено

Пример: "hash/dictionary of values"

enabled

boolean

Включает или отключает регистрацию пакетов с ошибками IP.

Возвращается: изменено

Пример: true

rate_limit

string

Ограничение частоты регистрации пакетов с ошибками IP.

Возвращается: изменено

Пример: "indefinite"

log_matches_accept_rule

complex

Настройки журнала для правил ACL, настроенных с действием «разрешить» или «безусловно разрешить».

Возвращается: изменено

Пример: "hash/dictionary of values"

enabled

boolean

Включает или отключает регистрацию пакетов, соответствующих правилам ACL.

Возвращается: изменено

Пример: true

rate_limit

string

Ограничение частоты регистрации пакетов, соответствующих правилам ACL.

Возвращается: изменено

Пример: "indefinite"

log_matches_drop_rule

complex

Настройки журнала для правил ACL, настроенных с действием «отбросить».

Возвращается: изменено

Пример: "hash/dictionary of values"

enabled

boolean

Включает или отключает регистрацию пакетов, соответствующих правилам ACL.

Возвращается: изменено

Пример: true

rate_limit

string

Ограничение частоты регистрации пакетов, соответствующих правилам ACL.

Возвращается: изменено

Пример: "indefinite"

log_matches_reject_rule

complex

Настройки журнала для правил ACL, настроенных с действием «отклонить».

Возвращается: изменено

Пример: "hash/dictionary of values"

enabled

boolean

Включает или отключает регистрацию пакетов, соответствующих правилам ACL.

Возвращается: изменено

Пример: true

rate_limit

string

Ограничение частоты регистрации пакетов, соответствующих правилам ACL.

Возвращается: изменено

Пример: "indefinite"

log_message_fields

list / elements=string

Строка-разделитель при использовании формата хранения журнала field-list.

Возвращается: изменено

Пример: ["acl_policy_name", "acl_policy_type"]

log_publisher

string

Имя издателя журнала, используемого для сетевых событий.

Возвращается: изменено

Пример: "/Common/log-publisher"

log_storage_format

string

Тип формата хранения.

Возвращается: изменено

Пример: "field-list"

log_tcp_errors

complex

Настройки журнала для регистрации пакетов с ошибками TCP.

Возвращается: изменено

Пример: "hash/dictionary of values"

enabled

boolean

Включает или отключает регистрацию пакетов с ошибками TCP.

Возвращается: изменено

Пример: true

rate_limit

string

Ограничение частоты регистрации пакетов с ошибками TCP.

Возвращается: изменено

Пример: "indefinite"

log_tcp_events

complex

Настройки журнала для регистрации событий TCP на стороне клиента.

Возвращается: изменено

Пример: "hash/dictionary of values"

enabled

boolean

Включает или отключает регистрацию событий TCP на стороне клиента.

Возвращается: изменено

Пример: true

rate_limit

string

Ограничение частоты регистрации событий TCP на стороне клиента.

Возвращается: изменено

Пример: "indefinite"

log_translation_fields

boolean

Включить или отключить ведение журнала для преобразованных полей (то есть полей на стороне сервера) в событиях сопоставления ACL и TCP.

Возвращается: changed

Пример: true

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_network_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API