cisco.dnac.interfaces_query 模块 – 接口查询资源模块

注意

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

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

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

要在剧本中使用它,请指定:cisco.dnac.interfaces_query

cisco.dnac 6.15.0 中的新增功能

概要

  • 此模块表示模块 interfaces_query_v1 的别名。

注意

此模块具有相应的 action 插件

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

aggregateAttributes

列表 / 元素=字典

接口查询的 aggregateAttributes。

function

字符串

函数。

name

字符串

名称。

attributes

列表 / 元素=字符串

属性。

dnac_debug

布尔值

用于 Cisco DNA Center SDK 以启用调试的标志。

选项

  • false ← (默认)

  • true

dnac_host

字符串 / 必填

Cisco DNA Center 主机名。

dnac_password

字符串

用于身份验证的 Cisco DNA Center 密码。

dnac_port

整数

Cisco DNA Center 端口。

默认值: 443

dnac_username

别名:user

字符串

用于身份验证的 Cisco DNA Center 用户名。

默认值: "admin"

dnac_verify

布尔值

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

选项

  • false

  • true ← (默认)

dnac_version

字符串

告知 SDK 使用哪个版本的 Cisco DNA Center。

默认值: "2.3.7.6"

endTime

整数

结束时间。

filters

列表 / 元素=字典

接口查询的 filters。

filters

列表 / 元素=字典

接口查询的 filters。

filters

列表 / 元素=字符串

过滤器。

key

字符串

键。

logicalOperator

字符串

逻辑运算符。

operator

字符串

运算符。

value

字典

值。

key

字符串

键。

logicalOperator

字符串

逻辑运算符。

operator

字符串

运算符。

value

字典

值。

page

字典

接口查询的 page。

limit

整数

限制。

offset

整数

偏移量。

sortBy

列表 / 元素=字典

接口查询的 sortBy。

name

字符串

名称。

order

字符串

顺序。

startTime

整数

开始时间。

validate_response_schema

布尔值

用于 Cisco DNA Center SDK 以启用根据 JSON 模式验证请求体的标志。

选项

  • false

  • true ← (默认)

views

列表 / 元素=字符串

视图。

备注

注意

  • 使用的 SDK 方法是 devices.Devices.gets_the_list_of_interfaces_across_the_network_devices_based_on_the_provided_complex_filters_and_aggregation_functions_v1,

  • 使用的路径是 post /dna/data/api/v1/interfaces/query,

  • 需要注意的是,此模块是 interfaces_query_v1 的别名。

  • 不支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center 文档,了解 Devices GetsTheListOfInterfacesAcrossTheNetworkDevicesBasedOnTheProvidedComplexFiltersAndAggregationFunctionsV1。

GetsTheListOfInterfacesAcrossTheNetworkDevicesBasedOnTheProvidedComplexFiltersAndAggregationFunctionsV1 API 的完整参考。

示例

- name: Create
  cisco.dnac.interfaces_query:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    aggregateAttributes:
    - function: string
      name: string
    attributes:
    - string
    endTime: 0
    filters:
    - filters:
      - filters:
        - string
        key: string
        logicalOperator: string
        operator: string
        value: {}
      key: string
      logicalOperator: string
      operator: string
      value: {}
    page:
      limit: 0
      offset: 0
      sortBy:
      - name: string
        order: string
    startTime: 0
    views:
    - string

返回值

公共返回值已记录在 此处,以下是此模块特有的字段。

描述

dnac_response

字典

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

返回值: 始终

示例: {"page": {"count": 0, "limit": 0, "offset": 0, "sortBy": [{"name": "string", "order": "string"}]}, "response": [{"adminStatus": "string", "aggregateAttributes": [{"name": "string", "values": [{"key": "string", "value": 0}]}], "description": "string", "duplexConfig": "string", "duplexOper": "string", "id": "string", "interfaceIfIndex": 0, "interfaceType": "string", "ipv4Address": "string", "ipv6AddressList": ["string"], "isL3Interface": true, "isWan": true, "macAddr": "string", "mediaType": "string", "name": "string", "networkDeviceId": "string", "networkDeviceIpAddress": "string", "networkDeviceMacAddress": "string", "operStatus": "string", "peerStackMember": 0, "peerStackPort": "string", "portChannelId": "string", "portMode": "string", "portType": "string", "rxDiscards": 0, "rxError": 0, "rxRate": 0, "rxUtilization": 0, "siteHierarchy": "string", "siteHierarchyId": "string", "siteName": "string", "speed": "string", "stackPortType": "string", "timestamp": 0, "txDiscards": 0, "txError": 0, "txRate": 0, "txUtilization": 0, "vlanId": "string"}], "version": "string"}

作者

  • Rafael Campos (@racampos)