cisco.ise.system_certificate_info 模块 – 系统证书信息模块

注意

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

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

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

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

cisco.ise 1.0.0 中的新增功能

摘要

  • 按 ID 获取系统证书。

  • 按名称获取系统证书。

  • 此 API 基于给定的主机名和 ID 提供特定节点的系统证书的详细信息。

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

注意

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

要求

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

  • ciscoisesdk >= 2.2.3

  • python >= 3.5

参数

参数

注释

filter

字符串

过滤器查询参数。.. 容器 **简单过滤** 应该可以通过过滤器查询字符串参数实现。过滤器的结构是用点分隔的字段运算符和值的三元组。可以发送多个过滤器。默认情况下,所有过滤器条件的逻辑运算符都是 AND,可以通过使用 *”filterType=or”* 查询字符串参数来更改。

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

“EQ”运算符表示“等于”。

“NEQ”运算符表示“不等于”。

“GT”运算符表示“大于”。

“LT”运算符表示“小于”。

“STARTSW”运算符表示“以…开头”。

“NSTARTSW”运算符表示“不以…开头”。

“ENDSW”运算符表示“以…结尾”。

“NENDSW”运算符表示“不以…结尾”。

“CONTAINS”运算符表示“包含”。

“NCONTAINS”运算符表示“不包含”。

filterType

字符串

FilterType 查询参数。默认情况下,所有过滤器条件的逻辑运算符都是 AND,可以通过使用此参数来更改。

hostName

字符串

HostName 路径参数。应返回系统证书的主机名称。

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

整数

Page 查询参数。页码。

size

整数

Size 查询参数。每页返回的对象数量。

sort

字符串

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

sortBy

字符串

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

注释

注意

  • 使用的 SDK 方法是 certificates.Certificates.get_system_certificate_by_id、certificates.Certificates.get_system_certificates,

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

  • 支持 check_mode

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

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

参见

另请参见

思科ISE证书文档

证书API的完整参考。

示例

- name: Get System Certificate by id
  cisco.ise.system_certificate_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    hostName: string
    id: string
  register: result

- name: Get System Certificate by name
  cisco.ise.system_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
    hostName: string
  register: result

返回值

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

描述

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_responses

列表 / 元素=字典

在 cisco.ise 1.1.0 中添加

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

返回:始终

示例: "[\n  {\n    \"expirationDate\": \"string\",\n    \"friendlyName\": \"string\",\n    \"groupTag\": \"string\",\n    \"id\": \"string\",\n    \"issuedBy\": \"string\",\n    \"issuedTo\": \"string\",\n    \"keySize\": 0,\n    \"link\": {\n      \"href\": \"string\",\n      \"rel\": \"string\",\n      \"type\": \"string\"\n    },\n    \"portalsUsingTheTag\": \"string\",\n    \"selfSigned\": true,\n    \"serialNumberDecimalFormat\": \"string\",\n    \"sha256Fingerprint\": \"string\",\n    \"signatureAlgorithm\": \"string\",\n    \"usedBy\": \"string\",\n    \"validFrom\": \"string\"\n  }\n]\n"

作者

  • Rafael Campos (@racampos)