f5networks.f5_modules.bigip_firewall_log_profile_network 模块 – 配置日志配置文件的网络防火墙相关设置

注意

此模块是 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_network。

f5networks.f5_modules 1.0.0 中的新增功能

概要

• 配置日志配置文件的网络防火墙相关设置。

参数

参数	注释
log_format_delimiter 字符串	当使用 log_storage_format 为 field-list 时，指定分隔符字符串。 创建新配置文件时，如果未指定此参数，则使用默认值 , (逗号字符)。 仅当 log_storage_format 设置为 field-list 时，此选项才有效。否则将被忽略。 根据使用的分隔符，可能需要将分隔符括在引号中，以防止出现 YAML 错误。 特殊字符 $ 保留供内部使用，如果使用则会引发错误。 此参数允许的最大长度为 31 个字符。
log_ip_errors 字典	修改 IP 错误数据包日志记录的日志设置。
enabled 布尔值	此选项启用或禁用 IP 错误数据包的日志记录。 选择 false true
rate_limit 字符串	此选项设置 IP 错误数据包日志记录的速率限制。 仅当启用了此消息类型的日志记录时，此选项才有效。
log_matches_accept_rule 字典	修改配置为“accept”或“accept decisively”操作的 ACL 规则的日志设置。
enabled 布尔值	此选项启用或禁用与配置了“accept”或“accept decisively”操作的 ACL 规则匹配的数据包的日志记录。 选择 false true
rate_limit 字符串	此选项设置与配置了“accept”或“accept decisively”操作的 ACL 规则匹配的数据包的日志记录的速率限制。 仅当启用了此消息类型的日志记录时，此选项才有效。
log_matches_drop_rule 字典	修改配置为 drop 操作的 ACL 规则的日志设置。
enabled 布尔值	此选项启用或禁用与配置了 drop 操作的 ACL 规则匹配的数据包的日志记录。 选择 false true
rate_limit 字符串	此选项设置与配置了 drop 操作的 ACL 规则匹配的数据包的日志记录的速率限制。 仅当启用了此消息类型的日志记录时，此选项才有效。
log_matches_reject_rule 字典	修改配置为 reject 操作的 ACL 规则的日志设置。
enabled 布尔值	此选项启用或禁用与配置了 reject 操作的 ACL 规则匹配的数据包的日志记录。 选择 false true
rate_limit 字符串	此选项设置与配置了 reject 操作的 ACL 规则匹配的数据包的日志记录的速率限制。 仅当启用了此消息类型的日志记录时，此选项才有效。
log_message_fields 列表 / 元素=字符串	指定要记录的一组字段。 仅当 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 字符串	指定用于网络事件的日志发布者的名称。 要在与 AFM 日志配置文件不同的分区上指定 log_publisher，请以完整路径格式指定名称，例如 /Foobar/log-publisher，否则日志发布者的分区将从 partition 模块参数推断。
log_storage_format 字符串	指定存储格式的类型。 创建新日志配置文件时，如果未指定此参数，则默认值为 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 字典	修改 TCP 错误数据包日志记录的日志设置。
enabled 布尔值	此选项启用或禁用 TCP 错误数据包的日志记录。 选择 false true
rate_limit 字符串	此选项设置 TCP 错误数据包日志记录的速率限制。 仅当启用了此消息类型的日志记录时，此选项才有效。
log_tcp_events 字典	修改客户端 TCP 事件日志记录的日志设置。
enabled 布尔值	此选项启用或禁用客户端 TCP 事件的日志记录。 如果启用此选项，则只会记录 TCP 会话的已建立和已关闭状态。 选择 false true
rate_limit 字符串	此选项设置客户端 TCP 事件日志记录的速率限制。 仅当启用了此消息类型的日志记录时，此选项才有效。
log_translation_fields 布尔值	此选项启用或禁用在 ACL 匹配和 TCP 事件中记录转换后的（即服务器端）字段。 转换后的字段包括（但不限于）源地址/端口、目标地址/端口、IP 协议、路由域和 VLAN。 选择 false true
partition 字符串	要在其上创建日志配置文件的设备分区。 此参数也用于指定日志发布者的名称，除非日志发布者名称采用完整路径格式。 默认值： "Common"
profile_name 字符串 / 必选	指定要更新的 AFM（高级防火墙管理器）日志配置文件的名称。
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 ←（默认）
rate_limit 字符串	定义每秒所有组合的网络防火墙日志消息的速率限制。 超过此速率限制后，将不会记录日志消息。 要指定无限速率，请使用值 indefinite。 如果指定数值速率，则该值必须介于 1 和 4294967295 之间。
state 字符串	当 state 为 present 时，确保资源存在。 唯一允许更新网络日志设置的内置配置文件是 global-network，尝试在其他内置配置文件上执行此操作将被忽略。 当 state 为 absent 时，确保删除该资源。 对于 global-network 日志配置文件，将忽略 absent 状态。 选择 "present" ←（默认） "absent"

