f5networks.f5_modules.bigip_ssl_csr 模块 – 在 BIG-IP 上创建 SSL CSR 文件

注意

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

f5networks.f5_modules 1.3.0 中的新功能

概要

  • 此模块将在 BIG-IP 上创建 SSL CSR 文件。CSR 需要在 BIG-IP 上预先存在关联的 SSL 密钥。

参数

参数

注释

common_name

字符串

证书通用名称。

dest

路径 / 必需

当您想要保存 CSR 文件时,在本地文件系统上的目标位置。

force

布尔值

如果 false,则仅当目标不存在时才会传输文件。

选项

  • false

  • true ← (默认)

key_name

字符串

用于生成 CSR 的 SSL 密钥。

name

字符串 / 必需

CSR 文件的名称。

provider

字典

在 f5networks.f5_modules 1.0.0 中添加

包含连接详细信息的 dict 对象。

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"

注释

注意

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

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

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

示例

- name: Create an SSL csr
  bigip_ssl_csr:
    name: csr-name
    key_name: key-name
    common_name: csr-name
    dest: /tmp/csr-name
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

返回值

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

描述

common_name

字符串

CSR 文件的通用名称。

返回: created

示例: "csr-name"

csr_name

字符串

CSR 文件的名称。

返回: created

示例: "csr-name"

作者

  • Nitin Khanna (@nitinthewiz)