cisco.ise.csr_info 模块 – 用于 CSR 的信息模块
注意
此模块是 cisco.ise 集合（版本 2.9.6）的一部分。
如果您使用的是 ansible 包，您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.ise。您需要满足其他要求才能使用此模块，请参阅 要求 了解详细信息。
要在剧本中使用它，请指定：cisco.ise.csr_info。
cisco.ise 1.0.0 中的新增功能
概要
获取所有 CSR。
通过 ID 获取 CSR。
此 API 显示给定主机名和 ID 的特定节点的证书签名请求的详细信息。
此 API 支持筛选、排序和分页。
注意
此模块具有相应的 操作插件。
要求
执行此模块的主机上需要满足以下要求。
ciscoisesdk >= 2.2.3
python >= 3.5
参数
参数 |
注释 |
|---|---|
筛选查询参数。 .. 容器**简单筛选**应该可以通过筛选查询字符串参数进行访问。筛选器的结构是字段、运算符和值的三元组，以点分隔。可以发送多个筛选器。所有筛选条件的逻辑运算符默认为 AND，可以通过使用 *”filterType=or”* 查询字符串参数来更改。 每个资源数据模型描述都应指定一个属性是否为筛选字段。 “EQ”运算符描述“等于”。 “NEQ”运算符描述“不等于”。 “GT”运算符描述“大于”。 “LT”运算符描述“小于”。 “STARTSW”运算符描述“以...开头”。 “NSTARTSW”运算符描述“不以...开头”。 “ENDSW”运算符描述“以...结尾”。 “NENDSW”运算符描述“不以...结尾”。 “CONTAINS”运算符描述“包含”。 “NCONTAINS”运算符描述“不包含”。 |
|
FilterType 查询参数。所有筛选条件的逻辑运算符默认为 AND，可以使用此参数更改。 |
|
HostName 路径参数。应该返回其 CSR 的主机名称。 |
|
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 的标志，用于启用自动速率限制处理。 选项
|
|
页码查询参数。页码。 |
|
大小查询参数。每页返回的对象数量。 |
|
排序查询参数。排序类型 - asc 或 desc。 |
|
排序依据查询参数。对象需要排序的排序依据列。 |
备注
注意
使用的 SDK 方法为 certificates.Certificates.get_csr_by_id, certificates.Certificates.get_csrs_generator,
使用的路径为 get /api/v1/certs/certificate-signing-request, get /api/v1/certs/certificate-signing-request/{hostName}/{id},
支持
check_mode该插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用 Cisco ISE SDK 中的嵌入式连接管理器
以 ise_ 开头的参数由 Cisco ISE Python SDK 用于建立连接
另请参阅
另请参阅
- Cisco ISE 证书文档
证书 API 的完整参考。
示例
- name: Get all CSR
cisco.ise.csr_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 CSR by id
cisco.ise.csr_info:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
hostName: string
id: string
register: result
返回值
常见返回值记录在此处，以下是此模块特有的字段
键 |
描述 |
|---|---|
一个字典或列表，其中包含 Cisco ISE Python SDK 返回的响应 返回： 始终 示例： |
|
一个字典或列表，其中包含 Cisco ISE Python SDK 返回的响应 返回： 始终 示例： |