cisco.ise.native_supplicant_profile 模块 – 本地 Supplicant 配置文件资源模块

注意

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

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

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

要在 playbook 中使用它，请指定： cisco.ise.native_supplicant_profile。

cisco.ise 1.0.0 中新增

概要 

管理本地 Supplicant 配置文件的更新和删除操作。
此 API 删除本地 Supplicant 配置文件。
此 API 允许客户端更新本地 Supplicant 配置文件。

注意

此模块具有相应的 action 插件。

要求 

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

ciscoisesdk >= 2.2.3
python >= 3.5

参数 

参数	注释
description 字符串	本地 Supplicant 配置文件的描述。
id 字符串	本地 Supplicant 配置文件的 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` ← (默认)
name 字符串	本地 Supplicant 配置文件的名称。
wirelessProfiles 列表 / 元素=字典	本地 Supplicant 配置文件的 wirelessProfiles。
actionType 字符串	WifiProfile 的操作类型。允许的值 - ADD、- UPDATE、- DELETE（对于更新现有的 WirelessProfile 是必需的）。
allowedProtocol 字符串	本地 Supplicant 配置文件的 allowedProtocol。
certificateTemplateId 字符串	本地 Supplicant 配置文件的 certificateTemplateId。
previousSSID 字符串	WifiProfile 的上一个 ssid（对于更新现有的 WirelessProfile 是必需的）。
ssid 字符串	本地 Supplicant 配置文件的 ssid。

注释 

注意

使用的 SDK 方法是 native_supplicant_profile.NativeSupplicantProfile.delete_native_supplicant_profile_by_id、native_supplicant_profile.NativeSupplicantProfile.update_native_supplicant_profile_by_id，
使用的路径是 delete /ers/config/nspprofile/{id}，put /ers/config/nspprofile/{id}，
不支持 check_mode
插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco ISE SDK 中的嵌入式连接管理器。
以 `ise_` 开头的参数由 Cisco ISE Python SDK 用于建立连接。

参见 

另请参见

Cisco ISE 的 NativeSupplicantProfile 文档: NativeSupplicantProfile API 的完整参考。

示例 

- name: Update by id
  cisco.ise.native_supplicant_profile:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    description: string
    id: string
    name: string
    wirelessProfiles:
    - actionType: string
      allowedProtocol: string
      certificateTemplateId: string
      previousSsid: string
      ssid: string

- name: Delete by id
  cisco.ise.native_supplicant_profile:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: absent
    id: string

返回值 

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

键	描述
ise_response 字典	包含 Cisco ISE Python SDK 返回的响应的字典或列表。返回值：始终返回示例： `{"description": "string", "id": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "name": "string", "wirelessProfiles": [{"actionType": "string", "allowedProtocol": "string", "certificateTemplateId": "string", "previousSsid": "string", "ssid": "string"}]}`
ise_update_response 字典在 cisco.ise 1.1.0 中添加	包含 Cisco ISE Python SDK 返回的响应的字典或列表。返回值：始终返回示例： `{"UpdatedFieldsList": {"field": "string", "newValue": "string", "oldValue": "string", "updatedField": [{"field": "string", "newValue": "string", "oldValue": "string"}]}}`

作者

Rafael Campos (@racampos)