cisco.ise.system_certificate_import 模块 – 系统证书导入的资源模块

注意

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

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

要安装它，请使用：ansible-galaxy collection install cisco.ise。您需要进一步的要求才能使用此模块，请参阅要求以了解详细信息。

要在 playbook 中使用它，请指定：cisco.ise.system_certificate_import。

cisco.ise 1.0.0 中的新增功能

概要 

管理资源“系统证书导入”的创建操作。
将 X509 证书作为系统证书导入。

注意

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

要求 

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

ciscoisesdk >= 2.2.3
python >= 3.5

参数 

参数	注释
admin 布尔值	使用证书来验证 Cisco ISE 管理门户。选项 `false` `true`
allowExtendedValidity 布尔值	允许导入有效期超过 398 天的证书（必需）。选项 `false` `true`
allowOutOfDateCert 布尔值	允许过期的证书（必需）。选项 `false` `true`
allowPortalTagTransferForSameSubject 布尔值	允许覆盖来自具有相同主体的匹配证书的门户标签。选项 `false` `true`
allowReplacementOfCertificates 布尔值	允许替换证书（必需）。选项 `false` `true`
allowReplacementOfPortalGroupTag 布尔值	允许替换门户组标签（必需）。选项 `false` `true`
allowRoleTransferForSameSubject 布尔值	允许为具有匹配主体的证书传输角色。选项 `false` `true`
allowSHA1Certificates 布尔值	允许基于 SHA1 的证书（必需）。选项 `false` `true`
allowWildCardCertificates 布尔值	允许通配符证书。选项 `false` `true`
data 字符串	证书内容（必需）。
eap 布尔值	将证书用于使用 SSL/TLS 隧道传输的 EAP 协议。选项 `false` `true`
ims 布尔值	将证书用于 Cisco ISE 消息服务。选项 `false` `true`
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` ← (默认)
name 字符串	证书的名称。
password 字符串	证书密码（必需）。
portal 布尔值	用于门户。选项 `false` `true`
portalGroupTag 字符串	设置组标签。
privateKeyData 字符串	私钥数据（必需）。
pxgrid 布尔值	将证书用于 pxGrid 控制器。选项 `false` `true`
radius 布尔值	使用证书用于 RADSec 服务器。选项 `false` `true`
saml 布尔值	使用证书用于 SAML 签名。选项 `false` `true`
validateCertificateExtensions 布尔值	验证证书扩展。选项 `false` `true`

注释 

注意

使用的 SDK 方法是 certificates.Certificates.import_system_certificate，
使用的路径是 post /api/v1/certs/system-certificate/import，
不支持 check_mode
该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco ISE SDK 中的嵌入式连接管理器。
以 ise_ 开头的参数由 Cisco ISE Python SDK 用于建立连接。

另请参阅 

另请参阅

Cisco ISE 证书文档: 证书 API 的完整参考。

示例 

- name: Create
  cisco.ise.system_certificate_import:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    admin: true
    allowExtendedValidity: true
    allowOutOfDateCert: true
    allowPortalTagTransferForSameSubject: true
    allowReplacementOfCertificates: true
    allowReplacementOfPortalGroupTag: true
    allowRoleTransferForSameSubject: true
    allowSHA1Certificates: true
    allowWildCardCertificates: true
    data: string
    eap: true
    ims: true
    name: string
    password: string
    portal: true
    portalGroupTag: string
    privateKeyData: string
    pxgrid: true
    radius: true
    saml: true
    validateCertificateExtensions: true

返回值 

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

键	描述
ise_response 字典	包含 Cisco ISE Python SDK 返回的响应的字典或列表。返回：始终示例： `{"response": {"id": "string", "message": "string", "status": "string"}, "version": "string"}`

作者

Rafael Campos (@racampos)