cisco.ise.node_info 模块 – 节点信息模块

注意

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

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

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

要在剧本中使用它,请指定:cisco.ise.node_info

cisco.ise 1.0.0 中的新增功能

概要

  • 获取所有节点。

  • 按 ID 获取节点。

  • 按名称获取节点。

  • 此 API 允许客户端获取所有节点详细信息。

  • 此 API 允许客户端按 ID 获取节点详细信息。

  • 此 API 允许客户端按名称获取节点详细信息。

注意

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

要求

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

  • 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 是否向 ISE 的 ERS API 发送 CSRF 令牌的标志。

如果为 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 ← (默认)

name

字符串

Name 路径参数。

page

整数

Page 查询参数。页码。

size

整数

Size 查询参数。每页返回的对象数。

备注

注意

  • 使用的 SDK 方法为 node_details.NodeDetails.get_node_detail_by_id, node_details.NodeDetails.get_node_detail_by_name, node_details.NodeDetails.get_node_details_generator,

  • 使用的路径为 get /ers/config/node, get /ers/config/node/name/{name}, get /ers/config/node/{id},

  • 支持 check_mode

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

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

另请参阅

另请参阅

有关 NodeDetails 的 Cisco ISE 文档

NodeDetails API 的完整参考。

示例

- name: Get all Node
  cisco.ise.node_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    page: 1
    size: 20
    filter: []
    filterType: AND
  register: result

- name: Get Node by id
  cisco.ise.node_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    id: string
  register: result

- name: Get Node by name
  cisco.ise.node_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    name: string
  register: result

返回值

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

描述

ise_response

字典

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

返回: 始终

示例: {"displayName": "string", "fqdn": "string", "gateWay": "string", "id": "string", "inDeployment": true, "ipAddress": "string", "ipAddresses": ["string"], "link": {"href": "string", "rel": "string", "type": "string"}, "name": "string", "nodeServiceTypes": "string", "otherPapFqdn": "string", "papNode": true, "passWord": "string", "primaryPapNode": true, "pxGridNode": true, "sxpIpAddress": "string", "userName": "string"}

ise_responses

列表 / 元素=字典

在 cisco.ise 1.1.0 中添加

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

返回: 始终

示例: "[\n  {\n    \"id\": \"string\",\n    \"name\": \"string\",\n    \"gateWay\": \"string\",\n    \"userName\": \"string\",\n    \"passWord\": \"string\",\n    \"displayName\": \"string\",\n    \"inDeployment\": true,\n    \"otherPapFqdn\": \"string\",\n    \"ipAddresses\": [\n      \"string\"\n    ],\n    \"ipAddress\": \"string\",\n    \"sxpIpAddress\": \"string\",\n    \"nodeServiceTypes\": \"string\",\n    \"fqdn\": \"string\",\n    \"papNode\": true,\n    \"primaryPapNode\": true,\n    \"pxGridNode\": true,\n    \"link\": {\n      \"rel\": \"string\",\n      \"href\": \"string\",\n      \"type\": \"string\"\n    }\n  }\n]\n"

作者

  • Rafael Campos (@racampos)