cisco.ise.trustsec_nbar_app_info 模块 – Trustsec NBAR 应用信息模块

注意

此模块是 cisco.ise 集合 (版本 2.9.6) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install cisco.ise。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。

要在剧本中使用它，请指定：cisco.ise.trustsec_nbar_app_info。

cisco.ise 2.0.0 中的新增功能

概要

  • 获取所有 Trustsec NBAR 应用。

  • 按 ID 获取 Trustsec NBAR 应用。

  • 按 ID 获取 NBAR 应用。

  • 获取所有 NBAR 应用。

注意

此模块具有相应的 操作插件。

要求

执行此模块的主机需要以下要求。

  • ciscoisesdk >= 2.2.3

  • python >= 3.5

参数

参数

注释

filter

字符串

过滤器查询参数。.. 容器 **简单过滤** 应可通过过滤器查询字符串参数使用。过滤器的结构是由字段、运算符和值组成的三元组，用点号分隔。可以发送多个过滤器。所有过滤器条件的逻辑运算符默认为 AND，可以通过使用 *“filterType=or”* 查询字符串参数来更改。

每个资源数据模型描述应指定属性是否为过滤字段。

‘EQ’ 运算符表示 ‘等于’。

‘NEQ’ 运算符表示 ‘不等于’。

‘GT’ 运算符表示 ‘大于’。

‘LT’ 运算符表示 ‘小于’。

‘STARTSW’ 运算符表示 ‘以…开头’。

‘NSTARTSW’ 运算符表示 ‘不以…开头’。

‘ENDSW’ 运算符表示 ‘以…结尾’。

‘NENDSW’ 运算符表示 ‘不以…结尾’。

‘CONTAINS’ 运算符表示 ‘包含’。

‘NCONTAINS’ 运算符表示 ‘不包含’。

filterType

字符串

FilterType 查询参数。所有过滤器条件的逻辑运算符默认为 AND，可以通过使用此参数来更改。

id

字符串

ID 路径参数。

ise_debug

布尔值

用于 Identity Services Engine SDK 的标志，用于启用调试。

选项

  • false ← (默认)

  • true

ise_hostname

字符串 / 必需

Identity Services Engine 主机名。

ise_password

字符串 / 必需

用于身份验证的 Identity Services Engine 密码。

ise_single_request_timeout

整数

在 cisco.ise 3.0.0 中添加

RESTful HTTP 请求的超时时间（以秒为单位）。

默认值： 60

ise_username

字符串 / 必需

用于身份验证的 Identity Services Engine 用户名。

ise_uses_api_gateway

布尔值

在 cisco.ise 1.1.0 中添加

告知 SDK 是否使用 Identity Services Engine 的 API 网关发送请求的标志。

如果为 true，则使用 ISE 的 API 网关并将请求发送到 https://{{ise_hostname}}。

如果为 false，则将请求发送到 https://{{ise_hostname}}:{{port}}，其中端口值取决于使用的服务（ERS、Mnt、UI、PxGrid）。

选项

  • false

  • true ← (默认)

ise_uses_csrf_token

布尔值

在 cisco.ise 3.0.0 中添加

告知 SDK 我们是否将 CSRF 令牌发送到 ISE 的 ERS API 的标志。

如果为 True，则 SDK 假设您的 ISE CSRF 检查已启用。

如果为 True，则假定您需要 SDK 为您自动管理 CSRF 令牌。

选项

  • false ← (默认)

  • true

ise_verify

布尔值

启用或禁用 SSL 证书验证的标志。

选项

  • false

  • true ← (默认)

ise_version

字符串

告知 SDK 使用哪个版本的 Identity Services Engine。

默认值： "3.1_Patch_1"

ise_wait_on_rate_limit

布尔值

用于 Identity Services Engine SDK 的标志，用于启用自动速率限制处理。

选项

  • false

  • true ← (默认)

page

整数

页面查询参数。页码。

size

整数

大小查询参数。每页返回的对象数量。

sort

字符串

排序查询参数。排序类型 - asc 或 desc。

sortBy

字符串

SortBy 查询参数。需要按其排序的对象的排序列。

备注

注意

  • 使用的 SDK 方法是 nbar_app.NbarApp.get_nbar_app_by_id、nbar_app.NbarApp.get_nbar_apps_generator，

  • 使用的路径为 get /api/v1/trustsec/sgacl/nbarapp, get /api/v1/trustsec/sgacl/nbarapp/{id},

  • 支持 check_mode

  • 该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco ISE SDK 中的嵌入式连接管理器。

  • 以 ise_ 开头的参数由 Cisco ISE Python SDK 用于建立连接。

另请参见

另请参见

Cisco ISE nbarApp 文档

nbarApp API 的完整参考。

示例

- name: Get all Trustsec NBAR App
  cisco.ise.trustsec_nbar_app_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    page: 0
    size: 0
    sort: string
    sortBy: string
    filter: string
    filterType: string
  register: result

- name: Get Trustsec NBAR App by id
  cisco.ise.trustsec_nbar_app_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    id: string
  register: result

返回值

常见的返回值已在 此处 记录，以下是此模块特有的字段。

键

描述

ise_response

列表 / 元素=字典

包含 Cisco ISE Python SDK 返回的响应的字典或列表。

返回值：始终返回

示例： "[\n  {\n    \"description\": \"string\",\n    \"id\": \"string\",\n    \"name\": \"string\",\n    \"networkIdentities\": [\n      {\n        \"ports\": \"string\",\n        \"protocol\": \"string\"\n      }\n    ]\n  }\n]\n"

ise_responses

列表 / 元素=字典

包含 Cisco ISE Python SDK 返回的响应的字典或列表。

返回值：始终返回

示例： "[\n  {\n    \"description\": \"string\",\n    \"id\": \"string\",\n    \"name\": \"string\",\n    \"networkIdentities\": [\n      {\n        \"ports\": \"string\",\n        \"protocol\": \"string\"\n      }\n    ]\n  }\n]\n"

作者

  • Rafael Campos (@racampos)