cisco.ise.selfsigned_certificate_generate 模块 – 自签名证书生成资源模块

注意

此模块是 cisco.ise 集合 (版本 2.9.6) 的一部分。

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

要安装它,请使用: ansible-galaxy collection install cisco.ise。您需要其他要求才能使用此模块,有关详细信息,请参阅 要求

要在 playbook 中使用它,请指定: cisco.ise.selfsigned_certificate_generate

cisco.ise 2.1.0 中的新增功能

概要

  • 管理资源自签名证书生成的创建操作。

  • 生成自签名证书。

注意

此模块具有相应的 操作插件

要求

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

  • ciscoisesdk >= 2.2.3

  • python >= 3.5

参数

参数

注释

admin

布尔值

使用证书验证 Cisco ISE 管理门户。

选项

  • false

  • true

allowExtendedValidity

布尔值

允许生成有效期超过 398 天的自签名证书。

选项

  • false

  • true

allowPortalTagTransferForSameSubject

布尔值

允许覆盖来自相同主题的匹配证书的门户标签。

选项

  • false

  • true

allowReplacementOfCertificates

布尔值

允许替换证书。

选项

  • false

  • true

allowReplacementOfPortalGroupTag

布尔值

允许替换门户组标签。

选项

  • false

  • true

allowRoleTransferForSameSubject

布尔值

允许为具有匹配主题的证书转移角色。

选项

  • false

  • true

allowSanDnsBadName

布尔值

允许使用 SAN DNS 错误名称。

选项

  • false

  • true

allowSanDnsNonResolvable

布尔值

允许使用不可解析的公用名或 SAN 值。

选项

  • false

  • true

allowWildCardCertificates

布尔值

允许通配符证书。

选项

  • false

  • true

certificatePolicies

字符串

证书策略。

digestType

字符串

用于签名的摘要。

eap

布尔值

用于使用 SSL/TLS 隧道协议的 EAP 协议的证书。

选项

  • false

  • true

expirationTTL

整数

证书有效期值。

expirationTTLUnit

字符串

证书有效期单位。

hostName

字符串

应在其中生成自签名证书的 Cisco ISE 节点的主机名。

ise_debug

布尔值

用于启用 Identity Services Engine SDK 调试的标志。

选项

  • false ← (默认)

  • true

ise_hostname

字符串 / 必需

Identity Services Engine 主机名。

ise_password

字符串 / 必需

用于身份验证的 Identity Services Engine 密码。

ise_single_request_timeout

整数

在 cisco.ise 3.0.0 中添加

RESTful HTTP 请求的超时(以秒为单位)。

默认值: 60

ise_username

字符串 / 必需

用于身份验证的 Identity Services Engine 用户名。

ise_uses_api_gateway

布尔值

在 cisco.ise 1.1.0 中添加

告知 SDK 是否使用 Identity Services Engine 的 API 网关发送请求的标志。

如果为 true,则使用 ISE 的 API 网关并将请求发送到 https://{{ise_hostname}}。

如果为 false,则将请求发送到 https://{{ise_hostname}}:{{port}},其中端口值取决于使用的服务(ERS、Mnt、UI、PxGrid)。

选项

  • false

  • true ← (默认)

ise_uses_csrf_token

布尔值

在 cisco.ise 3.0.0 中添加

告知 SDK 我们是否将 CSRF 令牌发送到 ISE 的 ERS API 的标志。

如果为 True,则 SDK 假设您的 ISE CSRF 检查已启用。

如果为 True,则假定您需要 SDK 为您自动管理 CSRF 令牌。

选项

  • false ← (默认)

  • true

ise_verify

布尔值

启用或禁用 SSL 证书验证的标志。

选项

  • false

  • true ← (默认)

ise_version

字符串

告知 SDK 使用哪个版本的 Identity Services Engine。

默认值: "3.1_Patch_1"

ise_wait_on_rate_limit

布尔值

用于启用 Identity Services Engine SDK 自动速率限制处理的标志。

选项

  • false

  • true ← (默认)

keyLength

字符串

公钥的位大小。

keyType

字符串

用于创建证书公钥的算法。

name

字符串

证书的友好名称。

portal

布尔值

用于门户。

选项

  • false

  • true

portalGroupTag

字符串

设置组标签。

pxgrid

布尔值

用于 pxGrid 控制器的证书。

选项

  • false

  • true

radius

布尔值

用于 RADSec 服务器的证书。

选项

  • false

  • true

saml

布尔值

用于 SAML 签名的证书。

选项

  • false

  • true

sanDNS

列表 / 元素=字符串

SAN(主题替代名称)DNS 条目的数组。

sanIP

列表 / 元素=字符串

SAN IP 地址数组。

sanURI

列表 / 元素=字符串

SAN URI 地址数组。

subjectCity

字符串

证书城市或地区 (L)。

subjectCommonName

字符串

证书通用名称 (CN)。

subjectCountry

字符串

证书国家/地区 (C)。

subjectOrg

字符串

证书组织 (O)。

subjectOrgUnit

字符串

证书组织单位 (OU)。

subjectState

字符串

证书州/省 (ST)。

注释

注意

  • 使用的 SDK 方法为 certificates.Certificates.generate_self_signed_certificate,

  • 使用的路径为 post /api/v1/certs/system-certificate/generate-selfsigned-certificate,

  • 不支持 check_mode

  • 插件在控制节点上运行,不使用任何 Ansible 连接插件,而是使用 Cisco ISE SDK 中的嵌入式连接管理器。

  • 以 ise_ 开头的参数由 Cisco ISE Python SDK 用于建立连接。

另请参见

另请参见

Cisco ISE 证书文档。

证书 API 的完整参考。

示例

- name: Create
  cisco.ise.selfsigned_certificate_generate:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    admin: true
    allowExtendedValidity: true
    allowPortalTagTransferForSameSubject: true
    allowReplacementOfCertificates: true
    allowReplacementOfPortalGroupTag: true
    allowRoleTransferForSameSubject: true
    allowSanDnsBadName: true
    allowSanDnsNonResolvable: true
    allowWildCardCertificates: true
    certificatePolicies: string
    digestType: string
    eap: true
    expirationTTL: 0
    expirationTTLUnit: string
    hostName: string
    keyLength: string
    keyType: string
    name: string
    portal: true
    portalGroupTag: string
    pxgrid: true
    radius: true
    saml: true
    sanDNS:
    - string
    sanIP:
    - string
    sanURI:
    - string
    subjectCity: string
    subjectCommonName: string
    subjectCountry: string
    subjectOrg: string
    subjectOrgUnit: string
    subjectState: string

返回值

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

描述

ise_response

字典

包含 Cisco ISE Python SDK 返回的响应的字典或列表。

返回值:始终返回

示例: {"response": {"id": "string", "message": "string", "status": "string"}, "version": "string"}

作者

  • Rafael Campos (@racampos)