cisco.ise.sponsor_portal_info 模块 – Sponsor Portal 信息模块
注意
此模块是 cisco.ise 集合（版本 2.9.6）的一部分。
如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.ise。您需要更多要求才能使用此模块，请参阅 要求 了解详细信息。
要在 playbook 中使用它，请指定：cisco.ise.sponsor_portal_info。
cisco.ise 1.0.0 中的新增功能
概要
获取所有 Sponsor Portal。
通过 id 获取 Sponsor Portal。
此 API 允许客户端通过 ID 获取 sponsor portal。
此 API 允许客户端获取所有 sponsor portal。
注意
此模块有一个对应的 操作插件。
要求
执行此模块的主机需要满足以下要求。
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 方法是 sponsor_portal.SponsorPortal.get_sponsor_portal_by_id, sponsor_portal.SponsorPortal.get_sponsor_portal_generator,
使用的路径是 get /ers/config/sponsorportal, get /ers/config/sponsorportal/{id},
支持
check_mode该插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用 Cisco ISE SDK 中的嵌入式连接管理器
以 ise_ 开头的参数由 Cisco ISE Python SDK 用于建立连接
示例
- name: Get all Sponsor Portal
cisco.ise.sponsor_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 Sponsor Portal by id
cisco.ise.sponsor_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 返回的响应 返回： 总是 示例： |