f5networks.f5_modules.bigip_policy 模块 – 管理 BIG-IP 上的通用策略配置

注意

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

f5networks.f5_modules 1.0.0 中的新增功能

概要

• 管理 BIG-IP 上的通用策略配置。此模块最好与 bigip_policy_rule 模块结合使用。此模块可以处理通用配置，例如设置策略的草稿状态、描述以及与策略规则本身无关的项目。它也是创建规则时应使用的第一个模块，因为 bigip_policy_rule 模块需要 policy 参数。

参数

参数	注释
description 字符串	要附加到策略的描述。 此参数仅在 BIG-IP >= 12.1.0 的版本上受支持。在早期版本上，它会被忽略。
name 字符串 / 必需	要创建的策略的名称。
partition 字符串	要在其上管理资源的设备分区。 默认值： "Common"
provider 字典 在 f5networks.f5_modules 1.0.0 中添加	一个包含连接详细信息的 dict 对象。
auth_provider 字符串	配置 auth 提供程序以从远程设备获取身份验证令牌。 此选项在处理 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 评估它们的顺序。如果指定的规则不存在（例如在创建新策略时），将创建它们。 默认规则的 conditions 为 all。 默认规则的 actions 为 ignore。 bigip_policy_rule 模块可用于创建和编辑现有和新规则。
state 字符串	当 state 为 present 时，确保策略存在且已发布。当 state 为 absent 时，确保策略被删除，即使它当前是草稿状态。 当 state 为 draft 时，确保策略存在且已起草。修改规则时，必须首先将策略置于草稿状态。 仅在 BIG-IP >= 12.1.0 的版本上支持起草。在此之前的版本中，指定 state 为 draft 将引发错误。 选项 "present" ←（默认） "absent" "draft"
strategy 字符串	指定当有多个匹配规则时，确定执行哪些操作的方法。创建新策略时，默认值为 first。 此模块不允许您指定要使用的 best 策略。它将选择系统默认策略 (/Common/best-match)。 选项 "first"（第一个） "all"（全部） "best"（最佳）

备注

注意

• 有关使用 Ansible 管理 F5 Networks 设备的更多信息，请参阅 https://ansible.org.cn/integrations/networks/f5。

• 需要 BIG-IP 软件版本 >= 12。

• F5 模块仅操作 F5 产品的运行配置。为了确保 BIG-IP 的特定配置持久保存到磁盘，请务必至少包含一个使用 f5networks.f5_modules.bigip_config 模块保存运行配置的任务。有关正确使用该模块保存运行配置的信息，请参阅该模块的文档。

示例

- name: Create policy which is immediately published
  bigip_policy:
    name: Policy-Foo
    state: present
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Add a rule to the new policy - Immediately published
  bigip_policy_rule:
    policy: Policy-Foo
    name: ABC
    conditions:
      - type: http_uri
        path_starts_with:
          - /ABC
          - foo
          - bar
        path_ends_with:
          - baz
    actions:
      - forward: true
        select: true
        pool: pool-svrs
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Add multiple rules to the new policy - Added in the order they are specified
  bigip_policy_rule:
    policy: Policy-Foo
    name: "{{ item.name }}"
    conditions: "{{ item.conditions }}"
    actions: "{{ item.actions }}"
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost
  loop:
    - name: rule1
      actions:
        - type: forward
          pool: pool-svrs
      conditions:
        - type: http_uri
          path_starts_with: /euro
    - name: HomePage
      actions:
        - type: forward
          pool: pool-svrs
      conditions:
        - type: http_uri
          path_starts_with: /HomePage/

- name: Create policy specify default rules - Immediately published
  bigip_policy:
    name: Policy-Bar
    state: present
    rules:
      - rule1
      - rule2
      - rule3
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Create policy specify default rules - Left in a draft
  bigip_policy:
    name: Policy-Baz
    state: draft
    rules:
      - rule1
      - rule2
      - rule3
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

返回值

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

键	描述
description 字符串	策略的新描述。 此值仅针对 BIG-IP 设备 >= 12.1.0 返回。 返回值： changed 和 success 示例： "这是我的描述"
rules 列表 / 元素=字符串	应用于策略的规则及其顺序的列表。 返回值： changed 和 success 示例： ["/Common/rule1", "/Common/rule2"]
strategy 整数	在策略上设置的新策略。 返回值： changed 和 success 示例： "first-match"

作者

• Tim Rupp (@caphrim007)

• Wojciech Wypior (@wojtek0806)

集合链接

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