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

注释 

注意

此模块的行为方式与您可能在角色中包含的其他模块不同，在这些模块中，引用文件或模板会首先在角色的 files 或 templates 目录中查找。要使其以这种方式工作，请使用 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)