cisco.dnac.network_devices_interfaces_query module -- Resource module for Network Devices Interfaces Query
Note
This module is part of the cisco.dnac collection (version 6.28.0).
To install it, use: ansible-galaxy collection install cisco.dnac.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.dnac.network_devices_interfaces_query.
New in cisco.dnac 6.14.0
Synopsis
This module represents an alias of the module network_devices_interfaces_query_v2
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.4.9
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
DeviceId path parameter. Network Device Id. |
|
Flag for Cisco DNA Center SDK to enable debugging. Choices: |
|
The Cisco DNA Center hostname. |
|
The Cisco DNA Center password to authenticate. |
|
The Cisco DNA Center port. Default: :ansible-option-default:`443` |
|
The Cisco DNA Center username to authenticate. Default: :ansible-option-default:`"admin"` |
|
Flag to enable or disable SSL certificate verification. Choices: |
|
Informs the SDK which version of Cisco DNA Center to use. Default: :ansible-option-default:`"2.3.7.6"` |
|
UTC epoch timestamp in milliseconds. |
|
Network Devices Interfaces Query's query. |
|
Required field names, default ALL. |
|
Network Devices Interfaces Query's filters. |
|
Name of the field that the filter should be applied to. |
|
Supported operators are eq,in,like. |
|
Value of the field. |
|
Network Devices Interfaces Query's page. |
|
Number of records, Max is 1000. |
|
Record offset value, default 0. |
|
Network Devices Interfaces Query's orderBy. |
|
Name of the field used to sort. |
|
Possible values asc, des. |
|
UTC epoch timestamp in milliseconds. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices: |
Notes
Note
SDK Method used are devices.Devices.get_device_interface_stats_info_v2,
Paths used are post /dna/intent/api/v2/networkDevices/{deviceId}/interfaces/query,
It should be noted that this module is an alias of network_devices_interfaces_query_v2
Does not support
check_modeThe plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK
The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection
See Also
See also
- Cisco DNA Center documentation for Devices GetDeviceInterfaceStatsInfoV2
Complete reference of the GetDeviceInterfaceStatsInfoV2 API.
Examples
- name: Create
cisco.dnac.network_devices_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}}"
deviceId: string
endTime: 0
query:
fields:
- {}
filters:
- key: string
operator: string
value: string
page:
limit: 0
offset: 0
orderBy:
- name: string
order: string
startTime: 0
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|