f5networks.f5_modules.bigip_ssl_key 模块 – 从 BIG-IP 导入/删除 SSL 密钥

注意

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

f5networks.f5_modules 1.0.0 中的新增功能

概要 

此模块在 BIG-IP 上导入/删除 SSL 密钥。密钥可以从本地磁盘上的密钥文件导入，格式为 PEM。

要求 

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

BIG-IP >= v12

参数 

参数	注释
content 别名：key_content 字符串	直接将密钥的内容设置为指定的值。这与查找插件或任何带有格式或模板的东西一起使用。当 `state` 为 `present` 时，必须提供此项。
name 字符串 / 必需	密钥的名称。
partition 字符串	用于管理资源设备的分区。默认值： `"Common"`
passphrase 字符串	密钥上的密码短语。
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` ←（默认）
state 字符串	当 `present` 时，确保密钥上传到设备。当 `absent` 时，确保从设备中删除密钥。如果密钥当前正在使用，则模块无法删除密钥。选项 `"present"` ←（默认） `"absent"`
true_names 布尔值在 f5networks.f5_modules 1.24.0 中添加	如果为 `true`，则模块不会将 `.key` 扩展名附加到给定的密钥名称。如果为 `false`，则模块会将 `.key` 扩展名附加到给定的密钥名称。选项 `false` ←（默认） `true`

注释 

注意

此模块的行为不像您可能在角色中包含的其他模块，在这些模块中，引用文件或模板首先会在角色的文件或模板目录中查找。要使模块以这种方式运行，请使用 Ansible 文件或模板查找（请参阅示例）。查找在角色上下文中按预期运行。
有关使用 Ansible 管理 F5 网络设备的更多信息，请参阅 https://ansible.org.cn/integrations/networks/f5。
需要 BIG-IP 软件版本 >= 12。
F5 模块仅操作 F5 产品的运行配置。为确保 BIG-IP 特定配置持久保存到磁盘，请务必至少包含一个使用 f5networks.f5_modules.bigip_config 模块保存运行配置的任务。有关正确使用该模块以保存运行配置的信息，请参阅该模块的文档。

示例 

- name: Use a file lookup to import key
  bigip_ssl_key:
    name: key-name
    state: present
    content: "{{ lookup('file', '/path/to/key.key') }}"
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Delete key
  bigip_ssl_key:
    name: key-name
    state: absent
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

返回值 

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

键	描述
key_checksum 字符串	键的 SHA1 校验和。返回: changed 和 created 示例: `"cf23df2207d99a74fbe169e3eba035e633b65d94"`
key_filename 字符串	SSL 证书密钥的名称。`key_filename` 和 `cert_filename` 将彼此相似，但是 `key_filename` 将具有 `.key` 扩展名。返回: created 示例: `"cert1.key"`
key_source_path 字符串	在 BIG-IP 上存储密钥源的路径。返回: created 示例: `"/var/config/rest/downloads/cert1.key"`

作者

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