cisco.ise.endpoint_deregister 模块 – 用于端点注销的资源模块

注意

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

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

要安装它，请使用：ansible-galaxy collection install cisco.ise。您需要进一步的要求才能使用此模块，请参阅要求以了解详细信息。

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

cisco.ise 1.0.0 中的新增功能

概要 

管理资源端点注销的操作更新。
此 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` ← (默认)

注释 

注意

SDK 方法使用 endpoint.Endpoint.deregister_endpoint，
使用的路径是 put /ers/config/endpoint/{id}/deregister，
不支持 check_mode
该插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用来自 Cisco ISE SDK 的嵌入式连接管理器
以 ise_ 开头的参数由 Cisco ISE Python SDK 用于建立连接

示例 

- name: Update all
  cisco.ise.endpoint_deregister:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    id: string

返回值 

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

键	描述
ise_response 字典	一个字典或列表，其中包含 Cisco ISE Python SDK 返回的响应返回：始终示例： `{}`

作者

Rafael Campos (@racampos)