cisco.ise.guest_user_info 模块 – 客人用户的信息模块
注意
此模块是 cisco.ise 集合 (版本 2.9.6) 的一部分。
如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.ise。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。
要在剧本中使用它，请指定：cisco.ise.guest_user_info。
cisco.ise 1.0.0 中的新增功能
概要
获取所有访客用户。
按 ID 获取访客用户。
按名称获取访客用户。
此 API 允许客户端按 ID 获取访客用户。
此 API 允许客户端按名称获取访客用户。
此 API 允许客户端获取所有访客用户。
注意
此模块具有相应的 操作插件。
要求
以下是执行此模块的主机所需的条件。
ciscoisesdk >= 2.2.3
python >= 3.5
参数
参数 |
注释 |
|---|---|
过滤器查询参数。**简单的过滤**应该可以通过过滤器查询字符串参数实现。过滤器的结构是由点分隔的字段、运算符和值的三元组。可以发送多个过滤器。“filterType=or”查询字符串参数可以更改默认情况下对所有过滤器条件都通用的逻辑运算符 AND。 每个资源数据模型描述都应指定属性是否为已过滤字段。 “EQ”运算符表示“等于”。 “NEQ”运算符表示“不等于”。 “GT”运算符表示“大于”。 “LT”运算符表示“小于”。 “STARTSW”运算符表示“以…开头”。 “NSTARTSW”运算符表示“不以…开头”。 “ENDSW”运算符表示“以…结尾”。 “NENDSW”运算符表示“不以…结尾”。 “CONTAINS”运算符表示“包含”。 “NCONTAINS”运算符表示“不包含”。 |
|
FilterType 查询参数。默认情况下，对所有过滤器条件都通用的逻辑运算符为 AND，可以使用此参数进行更改。 |
|
ID 路径参数。 |
|
用于身份服务引擎 SDK 以启用调试。 选项
|
|
身份服务引擎主机名。 |
|
身份服务引擎密码用于身份验证。 |
|
RESTful HTTP 请求的超时时间（以秒为单位）。 默认值： |
|
身份服务引擎用户名用于身份验证。 |
|
告知 SDK 我们是否将 CSRF 令牌发送到 ISE 的 ERS API 的标志。 如果为真，则 SDK 假设您的 ISE CSRF 检查已启用。 如果为真，则假定您需要 SDK 为您自动管理 CSRF 令牌。 选项
|
|
启用或禁用 SSL 证书验证的标志。 选项
|
|
告知 SDK 使用哪个版本的身份服务引擎。 默认值： |
|
用于身份服务引擎 SDK 以启用自动速率限制处理的标志。 选项
|
|
名称路径参数。 |
|
页面查询参数。页码。 |
|
Size 查询参数。每页返回的对象数量。 |
|
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 返回的响应字典或列表。 返回值：始终返回 示例： |