f5networks.f5_modules.bigip_firewall_log_profile 模块 – 管理系统中配置的 AFM 日志配置文件

注意

此模块是 f5networks.f5_modules 集合（版本 1.32.1）的一部分。

如果您使用的是 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install f5networks.f5_modules。

要在 playbook 中使用它，请指定：f5networks.f5_modules.bigip_firewall_log_profile。

f5networks.f5_modules 1.0.0 中的新增功能

概要

• 管理系统中配置的 AFM（高级防火墙管理器）日志配置文件以及每个配置文件的基本信息。

参数

参数	注释
description 字符串	日志配置文件的描述。
dos_protection 字典	配置日志配置文件的 DoS 相关设置。
dns_publisher 字符串	指定用于 DNS DoS 事件的日志发布者的名称。 要在与 AFM 日志配置文件不同的分区上指定 log_publisher，请以完整路径格式指定名称，例如 /Foobar/log-publisher，否则日志发布者的分区将从 partition 模块参数推断。
network_publisher 字符串	指定用于 DoS 网络事件的日志发布者的名称。 要在与 AFM 日志配置文件不同的分区上指定 log_publisher，请以完整路径格式指定名称，例如 /Foobar/log-publisher，否则日志发布者的分区将从 partition 模块参数推断。
sip_publisher 字符串	指定用于 SIP DoS 事件的日志发布者的名称。 要在与 AFM 日志配置文件不同的分区上指定 log_publisher，请以完整路径格式指定名称，例如 /Foobar/log-publisher，否则日志发布者的分区将从 partition 模块参数推断。
ip_intelligence 字典	配置日志配置文件的 IP 情报相关设置。
log_publisher 字符串	指定用于 IP 情报事件的日志发布者的名称。 要在与 AFM 日志配置文件不同的分区上指定 log_publisher，请以完整路径格式指定名称，例如 /Foobar/log-publisher，否则日志发布者的分区将从 partition 模块参数推断。
log_rtbh 布尔值	当 true 时，指定记录远程触发的黑洞事件。 选项 false true
log_shun 布尔值	当 true 时，指定记录 IP 情报回避列表事件。 此选项只能在 global-network 内置配置文件上设置。 选项 false true
log_translation_fields 布尔值	此选项用于启用或禁用 IP 情报日志消息中已转换（即服务器端）字段的日志记录。 转换后的字段包括（但不限于）源地址/端口、目标地址/端口、IP 协议、路由域和 VLAN。 选项 false true
rate_limit 字符串	定义每秒所有组合的 IP 情报日志消息的速率限制。超过此速率限制后，将不再记录日志消息，直到阈值降至指定速率以下。 要指定无限速率，请使用值 indefinite。 如果指定数值速率，则该值必须介于 1 和 4294967295 之间。
name 字符串 / 必需	指定日志配置文件的名称。
partition 字符串	要在其上创建日志配置文件的设备分区。 当指定日志发布者的名称时也使用此参数，除非日志发布者名称采用完整路径格式。 默认值： "Common"
port_misuse 字典	端口滥用日志配置。
log_publisher 字符串	指定用于端口滥用事件的日志发布者的名称。 要在与 AFM 日志配置文件不同的分区上指定 log_publisher，请以完整路径格式指定名称，例如 /Foobar/log-publisher，否则日志发布者的分区将从 partition 模块参数推断。
rate_limit 字符串	定义每秒所有组合的端口滥用日志消息的速率限制。超过此速率限制后，将不再记录日志消息，直到阈值降至指定速率以下。 要指定无限速率，请使用值 indefinite。 如果指定数值速率，则该值必须介于 1 和 4294967295 之间。
provider 字典 在 f5networks.f5_modules 1.0.0 中添加	包含连接详细信息的字典对象。
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 ← (默认)
状态 (state) 字符串	当 state 为 present 时，确保资源存在。 当 state 为 absent 时，确保资源被删除。尝试删除内置系统配置文件将被忽略，并且不返回任何更改。 选项 "present" ← (默认) "absent"

备注

注意

• 有关使用 Ansible 管理 F5 网络设备的更多信息，请参阅 https://ansible.org.cn/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

返回值

通用返回值记录在此处，以下是此模块特有的字段

键 (Key)	描述
description 字符串	AFM 日志配置文件的新描述。 返回: changed 示例: "这是我的描述"
dos_protection 复杂 (complex)	日志配置文件中 DoS 相关设置中使用的日志发布者。 返回: changed 示例: "值的哈希/字典"
dns_publisher 字符串	用于 DNS DoS 事件的日志发布者的名称。 返回: changed 示例: "/Common/local-db-publisher"
network_publisher 字符串	用于 DoS 网络事件的日志发布者的名称。 返回: changed 示例: "/Common/local-db-publisher"
sip_publisher 字符串	用于 SIP DoS 事件的日志发布者的名称。 返回: changed 示例: "/Common/local-db-publisher"
ip_intelligence 复杂 (complex)	日志配置文件的 IP 情报相关设置。 返回: changed 示例: "值的哈希/字典"
log_publisher 字符串	用于 IP 情报事件的日志发布者的名称。 返回: changed 示例: "/Common/local-db-publisher"
log_rtbh 布尔值	远程触发黑洞事件的日志记录。 返回: changed 示例: true
log_shun 布尔值	IP 情报回避列表事件的日志记录。 返回: changed 示例: false
log_translation_fields 布尔值	IP 情报日志消息中转换字段的日志记录。 返回: changed 示例: false
rate_limit 字符串	每秒所有组合的 IP 情报日志消息的速率限制。 返回: changed 示例: "无限期"
port_misuse 复杂 (complex)	日志配置文件的端口滥用相关设置。 返回: changed 示例: "值的哈希/字典"
log_publisher 字符串	用于端口滥用事件的日志发布者的名称。 返回: changed 示例: "/Common/local-db-publisher"
rate_limit 字符串	每秒所有组合的端口滥用日志消息的速率限制。 返回: changed 示例: "无限期"

作者 (Authors)

• Wojciech Wypior (@wojtek0806)

集合链接 (Collection links)

• 问题追踪器 (Issue Tracker)
• 主页 (Homepage)
• 存储库（源代码）(Repository (Sources))