bigip_firewall_log_profile_network – Configures Network Firewall related settings of the log profile — Ansible 2.10

Примечание

Этот плагин входит в коллекцию f5networks.f5_modules (версия 1.6.0).

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

Для использования в плейбуке укажите: f5networks.f5_modules.bigip_firewall_log_profile_network.

Новое в версии 1.0.0: из f5networks.f5_modules

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

Обзор

Настраивает параметры сетевого брандмауэра в профиле логов.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
log_format_delimiter строка			Указывает разделитель строк при использовании `log_storage_format`, `field-list`. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию `,` (запятая). Этот параметр действителен, когда `log_storage_format` установлено в `field-list`. В противном случае он игнорируется. В зависимости от используемого разделителя, может потребоваться заключить его в кавычки, чтобы избежать ошибок в YAML. Специальный символ `$` зарезервирован для внутреннего использования и вызовет ошибку, если будет использован. Максимальная длина этого параметра составляет `31` символов.
log_ip_errors словарь			Изменяет параметры логирования для пакетов с ошибками IP.
	enabled булево	Варианты: нет да	Этот параметр включает или выключает логирование пакетов с ошибками IP.
	rate_limit целое число		Этот параметр устанавливает лимиты скорости для логирования пакетов с ошибками IP. Этот параметр эффективен только в случае включенного логирования этого типа сообщений.
log_matches_accept_rule словарь			Изменяет настройки логирования для правил ACL, настроенных с действием «принять» или «принять решительно».
	enabled булево	Варианты: нет да	Этот параметр включает или выключает логирование пакетов, соответствующих правилам ACL, настроенным с действием «принять» или «принять решительно».
	rate_limit целое число		Этот параметр устанавливает лимиты скорости для логирования пакетов, соответствующих правилам ACL, настроенным с действием «принять» или «принять решительно». Этот параметр эффективен только в случае включенного логирования этого типа сообщений.
log_matches_drop_rule словарь			Изменяет параметры логирования для правил ACL, настроенных с действием «отбросить».
	enabled булево	Варианты: нет да	Этот параметр включает или выключает логирование пакетов, соответствующих правилам ACL, настроенным с действием «отбросить».
	rate_limit целое число		Этот параметр устанавливает лимиты скорости для логирования пакетов, соответствующих правилам ACL, настроенным с действием «отбросить». Этот параметр эффективен только в случае включенного логирования этого типа сообщений.
log_matches_reject_rule словарь			Изменяет параметры логирования для правил ACL, настроенных с действием «отклонить».
	enabled булево	Варианты: нет да	Этот параметр включает или выключает логирование пакетов, соответствующих правилам ACL, настроенным с действием «отклонить».
	rate_limit целое число		Этот параметр устанавливает лимиты скорости для логирования пакетов, соответствующих правилам ACL, настроенным с действием «отклонить». Этот параметр эффективен только в случае включенного логирования этого типа сообщений.
log_message_fields список / элементы=строка		Варианты: acl_policy_name acl_policy_type acl_rule_name действие bigip_hostname имя_контекста тип_контекста дата_время dest_fqdn dest_geo dest_ip dest_port причина_отбрасывания адрес_управления протокол 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_storage_format` установлено в `field-list`. В противном случае он игнорируется. Порядок в списке важен, так как сервер отображает выбранные элементы трафика в логе последовательно в соответствии с ним.
log_publisher строка			Указывает имя издателя логов, используемого для событий сети. Чтобы указать log_publisher на другом разделе, отличном от профиля логов AFM, укажите имя в формате полного пути, например, `/Foobar/log-publisher`, в противном случае раздел для издателя логов определяется по параметру модуля `partition`.
log_storage_format строка		Варианты: field-list none	Указывает тип формата хранения. При создании нового профиля логов, если этот параметр не указан, значение по умолчанию — `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".
log_tcp_errors словарь			Изменяет настройки логирования для пакетов с ошибками TCP.
	enabled булево	Варианты: нет да	Этот параметр включает или выключает логирование пакетов с ошибками TCP.
	rate_limit целое число		Этот параметр устанавливает лимиты скорости для логирования пакетов с ошибками TCP. Этот параметр эффективен только в случае включенного логирования этого типа сообщений.
log_tcp_events словарь			Изменяет настройки логирования для событий TCP на стороне клиента.
	enabled булево	Варианты: нет да	Этот параметр включает или выключает логирование событий TCP на стороне клиента. Если этот параметр включен, логируются только состояния «установлено» и «закрыто» TCP-сеанса.
	rate_limit целое число		Этот параметр устанавливает лимиты скорости для логирования событий TCP на стороне клиента. Этот параметр эффективен только в случае включенного логирования этого типа сообщений.
