cisco.ise.endpoint_info 模块 – 端点信息模块
注意
此模块是 cisco.ise 集合(版本 2.9.6)的一部分。
如果您正在使用 ansible
包,您可能已经安装了此集合。它不包含在 ansible-core
中。要检查是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install cisco.ise
。您需要进一步的要求才能使用此模块,有关详细信息,请参阅要求。
要在 playbook 中使用它,请指定:cisco.ise.endpoint_info
。
cisco.ise 1.0.0 中的新增功能
概要
获取所有端点。
按 ID 获取端点。
按名称获取端点。
此 API 允许客户端获取所有端点。
此 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 路径参数。 |
|
用于标识服务引擎 SDK 启用调试的标志。 选择
|
|
标识服务引擎主机名。 |
|
用于身份验证的标识服务引擎密码。 |
|
RESTful HTTP 请求的超时时间(以秒为单位)。 默认值: |
|
用于身份验证的标识服务引擎用户名。 |
|
指示 SDK 是否将 CSRF 令牌发送到 ISE 的 ERS API 的标志。 如果为 True,则 SDK 假定您的 ISE CSRF 检查已启用。 如果为 True,它会假定您需要 SDK 为您自动管理 CSRF 令牌。 选择
|
|
启用或禁用 SSL 证书验证的标志。 选择
|
|
通知 SDK 使用哪个版本的标识服务引擎。 默认值: |
|
用于标识服务引擎 SDK 启用自动速率限制处理的标志。 选择
|
|
Name 路径参数。 |
|
Page 查询参数。页码。 |
|
Size 查询参数。每页返回的对象数。 |
|
Sortasc 查询参数。按升序排序。 |
|
Sortdsc 查询参数。按降序排序。 |
注释
注意
使用的 SDK 方法是 endpoint.Endpoint.get_endpoint_by_id、endpoint.Endpoint.get_endpoint_by_name、endpoint.Endpoint.get_endpoints_generator。
使用的路径是 get /ers/config/endpoint、get /ers/config/endpoint/name/{name}、get /ers/config/endpoint/{id}。
支持
check_mode
该插件在控制节点上运行,不使用任何 ansible 连接插件,而是使用 Cisco ISE SDK 中的嵌入式连接管理器
以 ise_ 开头的参数由 Cisco ISE Python SDK 用于建立连接
示例
- name: Get all Endpoint
cisco.ise.endpoint_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 Endpoint by id
cisco.ise.endpoint_info:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
id: string
register: result
- name: Get Endpoint by name
cisco.ise.endpoint_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 返回的响应的字典或列表 返回: 总是 示例: |