cisco.ise.trusted_certificate_info 模块 – 受信任证书的信息模块

注意

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

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

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

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

cisco.ise 1.0.0 中的新增功能

概要

  • 获取所有受信任证书。

  • 通过 ID 获取受信任证书。

  • 此 API 可以显示基于给定 ID 的信任证书的详细信息。

  • 此 API 支持过滤、排序和分页。

注意

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

要求

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

  • ciscoisesdk >= 2.2.3

  • python >= 3.5

参数

参数

注释

filter

字符串

筛选查询参数。.. 容器 **简单筛选** 应通过 filter 查询字符串参数提供。筛选器的结构是字段、运算符和值的三元组,用点分隔。可以发送多个筛选器。所有筛选条件通用的逻辑运算符默认为 AND,并且可以通过使用 *“filterType=or”* 查询字符串参数来更改。

每个资源数据模型描述应指定属性是否为筛选字段。

“EQ”运算符描述“等于”。

“NEQ”运算符描述“不等于”。

“GT”运算符描述“大于”。

“LT”运算符描述“小于”。

“STARTSW”运算符描述“以…开头”。

“NSTARTSW”运算符描述“不以…开头”。

“ENDSW”运算符描述“以…结尾”。

“NENDSW”运算符描述“不以…结尾”。

“CONTAINS”运算符描述“包含”。

“NCONTAINS”运算符描述“不包含”。

filterType

字符串

FilterType 查询参数。所有筛选条件通用的逻辑运算符默认为 AND,并且可以通过使用此参数来更改。

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

page

整数

页面查询参数。页码。

size

整数

大小查询参数。每页返回的对象数。

sort

字符串

排序查询参数。排序类型 - asc 或 desc。

sortBy

字符串

SortBy 查询参数。需要对其排序的对象排序的列。

说明

注意

  • 使用的 SDK 方法是 certificates.Certificates.get_trusted_certificate_by_id, certificates.Certificates.get_trusted_certificates_generator,

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

  • 支持 check_mode

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

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

另请参阅

另请参阅

有关证书的 Cisco ISE 文档

证书 API 的完整参考。

示例

- name: Get all Trusted Certificate
  cisco.ise.trusted_certificate_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    page: 0
    size: 0
    sort: string
    sortBy: string
    filter: string
    filterType: string
  register: result

- name: Get Trusted Certificate by id
  cisco.ise.trusted_certificate_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 返回的响应

已返回:始终

示例: {"authenticateBeforeCRLReceived": "string", "automaticCRLUpdate": "string", "automaticCRLUpdatePeriod": "string", "automaticCRLUpdateUnits": "string", "crlDistributionUrl": "string", "crlDownloadFailureRetries": "string", "crlDownloadFailureRetriesUnits": "string", "description": "string", "downloadCRL": "string", "enableOCSPValidation": "string", "enableServerIdentityCheck": "string", "expirationDate": "string", "friendlyName": "string", "id": "string", "ignoreCRLExpiration": "string", "internalCA": true, "isReferredInPolicy": true, "issuedBy": "string", "issuedTo": "string", "keySize": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "nonAutomaticCRLUpdatePeriod": "string", "nonAutomaticCRLUpdateUnits": "string", "rejectIfNoStatusFromOCSP": "string", "rejectIfUnreachableFromOCSP": "string", "selectedOCSPService": "string", "serialNumberDecimalFormat": "string", "sha256Fingerprint": "string", "signatureAlgorithm": "string", "status": "string", "subject": "string", "trustedFor": "string", "validFrom": "string"}

ise_responses

列表 / 元素=字典

在 cisco.ise 1.1.0 中添加

一个字典或列表,其中包含 Cisco ISE Python SDK 返回的响应

已返回:始终

示例: "[\n  {\n    \"authenticateBeforeCRLReceived\": \"string\",\n    \"automaticCRLUpdate\": \"string\",\n    \"automaticCRLUpdatePeriod\": \"string\",\n    \"automaticCRLUpdateUnits\": \"string\",\n    \"crlDistributionUrl\": \"string\",\n    \"crlDownloadFailureRetries\": \"string\",\n    \"crlDownloadFailureRetriesUnits\": \"string\",\n    \"description\": \"string\",\n    \"downloadCRL\": \"string\",\n    \"enableOCSPValidation\": \"string\",\n    \"enableServerIdentityCheck\": \"string\",\n    \"expirationDate\": \"string\",\n    \"friendlyName\": \"string\",\n    \"id\": \"string\",\n    \"ignoreCRLExpiration\": \"string\",\n    \"internalCA\": true,\n    \"isReferredInPolicy\": true,\n    \"issuedBy\": \"string\",\n    \"issuedTo\": \"string\",\n    \"keySize\": \"string\",\n    \"link\": {\n      \"href\": \"string\",\n      \"rel\": \"string\",\n      \"type\": \"string\"\n    },\n    \"nonAutomaticCRLUpdatePeriod\": \"string\",\n    \"nonAutomaticCRLUpdateUnits\": \"string\",\n    \"rejectIfNoStatusFromOCSP\": \"string\",\n    \"rejectIfUnreachableFromOCSP\": \"string\",\n    \"selectedOCSPService\": \"string\",\n    \"serialNumberDecimalFormat\": \"string\",\n    \"sha256Fingerprint\": \"string\",\n    \"signatureAlgorithm\": \"string\",\n    \"status\": \"string\",\n    \"subject\": \"string\",\n    \"trustedFor\": \"string\",\n    \"validFrom\": \"string\"\n  }\n]\n"

作者

  • Rafael Campos (@racampos)