f5networks.f5_modules.bigip_irule 模块 – 在 BIG-IP 上管理跨不同模块的 iRule

注意

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

f5networks.f5_modules 1.0.0 中的新增功能

概要 

管理 BIG-IP 设备上不同模块的 iRule。

参数 

参数	注释
content 字符串	如果不用 src，则将 iRule 的内容直接设置为指定的值。这适用于简单值，但可与查找插件一起用于任何复杂值或格式。必须提供 `src` 或 `content` 之一。
module 字符串 / 必需	应将 iRule 添加到的 BIG-IP 模块。选项 `"ltm"` `"gtm"`
name 字符串 / 必需	iRule 的名称。
partition 字符串	用于管理资源的设备分区。默认值： `"Common"`
provider 字典 f5networks.f5_modules 1.0.0 中新增	包含连接详细信息的字典对象。
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` ← (默认)
src 路径	要解释并上传到 BIG-IP 的 iRule 文件。必须提供 `src` 或 `content` 之一。
state 字符串	iRule 是否应该存在。选项 `"present"` ← (默认) `"absent"`

备注 

注意

有关使用 Ansible 管理 F5 网络设备的更多信息，请参见 https://ansible.org.cn/integrations/networks/f5。
需要 BIG-IP 软件版本 >= 12。
F5 模块仅操作 F5 产品的运行配置。为确保 BIG-IP 特定配置持久保存到磁盘，请务必包含至少一项使用 f5networks.f5_modules.bigip_config 模块保存运行配置的任务。请参考模块的文档以了解模块正确使用的信息，以便保存您的运行配置。

示例 

- name: Add the iRule contained in template irule.tcl to the LTM module
  bigip_irule:
    content: "{{ lookup('template', 'irule.tcl') }}"
    module: ltm
    name: MyiRule
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Add the iRule contained in static file irule.tcl to the LTM module
  bigip_irule:
    module: ltm
    name: MyiRule
    src: irule.tcl
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

返回值 

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

键	描述
content 字符串	已管理的 iRule 的内容。已返回：changed 和 success 示例： `"when LB_FAILED { set wipHost [LB::server addr] }"`
module 字符串	已将 iRule 添加到的模块。已返回：changed 和 success 示例： `"gtm"`
src 字符串	包含 iRule 源代码的文件名。已返回：changed 和 success（如果提供）。示例： `"/opt/src/irules/example1.tcl"`

作者

Tim Rupp (@caphrim007)
Wojciech Wypior (@wojtek0806)