f5networks.f5_modules.bigiq_regkey_pool 模块 – 在 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_pool。

f5networks.f5_modules 1.0.0 中的新增功能

概要 

在 BIG-IQ 上管理注册密钥 (regkey) 池。这些池充当容器，您可以在其中添加注册密钥列表。要添加注册密钥，请使用 bigiq_regkey_license 模块。

要求 

以下是执行此模块的主机所需的条件。

BIG-IQ >= 5.3.0

参数 

参数	注释
description 字符串	附加到池的描述。
name 字符串 / 必需	指定注册密钥池的名称。您必须为注册池命名唯一名称。虽然 BIG-IQ 不要求这样做，但此模块要求这样做。如果不这样做，模块的行为是不确定的，您最终可能会将许可证放入错误的注册密钥池中。
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 字符串	系统上 regkey 池的状态。当为 `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: Create a registration key (regkey) pool to hold individual device licenses
  bigiq_regkey_pool:
    name: foo-pool
    state: present
    provider:
      user: admin
      password: secret
      server: cm.mydomain.com
  delegate_to: localhost

返回值 

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

键	描述
description 字符串	regkey 池的新描述。返回：changed 示例： `"My description"`

作者

Tim Rupp (@caphrim007)