cisco.ise.guest_user_info 模块 – 访客用户信息模块
注意
此模块是 cisco.ise 集合（版本 2.9.6）的一部分。
如果您正在使用 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.ise。您需要进一步的要求才能使用此模块，请参阅 要求 了解详细信息。
要在 playbook 中使用它，请指定：cisco.ise.guest_user_info。
cisco.ise 1.0.0 中的新增功能
概要
获取所有访客用户。
通过 ID 获取访客用户。
通过名称获取访客用户。
此 API 允许客户端通过 ID 获取访客用户。
此 API 允许客户端通过名称获取访客用户。
此 API 允许客户端获取所有访客用户。
注意
此模块具有对应的 操作插件。
要求
执行此模块的主机上需要以下要求。
ciscoisesdk >= 2.2.3
python >= 3.5
参数
参数 |
注释 |
|---|---|
过滤器查询参数。**简单过滤**应通过过滤器查询字符串参数可用。过滤器的结构是字段、运算符和值的三元组，用点分隔。可以发送多个过滤器。所有过滤器条件通用的逻辑运算符默认将为 AND，并且可以通过使用“filterType=or”查询字符串参数来更改。 每个资源数据模型描述应指定属性是否为过滤字段。 “EQ”运算符描述“等于”。 “NEQ”运算符描述“不等于”。 “GT”运算符描述“大于”。 “LT”运算符描述“小于”。 “STARTSW”运算符描述“以...开始”。 “NSTARTSW”运算符描述“不以...开始”。 “ENDSW”运算符描述“以...结束”。 “NENDSW”运算符描述“不以...结束”。 “CONTAINS”运算符描述“包含”。 “NCONTAINS”运算符描述“不包含”。 |
|
FilterType 查询参数。所有过滤器条件通用的逻辑运算符默认将为 AND，并且可以通过使用该参数来更改。 |
|
ID 路径参数。 |
|
用于 Identity Services Engine SDK 启用调试的标志。 选择
|
|
Identity Services Engine 主机名。 |
|
用于身份验证的 Identity Services Engine 密码。 |
|
RESTful HTTP 请求的超时时间（以秒为单位）。 默认值： |
|
用于身份验证的 Identity Services Engine 用户名。 |
|
告知 SDK 我们是否将 CSRF 令牌发送到 ISE 的 ERS API 的标志。 如果为 True，则 SDK 假定您的 ISE CSRF 检查已启用。 如果为 True，则假定您需要 SDK 为您自动管理 CSRF 令牌。 选择
|
|
启用或禁用 SSL 证书验证的标志。 选择
|
|
告知 SDK 要使用哪个版本的 Identity Services Engine。 默认值： |
|
用于 Identity Services Engine SDK 启用自动速率限制处理的标志。 选择
|
|
名称路径参数。 |
|
页面查询参数。页码。 |
|
大小查询参数。每页返回的对象数。 |
|
Sortasc 查询参数。升序排序。 |
|
Sortdsc 查询参数。降序排序。 |
备注
注意
使用的 SDK 方法为：guest_user.GuestUser.get_guest_user_by_id, guest_user.GuestUser.get_guest_user_by_name, guest_user.GuestUser.get_guest_users_generator,
使用的路径为：get /ers/config/guestuser, get /ers/config/guestuser/name/{name}, get /ers/config/guestuser/{id},
支持
check_mode该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco ISE SDK 中的嵌入式连接管理器
以 ise_ 开头的参数由 Cisco ISE Python SDK 用于建立连接
示例
- name: Get all Guest User
cisco.ise.guest_user_info:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
page: 1
size: 20
sortasc: string
sortdsc: string
filter: []
filterType: AND
register: result
- name: Get Guest User by id
cisco.ise.guest_user_info:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
id: string
register: result
- name: Get Guest User by name
cisco.ise.guest_user_info:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
name: string
register: result
返回值
通用返回值在此处记录，以下是此模块特有的字段
键 |
描述 |
|---|---|
一个字典或列表，包含 Cisco ISE Python SDK 返回的响应 返回: 总是 示例: |
|
一个字典或列表，包含 Cisco ISE Python SDK 返回的响应 返回: 总是 示例: |