f5networks.f5_modules.bigip_firewall_policy 模块 – 在 BIG-IP 上管理 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_policy

f5networks.f5_modules 1.0.0 中的新功能

概要

  • 管理 BIG-IP 上的 AFM (Advanced Firewall Manager) 安全防火墙策略。

参数

参数

注释

description

字符串

要附加到策略的描述。

此参数仅在 BIG-IP >= 12.1.0 的版本上受支持。在早期版本上,它将被忽略。

name

字符串 / 必填

要创建的策略的名称。

partition

字符串

要在其上管理资源的设备分区。

默认值: "Common"

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 ← (默认)

rules

列表 / 元素=字符串

指定要与此策略关联的规则列表。此列表的顺序是 BIG-IP 对其进行评估的顺序。如果指定的规则不存在(例如在创建新策略时),将创建这些规则。

此处指定的规则如果不存在,将创建为“默认拒绝”行为。预计在此模块之后,您将跟进这些规则的实际配置。

也可以使用 bigip_firewall_rule 模块来创建和编辑现有和新规则。

state

字符串

statepresent 时,确保策略存在。

stateabsent 时,确保策略被删除。

选择

  • "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: Create a basic policy with some rule stubs
  bigip_firewall_policy:
    name: foo
    rules:
      - rule1
      - rule2
      - rule3
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

返回值

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

描述

description

字符串

策略的新描述。

返回: changed

示例: "My firewall policy"

rules

列表 / 元素=字符串

设备上规则的列表,按照它们被评估的顺序排列。

返回: changed

示例: ["rule1", "rule2", "rule3"]

作者

  • Tim Rupp (@caphrim007)