f5networks.f5_modules.bigip_ssl_certificate 模块 – 从 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_ssl_certificate。

f5networks.f5_modules 1.0.0 中的新增功能

概要

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

要求

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

• BIG-IP >= v12

参数

参数	注释
content 别名：cert_content 字符串	将证书的内容直接设置为指定的值。这与查找插件一起使用，或用于任何具有格式的内容，或者 content 必须在 state 为 present 时提供。
issuer_cert 字符串	用于 OCSP 监控的发行者证书。 此参数仅在 BIG-IP 13.0.0 或更高版本上有效。
name 字符串 / 必需	SSL 证书名称。这是将证书导入 BIG-IP 时使用的证书名称。它还确定 LTM 上对象的名称。
partition 字符串	用于管理资源的设备分区。 默认值： "Common"
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。 选项 "present" ← (默认) "absent"
true_names 布尔值 f5networks.f5_modules 1.24.0 中新增	当 true 时，模块不会将 .crt 扩展名附加到给定的证书名称。 当 false 时，模块将 .crt 扩展名附加到给定的证书名称。 选项 false ← (默认) true

备注

注意

• 此模块的行为与您可能包含在角色中的其他模块不同，在角色中的其他模块中，引用文件或模板首先会在角色的文件或模板目录中查找。要使其以这种方式运行，请使用 Ansible 文件或模板查找（请参见示例）。查找在角色上下文中按预期运行。

• 有关使用 Ansible 管理 F5 Networks 设备的更多信息，请参见 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 PEM Certificate
  bigip_ssl_certificate:
    name: certificate-name
    state: present
    content: "{{ lookup('file', '/path/to/cert.crt') }}"
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

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

- name: Delete Certificate
  bigip_ssl_certificate:
    name: certificate-name
    state: absent
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

返回值

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

键	描述
cert_name 字符串	证书名称。 返回：已创建 示例： "cert1"
checksum 字符串	证书的 SHA1 校验和。 返回：已更改和已创建 示例： "f7ff9e8b7bb2e09b70935a5d785e0cc5d9d0abf0"
filename 字符串	SSL 证书的名称。 返回：已创建 示例： "cert1.crt"
source_path 字符串	BIG-IP 上存储证书源的路径。 返回：已创建 示例： "/var/config/rest/downloads/cert1.crt"

作者

• Tim Rupp (@caphrim007)

• Wojciech Wypior (@wojtek0806)

收藏链接

• 问题跟踪器
• 主页
• 代码库（源代码）