注释

注意

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

返回值

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

Key	描述
log_format_delimiter 字符串	当使用 field-list 的 log_storage_format 时，分隔符字符串。 返回： changed 示例： "."
log_ip_errors complex	用于记录 IP 错误数据包的日志设置。 返回： changed 示例： "值的哈希/字典"
enabled 布尔值	启用或禁用 IP 错误数据包的日志记录。 返回： changed 示例： true
rate_limit 字符串	IP 错误数据包日志记录的速率限制。 返回： changed 示例： "indefinite"
log_matches_accept_rule complex	为配置了“accept”或“accept decisively”操作的 ACL 规则的日志设置。 返回： changed 示例： "值的哈希/字典"
enabled 布尔值	启用或禁用匹配 ACL 规则的数据包的日志记录。 返回： changed 示例： true
rate_limit 字符串	匹配 ACL 规则的数据包的日志记录的速率限制。 返回： changed 示例： "indefinite"
log_matches_drop_rule complex	为配置了 drop 操作的 ACL 规则的日志设置。 返回： changed 示例： "值的哈希/字典"
enabled 布尔值	启用或禁用匹配 ACL 规则的数据包的日志记录。 返回： changed 示例： true
rate_limit 字符串	匹配 ACL 规则的数据包的日志记录的速率限制。 返回： changed 示例： "indefinite"
log_matches_reject_rule complex	为配置了 reject 操作的 ACL 规则的日志设置。 返回： changed 示例： "值的哈希/字典"
enabled 布尔值	启用或禁用匹配 ACL 规则的数据包的日志记录。 返回： changed 示例： true
rate_limit 字符串	匹配 ACL 规则的数据包的日志记录的速率限制。 返回： changed 示例： "indefinite"
log_message_fields 列表 / 元素=字符串	当使用 field-list 的 log_storage_format 时，分隔符字符串。 返回： changed 示例： ["acl_policy_name", "acl_policy_type"]
log_publisher 字符串	用于网络事件的日志发布者的名称。 返回： changed 示例： "/Common/log-publisher"
log_storage_format 字符串	存储格式的类型。 返回： changed 示例： "field-list"
log_tcp_errors complex	用于记录 TCP 错误数据包的日志设置。 返回： changed 示例： "值的哈希/字典"
enabled 布尔值	启用或禁用 TCP 错误数据包的日志记录。 返回： changed 示例： true
rate_limit 字符串	TCP 错误数据包日志记录的速率限制。 返回： changed 示例： "indefinite"
log_tcp_events complex	用于记录客户端 TCP 事件的日志设置。 返回： changed 示例： "值的哈希/字典"
enabled 布尔值	启用或禁用客户端 TCP 事件的日志记录。 返回： changed 示例： true
rate_limit 字符串	客户端 TCP 事件的日志记录的速率限制。 返回： changed 示例： "indefinite"
log_translation_fields 布尔值	启用或禁用在 ACL 匹配和 TCP 事件中记录转换后的（即服务器端）字段。 返回： changed 示例： true
rate_limit 字符串	每秒所有组合的网络防火墙日志消息的速率限制。 返回： changed 示例： "indefinite"

作者

• Wojciech Wypior (@wojtek0806)

合集链接

• 问题跟踪器
• 主页
• 存储库（来源）