cisco.catalystcenter.network_devices_query_v1 module -- Resource module for Network Devices Query V1
Note
This module is part of the cisco.catalystcenter collection (version 2.1.4).
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.network_devices_query_v1.
New in cisco.catalystcenter 6.15.0
Synopsis
Manage operation create of the resource Network Devices Query V1.
Gets the list of Network Devices based on the provided complex filters and aggregation functions. For detailed information about the usage of the API, please refer to the Open API specification document - https //github.com/cisco-en-programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org- AssuranceNetworkDevices-2.0.1-resolved.yaml.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
catalystcentersdk >= 2.3.7.9
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
The Cisco CATALYST Center port. Default: :ansible-option-default:`443` |
|
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 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:`"2.3.7.6"` |
|
Network Devices Query's aggregateAttributes. |
|
Function. |
|
Name. |
|
Attributes. |
|
End Time. |
|
Network Devices Query's filters. |
|
Key. |
|
Operator. |
|
Value. |
|
Network Devices Query's page. |
|
Count. |
|
Limit. |
|
Offset. |
|
Sort By. |
|
Start Time. |
|
Flag for Cisco CATALYST Center SDK to enable the validation of request bodies against a JSON schema. Choices: |
|
Views. |
Notes
Note
SDK Method used are devices.Devices.gets_the_list_of_network_devices_based_on_the_provided_complex_filters_and_aggregation_functions_v1,
Paths used are post /dna/data/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 CATALYST SDK
The parameters starting with catalystCenter_ are used by the Cisco CATALYST Python SDK to establish the connection
See Also
See also
- Cisco DNA Center documentation for Devices GetsTheListOfNetworkDevicesBasedOnTheProvidedComplexFiltersAndAggregationFunctionsV1
Complete reference of the GetsTheListOfNetworkDevicesBasedOnTheProvidedComplexFiltersAndAggregationFunctionsV1 API.
Examples
- name: Create
cisco.catalystcenter.network_devices_query_v1:
_host: "{{ _host }}"
_username: "{{ _username }}"
_password: "{{ _password }}"
_verify: "{{ _verify }}"
_api_port: "{{ _api_port }}"
_version: "{{ _version }}"
_debug: "{{ _debug }}"
aggregateAttributes:
- function: string
name: string
attributes:
- string
endTime: 0
filters:
- key: string
operator: string
value: string
page:
count: 0
limit: 0
offset: 0
sortBy: string
startTime: 0
views:
- string
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|