cisco.ise.trusted_certificate_export_info 模块 – 可信证书导出信息模块

注意

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

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

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

要在剧本中使用它，请指定：cisco.ise.trusted_certificate_export_info。

cisco.ise 1.0.0 中的新增功能

概要

  • 根据 ID 获取可信证书导出。

  • 此 API 的响应包含映射到请求 ID 的可信证书文件。

注意

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

需求

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

  • ciscoisesdk >= 2.2.3

  • python >= 3.5

参数

参数

注释

dirPath

字符串

目录绝对路径。默认为当前工作目录。

filename

字符串

用于保存下载文件的文件名。

id

字符串

ID 路径参数。要导出的可信证书的 ID。

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 ← (默认)

saveFile

布尔值

启用或禁用原始响应的自动文件创建。

选项

  • false

  • true

备注

注意

  • 使用的 SDK 方法是 certificates.Certificates.export_trusted_certificate，

  • 使用的路径是 get /api/v1/certs/trusted-certificate/export/{id}，

  • 支持 check_mode

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

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

另请参阅

另请参阅

Cisco ISE 证书文档

证书 API 的完整参考。

示例

- name: Get Trusted Certificate Export by id
  cisco.ise.trusted_certificate_export_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    id: string
  register: result

返回值

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

键

描述

ise_response

字典

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

返回：始终

示例： {"data": "filecontent", "dirpath": "download/directory", "filename": "filename", "path": "download/directory/filename"}

作者

  • Rafael Campos (@racampos)