f5networks.f5_modules.bigip_cli_script 模块 – 管理 BIG-IP 上的 CLI 脚本

注意

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

f5networks.f5_modules 1.0.0 中的新功能

概要

• 管理 BIG-IP 上的 CLI 脚本。CLI 脚本，也称为 tmshell 脚本或 TMSH 脚本，允许您创建自定义脚本，可以运行这些脚本来管理 BIG-IP 中的对象。

参数

参数	注释
内容 字符串	脚本的内容。 此参数通常与 Ansible 的 file 或模板查找插件结合使用。请参阅本文档中的示例。
描述 字符串	cli 脚本的描述。
名称 字符串 / 必填	指定脚本的名称。
分区 字符串	设备分区，用于管理资源。 默认值： "Common"
提供程序 字典 在 f5networks.f5_modules 1.0.0 中添加	包含连接详细信息的字典对象。
auth_provider 字符串	配置身份验证提供程序，以从远程设备获取身份验证令牌。 此选项在处理 BIG-IQ 设备时非常有用。
no_f5_teem 布尔值	如果 yes，则 TEEM 遥测数据不会发送到 F5。 您可以通过设置环境变量 F5_TELEMETRY_OFF 来省略此选项。 以前使用的变量 F5_TEEM 已弃用，因为其名称容易混淆。 选择 false ← (默认) true
密码 别名：pass, pwd 字符串 / 必填	用于连接到 BIG-IP 或 BIG-IQ 的用户帐户的密码。 您可以通过设置环境变量 F5_PASSWORD 来省略此选项。
服务器 字符串 / 必填	BIG-IP 主机或 BIG-IQ 主机。 您可以通过设置环境变量 F5_SERVER 来省略此选项。
server_port 整数	BIG-IP 服务器端口。 您可以通过设置环境变量 F5_SERVER_PORT 来省略此选项。 默认值： 443
超时 整数	指定与网络设备通信（用于连接或发送命令）的超时时间（以秒为单位）。如果操作完成之前超时时间已过，则模块将出错。
传输 字符串	配置连接到远程设备时要使用的传输连接。 选择 "rest" ← (默认)
用户 字符串 / 必填	用于连接到 BIG-IP 或 BIG-IQ 的用户名。此用户必须在设备上具有管理权限。 您可以通过设置环境变量 F5_USER 来省略此选项。
validate_certs 布尔值	如果 no，则不验证 SSL 证书。仅在个人控制的使用自签名证书的站点上使用此选项。 您可以通过设置环境变量 F5_VALIDATE_CERTS 来省略此选项。 选择 false true ← (默认)
状态 字符串	当 present 时，确保脚本存在。 当 absent 时，确保删除脚本。 选择 "present" ← (默认) "absent"

注释

注意

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

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

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

示例

- name: Create a cli script from an existing file
  bigip_cli_script:
    name: foo
    content: "{{ lookup('file', '/absolute/path/to/cli/script.tcl') }}"
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Create a cli script from a jinja template representing a cli script
  bigip_cli_script:
    name: foo
    content: "{{ lookup('template', '/absolute/path/to/cli/script.tcl') }}"
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

返回值

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

键	描述
param1 布尔值	资源的新的 param1 值。 返回: changed 示例: true
param2 字符串	资源的新的 param2 值。 返回: changed 示例: "Foo is bar"

作者

• Tim Rupp (@caphrim007)

• Wojciech Wypior (@wojtek0806)

集合链接

• 问题跟踪器
• 主页
• 仓库 (源代码)