cisco.ise.network_device_info 模块 – 网络设备信息模块

注意

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

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

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

要在 playbook 中使用它,请指定: cisco.ise.network_device_info

cisco.ise 1.0.0 中的新增功能

概要

  • 获取所有网络设备。

  • 按 ID 获取网络设备。

  • 按名称获取网络设备。

  • 此 API 允许客户端按 ID 获取网络设备。

  • 此 API 允许客户端按名称获取网络设备。

  • 此 API 允许客户端获取所有网络设备。

注意

此模块具有相应的 action 插件

要求

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

  • ciscoisesdk >= 2.2.3

  • python >= 3.5

参数

参数

注释

filter

列表 / 元素=字符串

过滤器查询参数。**简单过滤**应该可以通过过滤器查询字符串参数实现。过滤器的结构是由点分隔的字段运算符和值的三个部分。可以发送多个过滤器。“filterType=or”查询字符串参数可以更改所有过滤器条件的逻辑运算符,默认为 AND。

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

“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 ← (默认)

name

字符串

名称路径参数。

page

整数

页面查询参数。页码。

size

整数

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

sortasc

字符串

Sortasc 查询参数。升序排序。

sortdsc

字符串

Sortdsc 查询参数。降序排序。

注释

注意

  • 使用的SDK方法包括:network_device.NetworkDevice.get_network_device_by_id、network_device.NetworkDevice.get_network_device_by_name、network_device.NetworkDevice.get_network_device_generator。

  • 使用的路径包括:get /ers/config/networkdevice、get /ers/config/networkdevice/name/{name}、get /ers/config/networkdevice/{id}。

  • 支持 check_mode

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

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

示例

- name: Get all Network Device
  cisco.ise.network_device_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 Network Device by id
  cisco.ise.network_device_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    id: string
  register: result

- name: Get Network Device by name
  cisco.ise.network_device_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返回的响应的字典或列表。

返回值:始终返回

示例: {"NetworkDeviceGroupList": ["string"], "NetworkDeviceIPList": [{"getIpaddressExclude": "string", "ipaddress": "string", "mask": 0}], "authenticationSettings": {"dtlsRequired": true, "enableKeyWrap": true, "enableMultiSecret": "string", "enabled": true, "keyEncryptionKey": "string", "keyInputFormat": "string", "messageAuthenticatorCodeKey": "string", "networkProtocol": "string", "radiusSharedSecret": "string", "secondRadiusSharedSecret": "string"}, "coaPort": 0, "description": "string", "dtlsDnsName": "string", "id": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "modelName": "string", "name": "string", "profileName": "string", "snmpsettings": {"linkTrapQuery": true, "macTrapQuery": true, "originatingPolicyServicesNode": "string", "pollingInterval": 0, "roCommunity": "string", "version": "string"}, "softwareVersion": "string", "tacacsSettings": {"connectModeOptions": "string", "sharedSecret": "string"}, "trustsecsettings": {"deviceAuthenticationSettings": {"sgaDeviceId": "string", "sgaDevicePassword": "string"}, "deviceConfigurationDeployment": {"enableModePassword": "string", "execModePassword": "string", "execModeUsername": "string", "includeWhenDeployingSGTUpdates": true}, "pushIdSupport": true, "sgaNotificationAndUpdates": {"coaSourceHost": "string", "downlaodEnvironmentDataEveryXSeconds": 0, "downlaodPeerAuthorizationPolicyEveryXSeconds": 0, "downloadSGACLListsEveryXSeconds": 0, "otherSGADevicesToTrustThisDevice": true, "reAuthenticationEveryXSeconds": 0, "sendConfigurationToDevice": true, "sendConfigurationToDeviceUsing": "string"}}}

ise_responses

列表 / 元素=字典

在 cisco.ise 1.1.0 中添加

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

返回值:始终返回

示例: "[\n  {\n    \"id\": \"string\",\n    \"name\": \"string\",\n    \"description\": \"string\",\n    \"authenticationSettings\": {\n      \"networkProtocol\": \"string\",\n      \"secondRadiusSharedSecret\": \"string\",\n      \"radiusSharedSecret\": \"string\",\n      \"enableKeyWrap\": true,\n      \"enabled\": true,\n      \"dtlsRequired\": true,\n      \"enableMultiSecret\": \"string\",\n      \"keyEncryptionKey\": \"string\",\n      \"messageAuthenticatorCodeKey\": \"string\",\n      \"keyInputFormat\": \"string\"\n    },\n    \"snmpsettings\": {\n      \"version\": \"string\",\n      \"roCommunity\": \"string\",\n      \"pollingInterval\": 0,\n      \"linkTrapQuery\": true,\n      \"macTrapQuery\": true,\n      \"originatingPolicyServicesNode\": \"string\"\n    },\n    \"trustsecsettings\": {\n      \"deviceAuthenticationSettings\": {\n        \"sgaDeviceId\": \"string\",\n        \"sgaDevicePassword\": \"string\"\n      },\n      \"sgaNotificationAndUpdates\": {\n        \"downlaodEnvironmentDataEveryXSeconds\": 0,\n        \"downlaodPeerAuthorizationPolicyEveryXSeconds\": 0,\n        \"reAuthenticationEveryXSeconds\": 0,\n        \"downloadSGACLListsEveryXSeconds\": 0,\n        \"otherSGADevicesToTrustThisDevice\": true,\n        \"sendConfigurationToDevice\": true,\n        \"sendConfigurationToDeviceUsing\": \"string\",\n        \"coaSourceHost\": \"string\"\n      },\n      \"deviceConfigurationDeployment\": {\n        \"includeWhenDeployingSGTUpdates\": true,\n        \"enableModePassword\": \"string\",\n        \"execModePassword\": \"string\",\n        \"execModeUsername\": \"string\"\n      },\n      \"pushIdSupport\": true\n    },\n    \"tacacsSettings\": {\n      \"sharedSecret\": \"string\",\n      \"connectModeOptions\": \"string\"\n    },\n    \"profileName\": \"string\",\n    \"coaPort\": 0,\n    \"dtlsDnsName\": \"string\",\n    \"modelName\": \"string\",\n    \"softwareVersion\": \"string\",\n    \"NetworkDeviceIPList\": [\n      {\n        \"ipaddress\": \"string\",\n        \"mask\": 0,\n        \"getIpaddressExclude\": \"string\"\n      }\n    ],\n    \"NetworkDeviceGroupList\": [\n      \"string\"\n    ],\n    \"link\": {\n      \"rel\": \"string\",\n      \"href\": \"string\",\n      \"type\": \"string\"\n    }\n  }\n]\n"

作者

  • Rafael Campos (@racampos)