f5networks.f5_modules.bigiq_regkey_license 模块 – 管理 BIG-IQ 注册密钥池中的许可证

注意

此模块是 f5networks.f5_modules 集合 (版本 1.32.1) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install f5networks.f5_modules。您需要其他要求才能使用此模块，请参阅要求了解详情。

要在 playbook 中使用它，请指定：f5networks.f5_modules.bigiq_regkey_license。

f5networks.f5_modules 1.0.0 中的新增功能

概要 

管理 BIG-IQ 注册密钥池中的许可证。

要求 

执行此模块的主机需要以下要求。

BIG-IQ >= 5.3.0

参数 

参数	注释
accept_eula 布尔值	表示您接受此许可证的 F5 EULA 的密钥。 EULA 的副本可在此处找到 https://askf5.f5.com/csp/article/K12902 当 `state` 为 `present` 时，这是必需的。选项 `false` `true`
addon_keys 列表 / 元素=字符串 f5networks.f5_modules 1.16.0 中新增	要放入池中的附加密钥。
description 字符串	许可证的描述。
license_key 字符串 / 必需	要放入池中的许可证密钥。
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` ← (默认)
regkey_pool 字符串 / 必需	您要将许可证放置到的注册密钥池。您必须为注册池指定唯一名称。虽然BIG-IQ不要求这样做，但此模块需要。如果您不这样做，模块的行为未定义，您最终可能会将许可证放入错误的注册密钥池中。
状态字符串	系统上池中注册密钥许可证的状态。当`present`时，保证许可证存在于池中。当`absent`时，将许可证从池中移除。选项 `"absent"` `"present"` ← (默认)

备注 

注意

有关使用Ansible管理F5 Networks设备的更多信息，请参见 https://ansible.org.cn/integrations/networks/f5。
需要BIG-IP软件版本 >= 12。
F5模块仅操作F5产品的运行配置。为确保BIG-IP特定配置持久保存到磁盘，请务必包含至少一项使用f5networks.f5_modules.bigip_config模块保存运行配置的任务。请参阅模块文档以了解保存运行配置的正确使用方法。

示例 

- name: Add a registration key license to a pool
  bigiq_regkey_license:
    regkey_pool: foo-pool
    license_key: XXXXX-XXXXX-XXXXX-XXXXX-XXXXX
    accept_eula: true
    provider:
      password: secret
      server: cm.mydomain.com
      user: admin
  delegate_to: localhost

- name: Add a registration key license with addon keys to a pool
  bigiq_regkey_license:
    regkey_pool: foo-pool
    license_key: XXXXX-XXXXX-XXXXX-XXXXX-XXXXX
    addon_keys:
      - YYYY-YYY-YYY
      - ZZZZ-ZZZ-ZZZ
    accept_eula: true
    provider:
      password: secret
      server: cm.mydomain.com
      user: admin
  delegate_to: localhost

- name: Remove a registration key license from a pool
  bigiq_regkey_license:
    regkey_pool: foo-pool
    license_key: XXXXX-XXXXX-XXXXX-XXXXX-XXXXX
    state: absent
    provider:
      password: secret
      server: cm.mydomain.com
      user: admin
  delegate_to: localhost

返回值 

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

密钥	描述
description 字符串	许可证密钥的新描述。返回：已更改示例： `"My license for BIG-IP 1"`

作者

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