cisco.catalystcenter.network_applications_clients_info module -- Information module for Network Applications Clients
Note
This module is part of the cisco.catalystcenter collection (version 2.12.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.network_applications_clients_info.
New in cisco.catalystcenter 2.11.0
Synopsis
Get all Network Applications Clients. - > Retrieves the list of clients metrics for the given application. If startTime and endTime are not provided, the API defaults to the last 24 hours. `siteId` is mandatory. `siteId` must be a site UUID of a building. For the given time range and filters, the API will get the list of unique clients which matched the filter criteria. 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-NetworkApplications-1.0.2-resolved.yaml.
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 |
|---|---|
Attribute query parameter. List of attributes related to resource that can be requested to only be part of the response along with the required attributes. Supported attributes are id, name, ipAddress,osType, usage, siteName, macAddress, type, appHealthScore, clientHealthScore, exporterNetworkDeviceId, siteId,connectedNetworkDeviceName, connectedNetworkDeviceId, vlanId Examples `attribute=name` (single attribute requested) `attribute=name&attribute=macAddress` (multiple attribute requested). |
|
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"` |
|
EndTime query parameter. End time to which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. |
|
ExporterNetworkDeviceId query parameter. Unique ID of the netflow exporter device. Examples `exporterNetworkDeviceId=5b234dbc-583e-491b-bf1a-318bba6c017f` (single exporterNetworkDeviceId requested) `exporterNetworkDeviceId=5b234dbc-583e-491b-bf1a- 318bba6c017f&exporterNetworkDeviceId=8b234dbc-583e-491b-bf1a-318bba6c017f` (multiple exporterNetworkDeviceId requested). |
|
Additional headers. |
|
Id path parameter. Id is the network application name. |
|
Limit query parameter. Maximum number of records to return. |
|
Offset query parameter. Specifies the starting point within all records returned by the API. It's one based offset. The starting value is 1. |
|
Order query parameter. The sort order of the field ascending or descending. |
|
SiteId query parameter. The site UUID without the top level hierarchy.`siteId` is mandatory. `siteId` must be a site UUID of a building. (Ex."buildingUuid") Examples `siteId=buildingUuid` (single siteId requested) `siteId=buildingUuid1&siteId=buildingUuid2` (multiple siteId requested). |
|
SortBy query parameter. A field within the response to sort by. |
|
StartTime query parameter. Start time from which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. |
|
Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: |
Notes
Note
SDK Method used are applications.Applications.retrieves_the_list_of_clients_metrics_for_the_given_application,
Paths used are get /dna/data/api/v1/networkApplications/{id}/clients,
Supports
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 Applications RetrievesTheListOfClientsMetricsForTheGivenApplication
Complete reference of the RetrievesTheListOfClientsMetricsForTheGivenApplication API.
Examples
---
- name: Get all Network Applications Clients
cisco.catalystcenter.network_applications_clients_info:
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}}"
headers: "{{my_headers | from_json}}"
startTime: 0
endTime: 0
siteId: string
exporterNetworkDeviceId: string
attribute: string
limit: 100
offset: 1
sortBy: string
order: string
id: string
register: result
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 Catalyst Center Python SDK Returned: always |