f5networks.f5_modules.bigip_device_license 模块 – 管理 BIG-IP 设备上的许可证安装和激活

注意

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

f5networks.f5_modules 1.0.0 中的新增功能

概要

  • 管理 BIG-IP 上的许可证安装和激活。

参数

参数

注释

accept_eula

布尔值

声明您是否接受 BIG-IP EULA。默认情况下,此值为 false。您必须明确声明您已查看并接受许可证。此模块不会向您显示 EULA,因此您有责任阅读它。

EULA 可以在此处找到;https://support.f5.com/csp/article/K12902

stateabsent 时,此参数不是必需的,如果提供则会被忽略。

选项

  • false ← (默认)

  • true

addon_keys

列表 / 元素=字符串

f5networks.f5_modules 1.2.0 中新增

要与基本许可证一起使用的附加密钥列表。

如果未提供 license_key,则会忽略此参数。

stateabsent 时,此参数不是必需的,如果提供则会被忽略。

force

布尔值

声明是否强制续订许可证。默认情况下,此值为 false

此参数不是必需的,如果提供则会被忽略。

选项

  • false ← (默认)

  • true

license_key

字符串

用于许可 BIG-IP 的注册密钥。

如果 state 等于 presentlatest,则此参数是必需的。

stateabsent 时,此参数不是必需的,如果提供则会被忽略。

license_server

字符串

获取许可证和验证档案时要使用的 F5 许可证服务器。

如果 state 等于 presentlatest,则此参数是必需的。

stateabsent 时,此参数不是必需的,如果提供则会被忽略。

默认值: "activate.f5.com"

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 时,删除系统上的许可证。

latest 时,确保许可证始终有效。这不是幂等状态,因为重新运行可能会修改结果。

revoked 时,删除系统上的许可证并撤销其在 F5 许可证服务器上的未来使用。

选项

  • "absent"

  • "latest"

  • "present" ← (默认)

  • "revoked"

备注

注意

  • 此模块可用于许可无法访问互联网的 BIG-IP。

  • 只有 Ansible 控制节点需要访问互联网,因为许可证激活是在运行模块的 Ansible 控制节点上完成的。

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

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

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

示例

- name: License BIG-IP using a key
  bigip_device_license:
    license_key: "XXXXX-XXXXX-XXXXX-XXXXX-XXXXXXX"
    provider:
      server: "lb.mydomain.com"
      user: "admin"
      password: "secret"
  delegate_to: localhost

- name: License BIG-IP using a key
  bigip_device_license:
    license_key: "XXXXX-XXXXX-XXXXX-XXXXX-XXXXXXX"
    provider:
      server: "lb.mydomain.com"
      user: "admin"
      password: "secret"
  delegate_to: localhost

- name: Remove the license from the system
  bigip_device_license:
    state: "absent"
    provider:
      server: "lb.mydomain.com"
      user: "admin"
      password: "secret"
  delegate_to: localhost

作者

  • Tim Rupp (@caphrim007)

  • Wojciech Wypior (@wojtek0806)

  • Andrey Kashcheev (@andreykashcheev)