cisco.ise.system_certificate_info 模块 – 系统证书信息模块
注意
此模块是 cisco.ise 集合 (版本 2.9.6) 的一部分。
如果您正在使用 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.ise。您需要其他需求才能使用此模块，请参阅 需求 获取详细信息。
要在剧本中使用它，请指定：cisco.ise.system_certificate_info。
cisco.ise 1.0.0 中的新增功能
概要
按 ID 获取系统证书。
按名称获取系统证书。
此 API 根据给定的主机名和 ID 提供特定节点的系统证书的详细信息。
此 API 支持过滤、排序和分页。
注意
此模块具有相应的 action 插件。
需求
执行此模块的主机需要以下需求。
ciscoisesdk >= 2.2.3
python >= 3.5
参数
参数 |
注释 |
|---|---|
过滤器查询参数。.. 容器 **简单过滤** 应通过过滤器查询字符串参数提供。过滤器的结构是由点分隔的字段运算符和值的三个组合。可以发送多个过滤器。所有过滤器条件的逻辑运算符默认为 AND，可以使用 *”filterType=or”* 查询字符串参数更改。 每个资源数据模型描述应指定属性是否为已过滤字段。 “EQ”运算符表示“等于”。 “NEQ”运算符表示“不等于”。 “GT”运算符表示“大于”。 “LT”运算符表示“小于”。 “STARTSW”运算符表示“以…开头”。 “NSTARTSW”运算符表示“不以…开头”。 “ENDSW”运算符表示“以…结尾”。 “NENDSW”运算符表示“不以…结尾”。 “CONTAINS”运算符表示“包含”。 “NCONTAINS”运算符表示“不包含”。 |
|
FilterType 查询参数。所有过滤器条件的逻辑运算符默认为 AND，可以使用此参数更改。 |
|
HostName 路径参数。应返回系统证书的主机名称。 |
|
Id 路径参数。系统证书的 ID。 |
|
用于 Identity Services Engine SDK 以启用调试。 选项
|
|
Identity Services Engine 主机名。 |
|
用于身份验证的 Identity Services Engine 密码。 |
|
RESTful HTTP 请求的超时（以秒为单位）。 默认值： |
|
用于身份验证的 Identity Services Engine 用户名。 |
|
告知 SDK 我们是否将 CSRF 令牌发送到 ISE 的 ERS API 的标志。 如果为 True，则 SDK 假设您的 ISE CSRF 检查已启用。 如果为 True，则假定您需要 SDK 为您自动管理 CSRF 令牌。 选项
|
|
启用或禁用 SSL 证书验证的标志。 选项
|
|
告知 SDK 使用哪个版本的 Identity Services Engine。 默认值： |
|
用于 Identity Services Engine SDK 以启用自动速率限制处理的标志。 选项
|
|
Page 查询参数。页码。 |
|
Size 查询参数。每页返回的对象数。 |
|
Sort 查询参数。排序类型 - asc 或 desc。 |
|
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 用于建立连接。
参见
另请参见
- Cisco 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
返回值
常见的返回值已在 此处 文档中说明，以下是此模块特有的字段：
键 |
描述 |
|---|---|
包含 Cisco ISE Python SDK 返回的响应的字典或列表。 返回值：始终返回 示例： |
|
包含 Cisco ISE Python SDK 返回的响应的字典或列表。 返回值：始终返回 示例： |