log_translation_fields булево		Варианты: нет да	Этот параметр включает или выключает логирование переведенных (т. е. на стороне сервера) полей в совпадениях ACL и событиях TCP. Переведенные поля включают (но не ограничиваются): исходный адрес/порт, целевой адрес/порт, IP-протокол, домен маршрутизации и VLAN.
partition строка		Значение по умолчанию: "Common"	Раздел устройства для создания профиля логов. Этот параметр также используется при указании имен издателей логов, если имена издателей логов не указаны в формате полного пути.
profile_name строка / обязательный			Указывает имя обновляемого профиля логов AFM (Advanced Firewall Manager).
provider словарь добавлен в 1.0.0 f5networks.f5_modules			Объект словаря, содержащий данные подключения.
	auth_provider строка		Настраивает поставщика аутентификации для получения маркеров аутентификации от удаленного устройства. Этот параметр используется при работе с устройствами BIG-IQ.
	no_f5_teem булево	Варианты: нет да	Если `yes`, данные телеметрии TEEM не отправляются в F5. Этот параметр можно опустить, установив переменную окружения `F5_TEEM`.
	password строка / обязательный		Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Этот параметр можно опустить, установив переменную окружения `F5_PASSWORD`. псевдонимы: pass, pwd
	server строка / обязательный		Хост BIG-IP. Этот параметр можно опустить, установив переменную окружения `F5_SERVER`.
	server_port целое число	Значение по умолчанию: 443	Порт сервера BIG-IP. Этот параметр можно опустить, установив переменную окружения `F5_SERVER_PORT`.
	timeout целое число		Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль вернёт ошибку.
	transport строка	Варианты: rest ←	Настраивает транспортное соединение, используемое при подключении к удаленному устройству.

	пользователь строка / обязательно		Имя пользователя для подключения к BIG-IP. У этого пользователя должны быть административные права на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
	validate_certs логическое значение	Варианты: нет да ←	Если `no`, сертификаты SSL не проверяются. Используйте только на сайтах, находящихся под вашим контролем, использующих самозаверяющие сертификаты. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`.
rate_limit строка			Определяет лимит скорости для всех совокупных сообщений журналов сетевого брандмауэра в секунду. При превышении этого лимита сообщения журнала не регистрируются. Для указания неограниченного лимита используйте значение `indefinite`. Если вы указываете числовой лимит, значение должно быть между `1` и `4294967295`.
state строка		Варианты: present ← absent	Когда `state` равно `present`, гарантирует существование ресурса. Единственный встроенный профиль, который позволяет обновлять настройки журналов сети, — это global-network. Попытки сделать это в других встроенных профилях будут игнорироваться. Когда `state` равно `absent`, гарантирует удаление ресурса. Состояние `absent` игнорируется для профиля журнала global-network.

Примечания

Примечание

Дополнительную информацию об использовании 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: yes
      rate_limit: 10000
    log_tcp_events:
      enabled: yes
      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: yes
      rate_limit: 60000
    log_matches_reject_rule:
      enabled: yes
      rate_limit: 2000
    log_translation_fields: yes
    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 строка		изменилось	Разделитель строк при использовании log_storage_format типа field-list. Пример: .
log_ip_errors сложное		изменилось	Настройки журнала для регистрации пакетов с ошибками IP. Пример: хэш/словарь значений
	enabled логическое значение	изменилось	Включить или выключить регистрацию пакетов с ошибками IP. Пример: True
	rate_limit строка	изменилось	Лимит скорости для регистрации пакетов с ошибками IP. Пример: неограниченный
log_matches_accept_rule сложное		изменилось	Настройки журнала для правил ACL, настроенных с действием «accept» или «accept decisively». Пример: хэш/словарь значений
	enabled логическое значение	изменилось	Включить или выключить регистрацию пакетов, соответствующих правилам ACL. Пример: True
	rate_limit строка	изменилось	Лимит скорости для регистрации пакетов, соответствующих правилам ACL. Пример: неограниченный
log_matches_drop_rule сложное		изменилось	Настройки журнала для правил ACL, настроенных с действием «drop». Пример: хэш/словарь значений
	enabled логическое значение	изменилось	Включить или выключить регистрацию пакетов, соответствующих правилам ACL. Пример: True
	rate_limit строка	изменилось	Лимит скорости для регистрации пакетов, соответствующих правилам ACL. Пример: неограниченный
log_matches_reject_rule сложное		изменилось	Настройки журнала для правил ACL, настроенных с действием «reject». Пример: хэш/словарь значений
	enabled логическое значение	изменилось	Включить или выключить регистрацию пакетов, соответствующих правилам ACL. Пример: True
	rate_limit строка	изменилось	Лимит скорости для регистрации пакетов, соответствующих правилам ACL. Пример: неограниченный
log_message_fields список / элементы=строка		изменилось	Разделитель строк при использовании log_storage_format типа field-list. Пример: ['acl_policy_name', 'acl_policy_type']
log_publisher строка		изменилось	Имя издателя журнала, используемого для сетевых событий. Пример: /Common/log-publisher
log_storage_format строка		изменилось	Тип формата хранения. Пример: field-list
log_tcp_errors сложное		изменилось	Настройки журнала для регистрации пакетов с ошибками TCP. Пример: хэш/словарь значений
	enabled логическое значение	изменилось	Включить или выключить регистрацию пакетов с ошибками TCP. Пример: True
	rate_limit строка	изменилось	Лимит скорости для регистрации пакетов с ошибками TCP. Пример: неограниченный
log_tcp_events сложное		изменилось	Настройки журнала для регистрации событий TCP на стороне клиента. Пример: хэш/словарь значений
	enabled логическое значение	изменилось	Включить или выключить регистрацию событий TCP на стороне клиента. Пример: True
	rate_limit строка	изменилось	Лимит скорости для регистрации событий TCP на стороне клиента. Пример: неограниченный
log_translation_fields логическое значение		изменилось	Включить или выключить регистрацию переведенных (т.е., на стороне сервера) полей в сопоставлениях ACL и событиях TCP. Пример: True
rate_limit строка		изменилось	Лимит скорости для всех совокупных сообщений журнала сетевого брандмауэра в секунду. Пример: неограниченный

Авторы

Wojciech Wypior (@wojtek0806)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/f5networks/f5_modules/bigip_firewall_log_profile_network_module.html