cisco.ise.certificate_profile_info 模块 – 证书配置文件信息模块

注意

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

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

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

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

cisco.ise 1.0.0 中的新增功能

概要 

获取所有证书配置文件。
按 ID 获取证书配置文件。
按名称获取证书配置文件。
此 API 允许客户端按 ID 获取证书配置文件。
此 API 允许客户端按名称获取证书配置文件。
此 API 允许客户端获取所有证书配置文件。

注意

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

要求 

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

ciscoisesdk >= 2.2.3
python >= 3.5

参数 

参数	注释
id 字符串	ID 路径参数。
ise_debug 布尔值	用于身份服务引擎 SDK 的标志，用于启用调试。选项 `false` ← (默认) `true`
ise_hostname 字符串 / 必需	身份服务引擎主机名。
ise_password 字符串 / 必需	用于身份验证的身份服务引擎密码。
ise_single_request_timeout 整数在 cisco.ise 3.0.0 中添加	RESTful HTTP 请求的超时时间（以秒为单位）。默认值： `60`
ise_username 字符串 / 必需	用于身份验证的身份服务引擎用户名。
ise_uses_api_gateway 布尔值在 cisco.ise 1.1.0 中添加	此标志告知 SDK 是否使用身份服务引擎的 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 使用哪个版本的身份服务引擎。默认值： `"3.1_Patch_1"`
ise_wait_on_rate_limit 布尔值	用于身份服务引擎 SDK 的标志，用于启用自动速率限制处理。选项 `false` `true` ← (默认)
name 字符串	名称路径参数。
page 整数	页面查询参数。页码。
size 整数	大小查询参数。每页返回的对象数量。

备注 

注意

使用的 SDK 方法为 certificate_profile.CertificateProfile.get_certificate_profile_by_id、certificate_profile.CertificateProfile.get_certificate_profile_by_name、certificate_profile.CertificateProfile.get_certificate_profile_generator，
使用的路径为 get /ers/config/certificateprofile、get /ers/config/certificateprofile/name/{name}、get /ers/config/certificateprofile/{id}，
支持 check_mode
插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco ISE SDK 中的嵌入式连接管理器
以 ise_ 开头的参数由 Cisco ISE Python SDK 用于建立连接

示例 

- name: Get all Certificate Profile
  cisco.ise.certificate_profile_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    page: 1
    size: 20
  register: result

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

- name: Get Certificate Profile by name
  cisco.ise.certificate_profile_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    name: string
  register: result

返回值 

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

键

描述

ise_response

字典

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

返回：始终

示例： {"allowedAsUserName": true, "certificateAttributeName": "string", "description": "string", "externalIdentityStoreName": "string", "id": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "matchMode": "string", "name": "string", "usernameFrom": "string"}

ise_responses

列表 / 元素=字典

在 cisco.ise 1.1.0 中添加

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

返回：始终

示例： "[\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"externalIdentityStoreName\": \"string\",\n \"certificateAttributeName\": \"string\",\n \"allowedAsUserName\": true,\n \"matchMode\": \"string\",\n \"usernameFrom\": \"string\",\n \"link\": {\n \"rel\": \"string\",\n \"href\": \"string\",\n \"type\": \"string\"\n }\n }\n]\n"

作者

Rafael Campos (@racampos)