cisco.ise.native_supplicant_profile_info 模块 – 本地客户端配置文件信息模块

注意

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

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

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

要在剧本中使用它,请指定: cisco.ise.native_supplicant_profile_info

cisco.ise 1.0.0 中的新增功能

概要

  • 获取所有本地客户端配置文件。

  • 按 ID 获取本地客户端配置文件。

  • 此 API 允许客户端按 ID 获取本地客户端配置文件。

  • 此 API 允许客户端获取所有本地客户端配置文件。

注意

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

要求

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

  • ciscoisesdk >= 2.2.3

  • python >= 3.5

参数

参数

注释

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

整数

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

备注

注意

  • 使用的 SDK 方法为 native_supplicant_profile.NativeSupplicantProfile.get_native_supplicant_profile_by_id、native_supplicant_profile.NativeSupplicantProfile.get_native_supplicant_profile_generator,

  • 使用的路径为 get /ers/config/nspprofile、get /ers/config/nspprofile/{id},

  • 支持 check_mode

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

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

另请参阅

另请参阅

Cisco ISE 本地客户端配置文件文档

本地客户端配置文件 API 的完整参考。

示例

- name: Get all Native Supplicant Profile
  cisco.ise.native_supplicant_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 Native Supplicant Profile by id
  cisco.ise.native_supplicant_profile_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 返回的响应的字典或列表

返回: 始终

示例: {"description": "字符串", "id": "字符串", "link": {"href": "字符串", "rel": "字符串", "type": "字符串"}, "name": "字符串", "wirelessProfiles": [{"actionType": "字符串", "allowedProtocol": "字符串", "certificateTemplateId": "字符串", "previousSsid": "字符串", "ssid": "字符串"}]}

ise_responses

列表 / 元素=字典

在 cisco.ise 1.1.0 中添加

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

返回: 始终

示例: "[\n  {\n    \"id\": \"字符串\",\n    \"name\": \"字符串\",\n    \"description\": \"字符串\",\n    \"wirelessProfiles\": [\n      {\n        \"ssid\": \"字符串\",\n        \"allowedProtocol\": \"字符串\",\n        \"certificateTemplateId\": \"字符串\",\n        \"actionType\": \"字符串\",\n        \"previousSsid\": \"字符串\"\n      }\n    ],\n    \"link\": {\n      \"rel\": \"字符串\",\n      \"href\": \"字符串\",\n      \"type\": \"字符串\"\n    }\n  }\n]\n"

作者

  • Rafael Campos (@racampos)