cisco.ise.endpoint_certificate 模块 – 终端证书的资源模块

注意

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

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

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

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

cisco.ise 1.0.0 中的新增功能

概要 

管理资源终端证书的更新操作。
此 API 允许客户端创建终端证书。

注意

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

要求 

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

ciscoisesdk >= 2.2.3
python >= 3.5

参数 

参数	注释
certificateRequest 字典	键值映射。必须具有 CN 和 SAN 条目。
cn 字符串	与请求者的用户名匹配，除非请求者是 ERS 管理员。ERS 管理员可以为任何 CN 创建请求。
san 字符串	有效的 MAC 地址，以“-”分隔。
certTemplateName 字符串	内部 CA 模板的名称。
dirPath 字符串	目录绝对路径。默认为当前工作目录。
filename 字符串	用于保存下载文件的文件名。
format 字符串	允许的值 - PKCS12、- PKCS12_CHAIN、- PKCS8、- PKCS8_CHAIN。
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` ←（默认）
password 字符串	保护私钥。必须超过 8 个字符，少于 15 个字符，至少一个大写字母，至少一个小写字母，至少一个数字，并且只能包含 A-Za-z0-9_#。
saveFile 布尔值	启用或禁用原始响应的自动文件创建。选项 `false` `true`

注释 

注意

使用的 SDK 方法是 endpoint_certificate.EndpointCertificate.create_endpoint_certificate，
使用的路径是 put /ers/config/endpointcert/certRequest，
不支持 check_mode
该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco ISE SDK 中的嵌入式连接管理器
以 ise_ 开头的参数由 Cisco ISE Python SDK 用于建立连接

另请参阅 

另请参阅

有关 EndpointCertificate 的 Cisco ISE 文档: EndpointCertificate API 的完整参考。

示例 

- name: Create
  cisco.ise.endpoint_certificate:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    certTemplateName: string
    certificateRequest:
      cn: string
      san: string
    dirPath: /tmp/downloads/
    filename: download_filename.extension
    format: string
    password: string
    saveFile: true

返回值 

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

键	描述
ise_response 字典	一个字典或列表，其中包含 Cisco ISE Python SDK 返回的响应返回：始终示例： `{"data": "filecontent", "dirpath": "download/directory", "filename": "filename", "path": "download/directory/filename"}`

作者

Rafael Campos (@racampos)