cisco.ise.portal_info 模块 – 门户信息模块
注意
此模块是 cisco.ise 集合 (版本 2.9.6) 的一部分。
如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.ise。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。
要在 playbook 中使用它，请指定：cisco.ise.portal_info。
cisco.ise 1.0.0 中的新增功能
概要
获取所有门户。
按 ID 获取门户。
此 API 允许客户端按 ID 获取门户。
此 API 允许客户端获取所有门户。
注意
此模块具有相应的 action 插件。
要求
执行此模块的主机需要以下要求。
ciscoisesdk >= 2.2.3
python >= 3.5
参数
参数 |
注释 |
|---|---|
过滤器查询参数。**简单过滤**应通过过滤器查询字符串参数实现。过滤器的结构是由字段运算符和值组成的三元组，用点号分隔。可以发送多个过滤器。“filterType=or”查询字符串参数可以更改所有过滤器条件的逻辑运算符，默认为 AND。 每个资源数据模型描述应指定属性是否为已过滤字段。 ‘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 方法为 portal.Portal.get_portal_by_id、portal.Portal.get_portals_generator，
使用的路径为 get /ers/config/portal、get /ers/config/portal/{id}，
支持
check_mode该插件运行在控制节点上，不使用任何 Ansible 连接插件，而是使用 Cisco ISE SDK 中的嵌入式连接管理器。
以 `ise_` 开头的参数由 Cisco ISE Python SDK 用于建立连接。
示例
- name: Get all Portal
cisco.ise.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 Portal by id
cisco.ise.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 返回的响应字典或列表。 返回值：始终返回 示例： |