cisco.ise.sponsored_guest_portal_info 模块 – 赞助访客门户的信息模块
注意
此模块是 cisco.ise 集合（版本 2.9.6）的一部分。
如果您正在使用 ansible 包，您可能已经安装了此集合。 它不包含在 ansible-core 中。 要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.ise。 您需要更多要求才能使用此模块，有关详细信息，请参阅要求。
要在剧本中使用它，请指定：cisco.ise.sponsored_guest_portal_info。
cisco.ise 1.0.0 中的新增功能
概要
获取所有赞助访客门户。
按 ID 获取赞助访客门户。
此 API 允许客户端按 ID 获取赞助访客门户。
此 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 方法为 sponsored_guest_portal.SponsoredGuestPortal.get_sponsored_guest_portal_by_id、sponsored_guest_portal.SponsoredGuestPortal.get_sponsored_guest_portals_generator，
使用的路径为 get /ers/config/sponsoredguestportal、get /ers/config/sponsoredguestportal/{id}，
支持
check_mode该插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用来自 Cisco ISE SDK 的嵌入式连接管理器
以 ise_ 开头的参数由 Cisco ISE Python SDK 用于建立连接
示例
- name: Get all Sponsored Guest Portal
cisco.ise.sponsored_guest_portal_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 Sponsored Guest Portal by id
cisco.ise.sponsored_guest_portal_info:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
id: string
register: result
返回值
常见的返回值记录在此处，以下是此模块特有的字段
键 |
描述 |
|---|---|
一个字典或列表，其中包含 Cisco ISE Python SDK 返回的响应 返回： 始终 示例： |
|
一个字典或列表，其中包含 Cisco ISE Python SDK 返回的响应 返回： 始终 示例： |