cisco.ise.system_certificate 模块 – 用于系统证书的资源模块

注意

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

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

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

要在 Playbook 中使用它，请指定：cisco.ise.system_certificate。

cisco.ise 1.0.0 中的新增功能

概要

• 管理资源系统证书的更新和删除操作。

• 此 API 基于给定的主机名和 ID 删除特定节点的系统证书。

• 更新系统证书。

注意

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

要求

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

• ciscoisesdk >= 2.2.3

• python >= 3.5

参数

参数	注释
admin 布尔值	使用证书对 Cisco ISE 管理门户进行身份验证。 选择 false true
allowPortalTagTransferForSameSubject 布尔值	允许覆盖来自同一主题的匹配证书的门户标签。 选择 false true
allowReplacementOfPortalGroupTag 布尔值	允许替换门户组标签（必需）。 选择 false true
allowRoleTransferForSameSubject 布尔值	允许传输具有匹配主题的证书的角色。 选择 false true
allowWildcardDelete 布尔值	如果要删除的给定证书是通配符证书，则对应的证书也会在部署中的其余节点上删除。 选择 false true
description 字符串	系统证书的描述。
eap 布尔值	使用证书进行使用 SSL/TLS 隧道的 EAP 协议。 选择 false true
expirationTTLPeriod 整数	系统证书的 expirationTTLPeriod。
expirationTTLUnits 字符串	系统证书的 expirationTTLUnits。
hostName 字符串	HostName 路径参数。需要更新证书的主机名称。
id 字符串	Id 路径参数。要更新的系统证书的 ID。
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 字符串	证书的名称。
portal 布尔值	用于门户。 选择 false true
portalGroupTag 字符串	设置组标签。
pxgrid 布尔值	使用证书用于 pxGrid 控制器。 选择 false true
radius 布尔值	使用证书用于 RADSec 服务器。 选择 false true
renewSelfSignedCertificate 布尔值	续订自签名证书。 选择 false true
saml 布尔值	使用证书进行 SAML 签名。 选择 false true

备注

注意

• 使用的 SDK 方法是 certificates.Certificates.delete_system_certificate_by_id, certificates.Certificates.update_system_certificate,

• 使用的路径是 delete /api/v1/certs/system-certificate/{hostName}/{id}, put /api/v1/certs/system-certificate/{hostName}/{id},

• 不支持 check_mode

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

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

另请参阅

另请参阅

Cisco ISE 证书文档

证书 API 的完整参考。

示例

- name: Update by id
  cisco.ise.system_certificate:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    admin: true
    allowPortalTagTransferForSameSubject: true
    allowReplacementOfPortalGroupTag: true
    allowRoleTransferForSameSubject: true
    description: string
    eap: true
    expirationTTLPeriod: 0
    expirationTTLUnits: string
    hostName: string
    id: string
    ims: true
    name: string
    portal: true
    portalGroupTag: string
    pxgrid: true
    radius: true
    renewSelfSignedCertificate: true
    saml: true

- name: Delete by id
  cisco.ise.system_certificate:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: absent
    allowWildcardDelete: true
    hostName: string
    id: string

返回值

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

键	描述
ise_response 字典	包含 Cisco ISE Python SDK 返回的响应的字典或列表 返回: 总是 示例: {"expirationDate": "string", "friendlyName": "string", "groupTag": "string", "id": "string", "issuedBy": "string", "issuedTo": "string", "keySize": 0, "link": {"href": "string", "rel": "string", "type": "string"}, "portalsUsingTheTag": "string", "selfSigned": true, "serialNumberDecimalFormat": "string", "sha256Fingerprint": "string", "signatureAlgorithm": "string", "usedBy": "string", "validFrom": "string"}
ise_update_response 字典 在 cisco.ise 1.1.0 中添加	包含 Cisco ISE Python SDK 返回的响应的字典或列表 返回: 总是 示例: {"response": {"id": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "message": "string", "status": "string"}, "version": "string"}

作者

• Rafael Campos (@racampos)

集合链接

• 问题跟踪器
• 存储库（源代码）