f5networks.f5_modules.bigip_iapp_template 模块 – 在 BIG-IP 上管理 TCL iApp 模板。

注意

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

f5networks.f5_modules 1.0.0 中的新增功能

概要

  • 在 BIG-IP 上管理 TCL iApp 模板。此模块允许您将 iApp 模板部署到 BIG-IP 并管理其生命周期。使用此模块的常规方法是根据需要导入新的 iApp,或通过提取 downloads.f5.com 提供的 iApp 归档文件的內容,然后使用此模块导入所有 iApp。如果 iApp 的源代码更改而名称保持不变,此模块也可以更新现有的 iApp。请注意,此模块不会重新配置可能已使用 bigip_iapp_service 模块创建的任何服务。通常不会在生产环境中更新 iApp。而是部署新版本,然后将现有服务更改为使用该新模板。因此,要就地更新模板,需要使用 force 选项。

参数

参数

注释

content

字符串

将 iApp 模板的内容直接设置为指定的值。这适用于简单值,但可与查找插件一起用于任何复杂内容或格式化。创建新模板时必须提供 content

force

布尔值

指定是否强制上传 iApp。当 true 时,即使有 iApp 服务正在使用它,系统也会强制更新 iApp。这不会更新正在运行的服务,请使用 bigip_iapp_service 来执行此操作。当 false 时,只有在没有 iApp 服务使用该模板时,系统才会更新 iApp。

选项

  • false

  • true

name

字符串

要删除的 iApp 模板的名称。此选项仅在指定 stateabsent 时可用,并作为删除您可能不再拥有其源代码的模板的一种方法提供。

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

state

字符串

iApp 模板是否存在。

选项

  • "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: Add the iApp contained in template iapp.tmpl
  bigip_iapp_template:
    content: "{{ lookup('template', 'iapp.tmpl') }}"
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Update a template in place
  bigip_iapp_template:
    content: "{{ lookup('template', 'iapp-new.tmpl') }}"
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Update a template in place that has existing services created from it.
  bigip_iapp_template:
    content: "{{ lookup('template', 'iapp-new.tmpl') }}"
    force: true
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

作者

  • Tim Rupp (@caphrim007)

  • Wojciech Wypior (@wojtek0806)