cisco.catalystcenter.intent_network_devices_query module -- Resource module for Intent Network Devices Query
Note
This module is part of the cisco.catalystcenter collection (version 2.11.0).
To install it, use: ansible-galaxy collection install cisco.catalystcenter.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.catalystcenter.intent_network_devices_query.
New in cisco.catalystcenter 2.0.0
Synopsis
Manage operation create of the resource Intent Network Devices Query.
Returns the list of network devices, determined by the filters. It is possible.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
catalystcentersdk >= 3.2.3.0.0
python >= 3.12
Parameters
Parameter |
Comments |
|---|---|
Flag for Cisco Catalyst Center SDK to enable debugging. Choices: |
|
The Cisco Catalyst Center hostname. |
|
The Cisco Catalyst Center password to authenticate. |
|
The Cisco Catalyst Center port. Default: :ansible-option-default:`443` |
|
The Cisco Catalyst 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 Catalyst Center to use. Default: :ansible-option-default:`"3.1.6.0"` |
|
Filter to query network devices. The result will contain the network devices that match ALL the filter criteria (AND condition) unless specified in 'logicalOperator'. Total number of filter criteria should not exceed 20. |
|
List of filter criteria to query network devices. |
|
The key to filter by. |
|
The operator to use for filtering the values. * `eq` - The result will contain the network devices that match the exact value. * `contains` - The result will contain the network devices that contain the value. * `in` - The result will contain the network devices that match any of the values in the list. * `lt` - The result will contain the network devices that are less than the value. * `gt` - The result will contain the network devices that are greater than the value. * `lte` - The result will contain the network devices that are less than or equal to the value. * `gte` - The result will contain the network devices that are greater than or equal to the value. |
|
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`. * `AND` - The result will contain the network devices that match ALL the filter criteria. * `OR` - The result will contain the network devices that match ANY of the filter criteria. |
|
Pagination related parameters. This is an optional parameter which can be passed to get the paginated response. |
|
The number of records to show for this page. |
|
The first record to show for this page; the first record is numbered 1. |
|
The field to sort by. The default sorting field is `hostname`. The order is ascending by default. |
|
The field to sort by. |
|
The order to sort by Possible values are * `asc` - Ascending order * `des` - Descending order. |
|
Flag for Cisco Catalyst 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. Attributes covered by the views are Attributes covered by the views are * `BASIC` id, managementAddress, dnsResolvedManagementIpAddress, hostname, macAddress, serialNumbers, type, family, series, status, platformIds, softwareType, softwareVersion, vendor, stackDevice, bootTime, role, roleSource, apEthernetMacAddress, apManagerInterfaceIpAddress, apWlcIpAddress, deviceSupportLevel, snmpContact, snmpLocation, secureMode * `RESYNC` id, managementAddress, dnsResolvedManagementIpAddress, hostname, macAddress, serialNumbers, type, family, series, status, reachabilityStatus, reachabilityFailureReason, managementState, lastSuccessfulResyncReasons, resyncStartTime, resyncEndTime, resyncReasons, resyncRequestedByApps, pendingResyncRequestCount, pendingResyncRequestReasons, resyncIntervalSource, resyncIntervalMinutes, errorCode, errorDescription, secureMode * `USER_DEFINED_FIELDS` id, managementAddress, dnsResolvedManagementIpAddress, hostname, macAddress, serialNumbers, type, family, series, status, userDefinedFields. |
Notes
Note
SDK Method used are devices.Devices.query_network_devices_with_filters,
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 uses the embedded connection manager from Cisco CATALYST SDK
Requires Python >= 3.10, matching the controller Python versions supported by the collection's minimum ansible-core version (see the collection README for the current ansible-core / Python compatibility range)
See Also
See also
- Cisco Catalyst Center documentation for Devices QueryNetworkDevicesWithFilters
Complete reference of the QueryNetworkDevicesWithFilters API.
Examples
---
- name: Create
cisco.catalystcenter.intent_network_devices_query:
catalystcenter_host: "{{catalystcenter_host}}"
catalystcenter_username: "{{catalystcenter_username}}"
catalystcenter_password: "{{catalystcenter_password}}"
catalystcenter_verify: "{{catalystcenter_verify}}"
catalystcenter_port: "{{catalystcenter_port}}"
catalystcenter_version: "{{catalystcenter_version}}"
catalystcenter_debug: "{{catalystcenter_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 |
|---|---|