f5networks.f5_modules.bigip_cli_alias 模块 – 管理 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_alias。

f5networks.f5_modules 1.0.0 中的新增功能

概要 

允许管理 BIG-IP 上的私有和共享别名。

参数 

参数	注释
command 字符串	要别名的命令。
description 字符串	别名的描述。
name 字符串 / 必需	指定别名的名称。
partition 字符串	在其上管理资源的设备分区。当 `scope` 为 `private` 时，此参数将被忽略。默认值： `"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` ← (默认)
scope 字符串	别名的范围；是在系统上共享，还是仅供创建它的用户使用。选择 `"private"` `"shared"` ← (默认)
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 new alias
  bigip_cli_alias:
    name: sync_device_to_bside
    scope: shared
    command: save /sys config partitions all; run /cm config-sync to-group device-group-1
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

返回值 

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

键	描述
command 字符串	新的别名命令。返回: changed 示例: `"run /util bash"`
description 字符串	别名的新描述。返回: changed 示例: `"运行 bash shell"`

作者

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