cisco.dnac.clients_query module – Resource module for Clients Query
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.clients_query.
New in cisco.dnac 6.15.0
Synopsis
This module represents an alias of the module clients_query_v1
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 |
|---|---|
Clients Query’s aggregateAttributes. |
|
Function. |
|
Name. |
|
Attributes. |
|
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: |
|
End Time. |
|
Clients Query’s filters. |
|
Key. |
|
Operator. |
|
Value. |
|
Additional headers. |
|
Clients Query’s page. |
|
Limit. |
|
Offset. |
|
Clients Query’s sortBy. |
|
Name. |
|
Order. |
|
Start Time. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
|
Views. |
Notes
Note
SDK Method used are clients.Clients.retrieves_the_list_of_clients_by_applying_complex_filters_while_also_supporting_aggregate_attributes_v1,
Paths used are post /dna/data/api/v1/clients/query,
It should be noted that this module is an alias of clients_query_v1
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 Clients RetrievesTheListOfClientsByApplyingComplexFiltersWhileAlsoSupportingAggregateAttributesV1
Complete reference of the RetrievesTheListOfClientsByApplyingComplexFiltersWhileAlsoSupportingAggregateAttributesV1 API.
Examples
- name: Create
cisco.dnac.clients_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:
- key: string
operator: string
value: 0
headers: '{{my_headers | from_json}}'
page:
limit: 0
offset: 0
sortBy:
- name: string
order: string
startTime: 0
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: |