cisco.dnac.intent_network_devices_query_v1 module – Resource module for Intent Network Devices Query V1
Note
This module is part of the cisco.dnac collection (version 6.27.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
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.intent_network_devices_query_v1.
New in cisco.dnac 6.17.0
Synopsis
Manage operation create of the resource Intent Network Devices Query V1.
Returns the list of network devices, determined by the filters. It is possible to filter the network devices based on various parameters, such as device type, device role, software version, etc.
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 |
|---|---|
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: |
|
The Cisco DNA Center username to authenticate. Default: |
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Cisco DNA Center to use. Default: |
|
Intent Network Devices Query’s filter. |
|
Intent Network Devices Query’s filters. |
|
The key to filter by. |
|
The operator to use for filtering the values. |
|
Value to filter by. For `in` operator, the value should be a list of values. |
|
The logical operator to use for combining the filter criteria. If not provided, the default value is AND. |
|
Intent Network Devices Query’s page. |
|
The number of records to show for this page. Min 1, Max 500. |
|
The first record to show for this page; the first record is numbered 1. |
|
Intent Network Devices Query’s sortBy. |
|
The field to sort by. Default is hostname. |
|
The order to sort by. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
|
The specific views being requested. This is an optional parameter which can be passed to get one or more of the network device data. If this is not provided, then it will default to BASIC views. If multiple views are provided, the response will contain the union of the views. |
Notes
Note
SDK Method used are devices.Devices.query_network_devices_with_filters_v1,
Paths used are post /dna/intent/api/v1/networkDevices/query,
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 QueryNetworkDevicesWithFiltersV1
Complete reference of the QueryNetworkDevicesWithFiltersV1 API.
Examples
- name: Create
cisco.dnac.intent_network_devices_query_v1:
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}}"
filter:
filters:
- key: string
operator: string
value: {}
logicalOperator: string
page:
limit: 0
offset: 0
sortBy:
name: string
order: string
views:
- string
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: |