community.network.netscaler_ssl_certkey 模块 – 管理 SSL 证书密钥。

注意

此模块是 community.network 集合（版本 5.1.0）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install community.network。您需要其他要求才能使用此模块，请参阅 要求 获取详细信息。

要在 playbook 中使用它，请指定： community.network.netscaler_ssl_certkey。

注意

community.network 集合已弃用，并将从 Ansible 12 中删除。有关详细信息，请参阅讨论主题。

已弃用

在以下版本中删除:

6.0.0 版

原因:

此集合及其中的所有内容均未维护且已弃用。

替代方案:

未知。

概要

  • 管理 SSL 证书密钥。

别名：network.netscaler.netscaler_ssl_certkey

要求

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

  • nitro python sdk

参数

参数

注释

cert

字符串

用于构成证书-密钥对的 X509 证书文件的名称和可选路径。证书文件应存在于设备的硬盘驱动器或固态驱动器上。将证书存储在默认路径以外的任何位置可能会导致高可用性设置不一致。/nsconfig/ssl/ 是默认路径。

最小长度 = 1

certkey

字符串

证书和私钥对的名称。必须以 ASCII 字母数字或下划线 _ 字符开头，并且只能包含 ASCII 字母数字、下划线 _、井号 #、句点 .、空格 、冒号 :、at @、等号 = 和连字符 - 字符。创建证书-密钥对后，无法更改。

以下要求仅适用于 NetScaler CLI

如果名称包含一个或多个空格，请将名称括在双引号或单引号中（例如，“my cert”或‘my cert’）。

最小长度 = 1

expirymonitor

字符串

当证书即将过期时发出警报。

选项

  • "enabled"

  • "disabled"

inform

字符串

证书和私钥文件的输入格式。设备支持的三种格式是

PEM - Privacy Enhanced Mail（隐私增强邮件）

DER - Distinguished Encoding Rule（可分辨编码规则）

PFX - Personal Information Exchange（个人信息交换）。

选项

  • "DER"

  • "PEM"

  • "PFX"

key

字符串

用于构成证书-密钥对的私钥文件的名称和可选路径。证书文件应存在于设备的硬盘驱动器或固态驱动器上。将证书存储在默认路径以外的任何位置可能会导致高可用性设置不一致。/nsconfig/ssl/ 是默认路径。

最小长度 = 1

nitro_pass

字符串 / 必需

用于向 netscaler 节点进行身份验证的密码。

nitro_protocol

字符串

访问 nitro API 对象时要使用的协议。

选项

  • "http" ←（默认）

  • "https"

nitro_timeout

浮点数

与 Netscaler 建立新会话时抛出超时错误之前的秒数

默认值： 310.0

nitro_user

字符串 / 必需

用于向 netscaler 节点进行身份验证的用户名。

notificationperiod

字符串

在证书到期之前生成证书即将到期的警报的天数。

最小值 = 10

最大值 = 100

nsip

字符串 / 必需

将进行 nitro API 调用的 netscaler 设备的 IP 地址。

可以使用冒号 (:) 指定端口。例如，192.168.1.1:555。

passplain

字符串

用于加密私钥的密码短语。以 PEM 格式添加加密私钥时需要。

最小长度 = 1

password

字符串

用于加密私钥的密码短语。使用此选项以 PEM 格式加载加密的私钥。

save_config

布尔值

如果为 yes，则如果模块进行任何更改，它将在 netscaler 节点上保存配置。

如果模块未进行任何更改，它将不会在 netscaler 节点上保存配置。

选项

  • false

  • true ←（默认）

state

字符串

模块在 netscaler 节点上配置的资源的状态。

存在时，如果需要，将创建资源并根据模块的参数进行配置。

不存在时，资源将从 netscaler 节点中删除。

选项

  • "absent"

  • "present" ←（默认）

validate_certs

布尔值

如果为 no，则不会验证 SSL 证书。这仅应在个人控制的站点上使用自签名证书。

选项

  • false

  • true ←（默认）

注释

注意

示例

- name: Setup ssl certkey
  delegate_to: localhost
  community.network.netscaler_ssl_certkey:
    nitro_user: nsroot
    nitro_pass: nsroot
    nsip: 172.18.0.2

    certkey: certirificate_1
    cert: server.crt
    key: server.key
    expirymonitor: enabled
    notificationperiod: 30
    inform: PEM
    password: false
    passplain: somesecret

返回值

通用返回值已在此处记录 这里，以下是此模块特有的字段

键

描述

diff

字典

实际配置的对象与模块中指定的配置之间的差异列表

返回: 失败

示例: {"targetlbvserver": "difference. ours: (str) server1 other: (str) server2"}

loglines

列表 / 元素=字符串

模块记录的消息列表

返回: 始终

示例: ["['message 1'", " 'message 2']"]

msg

字符串

详细说明失败原因的消息

返回: 失败

示例: "操作不存在"

状态

  • 此模块将在 6.0.0 版本中删除。[已弃用]

  • 有关更多信息，请参阅已弃用。

作者

  • George Nikolopoulos (@giorgos-nikolopoulos)