f5networks.f5_modules.bigip_policy_rule 模块 – 在 BIG-IP 上管理 LTM 策略规则

注意

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

f5networks.f5_modules 1.0.0 中的新增功能

概要

• 此模块管理 BIG-IP 上的 LTM 策略规则。

要求

在执行此模块的主机上需要以下要求。

• BIG-IP >= v12.1.0

参数

参数	注释
actions list / elements=dictionary	您希望策略规则执行的操作。 可用属性因操作而异，但是，每个操作都要求您指定一个 type。 这些条件可以按任何顺序指定。尽管它们在列表中，但列表中的顺序对 BIG-IP 来说并不重要。
asm_policy string	要启用的 ASM 策略。 此参数仅在 enable 类型有效。
cookie_expiry integer 在 f5networks.f5_modules 1.1.0 中添加	可选参数，指定会话保持的时间。 此参数仅在 persist 类型有效。
cookie_insert string 在 f5networks.f5_modules 1.1.0 中添加	您希望在其中持久化的 Cookie 名称。 此参数仅在 persist 类型有效。
disable_target string 在 f5networks.f5_modules 1.8.0 中添加	您要禁用的目标。 此参数仅在 disable 类型有效。 选择 "server_ssl" "persist" "asm"
event string	可以触发操作（如重置和转发）的事件。 使用 set_variable 操作时，它用于指定操作事件，例如请求或响应。 对于 forward 操作类型，有效的事件选择是：client_accepted、proxy_request request、ssl_client_hello 和 ssl_client_server_hello_send。 对于 reset 操作类型，有效的事件选择是：client_accepted、proxy_connect proxy_request、proxy_response、request、response、server_connected、ssl_client_hello、ssl_client_server_hello_send、ssl_server_handshake、ssl_server_hello、websocket_request、websocket_response。 对于 disable 操作类型，有效的事件选择是：client_accepted、proxy_connect proxy_request、proxy_response、request、server_connected。
expression string	与 set_variable 操作一起使用的 Tcl 表达式。
http_connect dictionary 在 f5networks.f5_modules 1.8.0 中添加	您要替换的 HTTP Connect 标头。 此参数仅在 replace 类型有效。
event string / required	替换 http_connect 标头时发生的事件类型。 选择 "client_accepted" "proxy_connect" "proxy_request" "proxy_response" "request" "server_connected" "ssl_client_hello"
port integer	端口号。 如果未提供端口号，则默认值设置为 0。 定义规则时要明确，以便系统不会覆盖端口值。
value string / required	http_connect 的值。
http_cookie dictionary 在 f5networks.f5_modules 1.8.0 中添加	您要删除或插入的 HTTP Cookie 标头。 此参数仅在 remove 和 insert 类型有效。
event string / required	删除或插入 http_cookie 时发生的事件类型。 选择 "request" "proxy_connect" "proxy_request"
name string / required	http_cookie 的名称。
value string	http_cookie 的值。 这是使用 insert 类型操作配置时的强制性参数。
http_header dictionary 在 f5networks.f5_modules 1.8.0 中添加	您要删除或插入的 HTTP 标头。 此参数仅在 remove、insert 和 replace 类型有效。
event string / required	删除、替换或插入 http_header 时发生的事件类型。 request 和 response 事件仅在 remove 和 insert 类型时可用。 所有事件都适用于 replace 类型操作。 选择 "request" "response" "proxy_connect" "proxy_request" "proxy_response"
name string / required	http_header 的名称。
value string	http_header 的值。 配置为 insert 或 replace 类型时，此参数为必填。
http_host dictionary 在 f5networks.f5_modules 1.8.0 中添加	您想要替换的 HTTP Host 标头。 此参数仅在 replace 类型有效。
event string / required	替换 http_host 时触发的事件类型。 选择 "request" "proxy_connect" "proxy_request"
value string / required	http_host 的值。
http_referer dictionary 在 f5networks.f5_modules 1.8.0 中添加	您想要删除、替换或插入的 HTTP Referer 标头。 此参数仅在 remove、insert 和 replace 类型有效。
event string / required	删除、替换或插入 c(http_referer) 时触发的事件类型。 选择 "request" "proxy_connect" "proxy_request"
value string	http_referer 的值。 这是使用 insert 类型操作配置时的强制性参数。 对于 remove 类型，此参数将被忽略。 对于 replace 类型，此参数为可选。
http_set_cookie dictionary 在 f5networks.f5_modules 1.8.0 中添加	您想要删除或插入的 HTTP Set-Cookie 标头。 此参数仅在 remove 或 c(insert) 类型时有效。
name string / required	http_set_cookie 的名称。
value string	http_set_cookie 的值。 这是使用 insert 类型操作配置时的强制性参数。
http_uri dictionary 在 f5networks.f5_modules 1.8.0 中添加	替换 HTTP URI、路径或字符串。 此参数仅在 replace 类型有效。
event string / required	替换 http_uri 时触发的事件类型。 选择 "request" "proxy_connect" "proxy_request"
type string / required	指定要替换的 http_uri 部分。 选择 "path" "query_string" "full_string"
value string / required	http_uri 的值。
location string	发送重定向响应的新 URL。 此字段可以使用 Tcl 命令替换。
node string 在 f5networks.f5_modules 1.2.0 中添加	您想要将流量转发到的节点。 此参数仅在 forward 类型时有效。
pool string	您想要将流量转发到的池。 此参数仅在 forward 类型时有效。
type string / required	操作类型。此值控制以下哪些选项是必需的。 当 type 为 forward 时，系统将给定的 pool、virtual 或 node 与此规则关联。 当 type 为 enable 时，系统将给定的 asm_policy 与此规则关联。 当 type 为 ignore 时，系统将从此规则中删除所有现有操作。 当 type 为 redirect 时，系统会将 HTTP 请求重定向到不同的 URL。 当 type 为 reset 时，系统会在 event 上重置连接。 当 type 为 persist 时，系统会将 cookie_insert 和 cookie_expiry 与此规则关联。 当 type 为 set_variable 时，系统会根据基于 event 评估的 Tcl expression 设置一个变量。 当 type 为 remove 时，系统将使用此规则删除 http_set_cookie、http_referer、http_header 或 http_cookie。 当 type 为 insert 时，系统将使用此规则插入 http_set_cookie、http_referer、http_header 或 http_cookie。 当 type 为 replace 时，系统将使用此规则替换 http_connect、http_referer、http_header、http_uri 或 http_host。 当 type 为 disable 时，系统将禁用此规则的 disable_target。 选择 "forward" "enable" "ignore" "redirect" "reset" "persist" "set_variable" "remove" "insert" "replace" "disable"
variable_name string	与 set_variable 操作一起使用的变量名。
virtual string	您想要将流量转发到的虚拟服务器。 此参数仅在 forward 类型时有效。
conditions list / elements=dictionary	描述条件的属性列表。 有关如何构造每个列表条目的详细信息，请参阅子选项。 此列表的顺序很重要，模块在修改任务时会确保顺序保持不变。 并非所有条件类型都需要以下子选项，请阅读描述以获取更多详细信息。 这些条件可以按任何顺序指定。尽管它们在列表中，但列表中的顺序对 BIG-IP 来说并不重要。
address_matches_with_any list / elements=string 在 f5networks.f5_modules 1.8.0 中添加	IP 地址应匹配的 IP 子网地址字符串列表。 此参数仅在 tcp 类型时有效。
address_matches_with_datagroup list / elements=string 在 f5networks.f5_modules 1.8.0 中添加	IP 地址应匹配的内部数据组字符串列表。 此参数仅在 tcp 类型时有效。
address_matches_with_external_datagroup list / elements=string 在 f5networks.f5_modules 1.10.0 中添加	IP 地址应匹配的外部数据组字符串列表。 此参数仅在 tcp 类型时有效。
event string	可以触发条件类型匹配规则的事件。 仅支持 http_header、http_method、ssl_extension 和 tcp。 http_header 条件类型的有效选择为：proxy_connect、proxy_request、proxy_response、request 和 response。 http_method 条件类型的有效选择为：proxy_connect、proxy_request、proxy_response、request 和 response。 tcp 条件类型的有效选择为：request、client_accepted、proxy_connect、proxy_request、proxy_response、ssl_client_hello 和 ssl_client_server_hello_send。 ssl_extension 的有效选择为：ssl_client_hello 和 ssl_client_server_hello_send。
header_is_any list / elements=string 在 f5networks.f5_modules 1.8.0 中添加	HTTP 标头值应匹配的字符串列表。 此参数仅在 http_header 类型时有效。
header_name string 在 f5networks.f5_modules 1.8.0 中添加	http_header 的名称。 此参数仅在 http_header 类型时有效。
host_begins_not_with_any list / elements=string 在 f5networks.f5_modules 1.22.0 中添加	HTTP Host 不应以之开头的字符串列表。 此参数仅在 http_host 类型时有效。
host_begins_with_any list / elements=string	HTTP Host 应以之开头的字符串列表。 此参数仅在 http_host 类型时有效。
host_contains list / elements=string 在 f5networks.f5_modules 1.23.0 中添加	HTTP Host 应包含的字符串列表。 此参数仅在 http_host 类型时有效。
host_ends_not_with_any list / elements=string 在 f5networks.f5_modules 1.22.0 中添加	HTTP Host 不应以之开头的字符串列表。 此参数仅在 http_host 类型时有效。
host_ends_with_any list / elements=string 在 f5networks.f5_modules 1.8.0 中添加	HTTP Host 应以之结尾的字符串列表。 此参数仅在 http_host 类型时有效。
host_is_any list / elements=string	HTTP Host 应匹配的字符串列表。 此参数仅在 http_host 类型时有效。
host_is_not_any list / elements=string	HTTP Host 不应匹配的字符串列表。 此参数仅在 http_host 类型时有效。
method_matches_with_any list / elements=string 在 f5networks.f5_modules 1.10.0 中添加	HTTP 方法值应匹配的字符串列表。 此参数仅在 http_method 类型时有效。
path_begins_with_any list / elements=string	HTTP URI 应以之开头的字符串列表。 此参数仅在 http_uri 类型时有效。
path_contains list / elements=string 在 f5networks.f5_modules 1.8.0 中添加	HTTP URI 应包含的字符串列表。 此参数仅在 http_uri 类型时有效。
path_is_any list / elements=string 在 f5networks.f5_modules 1.8.0 中添加	HTTP URI 应匹配的字符串列表。 此参数仅在 http_uri 类型时有效。
server_name_begins_not_with_any list / elements=string 在 f5networks.f5_modules 1.27.0 中添加	服务器名称不应以之开头的名称列表。 此参数仅在 ssl_extension 类型时有效。
server_name_begins_with_any list / elements=string 在 f5networks.f5_modules 1.27.0 中添加	服务器名称应以其开头的名称列表。 此参数仅在 ssl_extension 类型时有效。
server_name_contains list / elements=string 在 f5networks.f5_modules 1.27.0 中添加	服务器名称应包含的名称列表。 此参数仅在 ssl_extension 类型时有效。
server_name_ends_not_with_any list / elements=string 在 f5networks.f5_modules 1.27.0 中添加	服务器名称不应以其结尾的名称列表。 此参数仅在 ssl_extension 类型时有效。
server_name_ends_with_any list / elements=string 在 f5networks.f5_modules 1.27.0 中添加	服务器名称应以其结尾的名称列表。 此参数仅在 ssl_extension 类型时有效。
server_name_is_any list / elements=string	包含服务器名称的名称列表。 此参数仅在 ssl_extension 类型时有效。
server_name_is_not_any list / elements=string 在 f5networks.f5_modules 1.27.0 中添加	不包含服务器名称的名称列表。 此参数仅在 ssl_extension 类型时有效。
type string / required	条件类型。此值控制需要以下哪些选项。 当 type 为 http_uri 时，有效选项为：path_begins_with_any、 path_contains 或 path_is_any。 当 type 为 http_host 时，有效选项为：host_is_any、host_is_not_any、host_contains、 host_begins_with_any、host_begins_not_with_any、host_ends_with_any 或 host_ends_not_with_any 当 type 为 http_header 时，header_name 参数是强制性的，并且有效选项为：header_is_any。 当 type 为 http_method 时，有效选项为：method_matches_with_any。 当 type 为 all_traffic 时，系统将从此规则中删除所有现有条件。 选择 "http_uri" "all_traffic" "http_host" "http_header" "http_method" "ssl_extension" "tcp"
description string	策略规则的描述。
name string / required	规则的名称。
partition string	要在其上管理资源的设备分区。 默认值： "Common"
policy string / required	要将此规则关联到的策略的名称。
provider dictionary 在 f5networks.f5_modules 1.0.0 中添加	包含连接详细信息的 dict 对象。
auth_provider string	配置身份验证提供程序以从远程设备获取身份验证令牌。 此选项实际上在处理 BIG-IQ 设备时使用。
no_f5_teem boolean	如果为 yes，则不会将 TEEM 遥测数据发送到 F5。 您可以通过设置环境变量 F5_TELEMETRY_OFF 来省略此选项。 先前使用的变量 F5_TEEM 已弃用，因为它的名称容易混淆。 选择 false ← (默认) true
password 别名：pass, pwd string / required	用于连接到 BIG-IP 或 BIG-IQ 的用户帐户的密码。 您可以通过设置环境变量 F5_PASSWORD 来省略此选项。
server string / required	BIG-IP 主机或 BIG-IQ 主机。 您可以通过设置环境变量 F5_SERVER 来省略此选项。
server_port integer	BIG-IP 服务器端口。 您可以通过设置环境变量 F5_SERVER_PORT 来省略此选项。 默认值： 443
timeout integer	指定与网络设备通信以进行连接或发送命令的超时时间（以秒为单位）。如果在操作完成之前超时，则模块将出错。
transport string	配置连接到远程设备时要使用的传输连接。 选择 "rest" ← (默认)
user string / required	用于连接到 BIG-IP 或 BIG-IQ 的用户名。此用户必须在设备上具有管理权限。 您可以通过设置环境变量 F5_USER 来省略此选项。
validate_certs boolean	如果为 no，则不验证 SSL 证书。仅在个人控制的站点上使用自签名证书时才使用此选项。 您可以通过设置环境变量 F5_VALIDATE_CERTS 来省略此选项。 选择 false true ← (默认)
replace_with boolean	指定用户给定的 conditions/actions 是否应覆盖设备上已存在的内容。 当需要删除 conditions/actions 的子集时，此选项很有用。此选项类似于 TMSH 命令中可用的 replace-all-with 标志。 使用此选项不是幂等的。 选择 false ← (默认) true
rule_order integer 在 f5networks.f5_modules 1.10.0 中添加	指定一个数字，指示此规则相对于策略中其他规则的顺序。 如果未设置，设备会将参数设置为 0。 如果存在具有相同规则顺序编号的规则，则设备将使用规则名称来确定规则的排序方式。 数字越小，规则在一般顺序中的位置越低，最小数字 0 为最上面的规则。 有效值的范围介于 0 到 4294967295 之间（包括 0 和 4294967295）。
state string	当为 present 时，确保将密钥上传到设备。当为 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: Create policies
  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
  bigip_policy_rule:
    policy: Policy-Foo
    name: rule3
    conditions:
      - type: http_uri
        path_begins_with_any:
          - /ABC
    actions:
      - type: forward
        pool: pool-svrs
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Add multiple rules to the new policy
  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_begins_with_any:
            - /euro
    - name: rule2
      actions:
        - type: forward
          pool: pool-svrs
      conditions:
        - type: http_uri
          path_begins_with_any:
            - /HomePage/
    - name: rule3
      actions:
        - type: set_variable
          variable_name: user-agent
          expression: tcl:[HTTP::header User-Agent]
          event: request
      conditions:
        - type: http_uri
          path_begins_with_any:
            - /HomePage/

- name: Remove all rules and conditions from the rule
  bigip_policy_rule:
    policy: Policy-Foo
    name: rule1
    conditions:
      - type: all_traffic
    actions:
      - type: ignore
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

返回值

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

Key	描述
actions complex	应用于规则的新操作列表。 返回： changed 示例： "hash/dictionary of values"
pool string	用于转发的池。 返回： changed 示例： "foo-pool"
type string	操作类型。 返回： changed 示例： "forward"
conditions complex	应用于规则的新条件列表。 返回： changed 示例： "hash/dictionary of values"
path_begins_with_any list / elements=string	URI 以其开头的字符串列表。 返回： changed 示例： ["foo", "bar"]
type string	条件类型。 返回： changed 示例： "http_uri"
description string	规则的新描述。 返回： changed 示例： "My rule"
rule_order integer	指定一个数字，指示此规则相对于策略中其他规则的顺序。 返回： changed 示例： 10

作者

• Tim Rupp (@caphrim007)

• Wojciech Wypior (@wojtek0806)

集合链接

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