f5networks.f5_modules.bigip_ssl_key_cert 模块 – 从 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_cert

f5networks.f5_modules 1.6.0 中的新增功能

概要

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

参数

参数

注释

cert_content

字符串

直接将证书内容设置为指定的值。这与查找插件或任何具有格式化或

statepresent 时,必须提供 content

cert_name

字符串

SSL 证书名称。这是将证书导入 BIG-IP 时使用的证书名称。它还决定了 LTM 上对象的名称。

issuer_cert

字符串

用于 OCSP 监控的颁发者证书。

此参数仅在 BIG-IP 13.0.0 或更高版本上有效。

key_content

字符串

直接将密钥内容设置为指定的值。这与查找插件或任何具有格式化或模板化的内容一起使用。当 statepresent 时,必须提供此项。

key_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 时,模块不会将 .crt.key 扩展名附加到给定的证书和密钥名称。

false 时,模块会将 .crt.key 扩展名附加到给定的证书和密钥名称。

选择

  • false ←(默认)

  • true

注释

注意

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

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

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

示例

- name: Import both key and cert
  bigip_ssl_key_cert:
    key_content: "{{ lookup('file', 'key.pem') }}"
    key_name: cert1
    cert_content: "{{ lookup('file', 'cert.pem') }}"
    cert_name: cert1
    state: present
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

作者

  • Nitin Khanna (@nitinthewiz)