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 中的对象。

参数 

参数	注释
content 字符串	脚本的内容。此参数通常与 Ansible 的 `file` 或模板查找插件结合使用。请参阅此文档中的示例。
description 字符串	cli 脚本的描述。
name 字符串 / 必填	指定脚本的名称。
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` ← (默认)
state 字符串	当为 `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)