f5networks.f5_modules.bigip_service_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_service_policy

f5networks.f5_modules 1.0.0 中的新增功能

概要

  • 服务策略允许您基于每个规则或每个上下文配置计时器和端口滥用规则(如果已启用)。

参数

参数

注释

description

字符串

服务策略的描述。

name

字符串 / 必需

服务策略的名称。

partition

字符串

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

默认值: "Common"

port_misuse_policy

字符串

要附加到服务策略的端口滥用策略。

需要启用 afm(高级防火墙管理器)才能使用。如果未启用 afm,则忽略此参数。

provider

字典

f5networks.f5_modules 1.0.0 中新增

包含连接详细信息的字典对象。

auth_provider

字符串

配置 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

字符串

资源是否存在。

选项

  • "present" ← (默认)

  • "absent"

timer_policy

字符串

要附加到服务策略的计时器策略。

注释

注意

  • 有关使用 Ansible 管理 F5 网络设备的更多信息,请参见 https://ansible.org.cn/integrations/networks/f5

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

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

示例

- name: Create a service policy
  bigip_service_policy:
    name: foo
    timer_policy: timer1
    port_misuse_policy: misuse1
    timer_policy_enabled: true
    port_misuse_policy_enabled: true
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

返回值

常见的返回值已在此处 记录,以下是此模块特有的字段

描述

description

字符串

资源的新描述。

返回:changed

示例: "My service policy description"

port_misuse_policy

字符串

附加到资源的新端口滥用策略。

返回:changed

示例: "/Common/misuse1"

timer_policy

字符串

附加到资源的新计时器策略。

返回:changed

示例: "/Common/timer1"

作者

  • Tim Rupp (@caphrim007)

  • Wojciech Wypior (@wojtek0806)