cisco.ise.guest_user_suspend 模块 – 用于访客用户暂停的资源模块

注意

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

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

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

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

cisco.ise 1.0.0 中的新功能

概要 

管理资源“访客用户暂停”的更新操作。
此 API 允许客户端按 ID 暂停访客用户。
此 API 允许客户端按名称暂停访客用户。

注意

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

要求 

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

ciscoisesdk >= 2.2.3
python >= 3.5

参数 

参数	注释
additionalData 列表 / 元素=字典	访客用户暂停的 additionalData。
name 字符串	访客用户暂停的名称。
value 字符串	访客用户暂停的值。
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` ← (默认)
name 字符串	名称路径参数。

说明 

注意

使用的 SDK 方法是 guest_user.GuestUser.suspend_guest_user_by_id、guest_user.GuestUser.suspend_guest_user_by_name，
使用的路径是 put /ers/config/guestuser/suspend/name/{name}、put /ers/config/guestuser/suspend/{id}，
不支持 check_mode
该插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用 Cisco ISE SDK 中的嵌入式连接管理器
以 ise_ 开头的参数由 Cisco ISE Python SDK 用于建立连接

示例 

- name: Update by name
  cisco.ise.guest_user_suspend:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    name: string

- name: Update by id
  cisco.ise.guest_user_suspend:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    additionalData:
    - name: reason
      value: reason
    id: string

返回值 

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

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

作者

Rafael Campos (@racampos)