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

Примечание

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

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

Для использования в playbook, укажите: f5networks.f5_modules.bigip_firewall_log_profile

Добавлено в версии 1.0.0: модуля f5networks.f5_modules

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
description строка			Описание профиля ведения журнала.
dos_protection словарь			Настройка параметров профиля ведения журнала, связанных с DoS.
	dns_publisher строка		Указывает имя издателя журнала, используемого для событий DNS DoS. Чтобы указать издателя журнала на другом разделе, отличном от профиля ведения журнала AFM, укажите имя в формате полного пути, например `/Foobar/log-publisher`, в противном случае раздел для издателя журнала определяется из параметра модуля `partition`
	network_publisher строка		Указывает имя издателя журнала, используемого для сетевых событий DoS. Чтобы указать издателя журнала на другом разделе, отличном от профиля ведения журнала AFM, укажите имя в формате полного пути, например `/Foobar/log-publisher`, в противном случае раздел для издателя журнала определяется из параметра модуля `partition`
	sip_publisher строка		Указывает имя издателя журнала, используемого для событий SIP DoS. Чтобы указать издателя журнала на другом разделе, отличном от профиля ведения журнала AFM, укажите имя в формате полного пути, например `/Foobar/log-publisher`, в противном случае раздел для издателя журнала определяется из параметра модуля `partition`
ip_intelligence словарь			Настройка параметров профиля ведения журнала, связанных с IP Intelligence.
	log_publisher строка		Указывает имя издателя журнала, используемого для событий IP Intelligence. Чтобы указать издателя журнала на другом разделе, отличном от профиля ведения журнала AFM, укажите имя в формате полного пути, например `/Foobar/log-publisher`, в противном случае раздел для издателя журнала определяется из параметра модуля `partition`
	log_rtbh булево	Варианты: no yes	Если `yes`, указывает, что события удалённого запуска черных дыр регистрируются.
	log_shun булево	Варианты: no yes	Если `yes`, указывает, что события списков IP Intelligence shun регистрируются. Этот параметр может быть установлен только для встроенного профиля `global-network`
	log_translation_fields булево	Варианты: no yes	Этот параметр используется для включения или отключения регистрации переведенных (т.е. на стороне сервера) полей в сообщениях журнала IP Intelligence. Переведенные поля включают (но не ограничиваются) исходный адрес/порт, адрес/порт назначения, IP-протокол, домен маршрута и VLAN.
	rate_limit строка		Определяет лимит скорости для всех комбинированных сообщений журнала IP Intelligence в секунду. При превышении этого лимита сообщения журнала не регистрируются, пока порог не опустится ниже указанной скорости. Для указания неограниченной скорости используйте значение `indefinite` Если указана числовая скорость, значение должно быть между `1` и `4294967295`
name строка / обязательно			Указывает имя профиля ведения журнала.
partition строка		Значение по умолчанию: "Общие"	Раздел устройства для создания профиля ведения журнала. Параметр также используется при указании имён издателей журналов, если имена издателей журналов не находятся в формате полного пути.
port_misuse словарь			Настройка ведения журнала ошибок использования портов.
	log_publisher строка		Указывает имя издателя журнала, используемого для событий ошибок использования портов. Чтобы указать издателя журнала на другом разделе, отличном от профиля ведения журнала AFM, укажите имя в формате полного пути, например `/Foobar/log-publisher`, в противном случае раздел для издателя журнала определяется из параметра модуля `partition`
	rate_limit строка		Определяет лимит скорости для всех комбинированных сообщений журнала ошибок использования портов в секунду. При превышении этого лимита сообщения журнала не регистрируются, пока порог не опустится ниже указанной скорости. Для указания неограниченной скорости используйте значение `indefinite` Если указана числовая скорость, значение должно быть между `1` и `4294967295`
provider словарь добавлено в версии 1.0.0 f5networks.f5_modules			Объект словаря, содержащий сведения о подключении.
	auth_provider строка		Настраивает поставщик аутентификации для получения маркеров аутентификации с удалённого устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ.
	no_f5_teem булево	Варианты: no yes	Если `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 ←	Настраивает транспортное подключение для использования при подключении к удалённому устройству.
	user строка / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`
	validate_certs булево	Варианты: no yes ←	Если `no`, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самозаверенными сертификатами. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`
state строка		Варианты: present ← absent	Когда `state` является `present`, гарантирует, что ресурс существует. Когда `state` является `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: yes
      log_rtbh: yes
      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 строка		changed	Новое описание профиля логов AFM. Пример: Это моё описание
dos_protection сложное		changed	Используемые издатели логов в настройках профиля логов, связанных с DoS. Пример: хеш/словарь значений
	dns_publisher строка	changed	Имя издателя логов, используемого для событий DoS DNS. Пример: /Common/local-db-publisher
	network_publisher строка	changed	Имя издателя логов, используемого для сетевых событий DoS. Пример: /Common/local-db-publisher
	sip_publisher строка	changed	Имя издателя логов, используемого для событий DoS SIP. Пример: /Common/local-db-publisher
ip_intelligence сложное		changed	Настройки профиля логов, связанные с IP Intelligence. Пример: хеш/словарь значений
	log_publisher строка	changed	Имя издателя логов, используемого для событий IP Intelligence. Пример: /Common/local-db-publisher
	log_rtbh булево	changed	Ведение журнала событий удалённого запуска блокировки. Пример: True
	log_shun булево	changed	Ведение журнала событий списка отключения IP Intelligence.
	log_translation_fields булево	changed	Ведение журнала переведённых полей в сообщениях журнала IP Intelligence.
	rate_limit строка	changed	Предел скорости для всех объединённых сообщений журнала IP intelligence в секунду. Пример: неограничено
port_misuse сложное		changed	Настройки профиля логов, связанные с некорректным использованием портов. Пример: хеш/словарь значений
	log_publisher строка	changed	Имя издателя логов, используемого для событий некорректного использования портов. Пример: /Common/local-db-publisher
	rate_limit строка	changed	Предел скорости для всех объединённых сообщений журнала о некорректном использовании портов в секунду. Пример: неограничено

Авторы

Wojciech Wypior (@wojtek0806)

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