cisco.dnac.application_visibility_network_devices_v1_info module – Information module for Application Visibility Network Devices 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.application_visibility_network_devices_v1_info.
New in cisco.dnac 6.17.0
Synopsis
Get all Application Visibility Network Devices V1.
This API retrieves the list of network devices with their application visibility status. The list can be filtered using the query parameters. Multiple filters can be applied.
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 |
|---|---|
ApplicationRegistrySyncStatus query parameter. Indicates whether the latest definitions from application registry have been synchronized with the network device or not. Available values SYNCING, IN_SYNC, OUT_OF_SYNC, NOT_APPLICABLE. |
|
AppTelemetryDeploymentStatus query parameter. Status of the application telemetry deployment on the network device. Available values SCHEDULED, IN_PROGRESS, COMPLETED, FAILED, NOT_DEPLOYED. |
|
AppTelemetryReadinessStatus query parameter. Indicates whether the network device is ready for application telemetry enablement or not. Available values ENABLED, READY, NOT_READY, NOT_SUPPORTED. |
|
CbarDeploymentStatus query parameter. Status of the CBAR deployment on the network device. Available values SCHEDULED, IN_PROGRESS, COMPLETED, FAILED, NOT_DEPLOYED. |
|
CbarReadinessStatus query parameter. Indicates whether the network device is ready for CBAR enablement or not. Available values ENABLED, READY, NOT_READY, NOT_SUPPORTED. |
|
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: |
|
Additional headers. |
|
Hostname query parameter. The host name of the network device. Partial search is supported. For example, searching for `switch` will include `edge-switch1.domain.com`, `switch25`, etc. |
|
Ids query parameter. List of network devices ids. If this parameter is not provided, all network devices will be included in the response. Multiple network device IDs can be provided. |
|
Limit query parameter. The number of records to show for this page. Minimum value is 1, Maximum value is 500. |
|
ManagementAddress query parameter. The management address for the network device. This is normally IP address of the device. But it could be hostname in some cases like Meraki devices. Partial search is supported. For example, searching for `25.` would include `10.25.1.1`, `25.5.10.1`, `225.225.1.0`, `10.10.10.125`, etc. |
|
Offset query parameter. The first record to show for this page; the first record is numbered 1. Default value is 1. |
|
Order query parameter. Whether ascending or descending order should be used to sort the response. Available values are asc, desc. Default value is asc. |
|
ProtocolPackStatus query parameter. Indicates whether the NBAR protocol pack is up-to-date or not on the network device. Available values LATEST, OUTDATED, UNKNOWN. |
|
ProtocolPackUpdateStatus query parameter. Status of the NBAR protocol pack update on the network device. Available values SCHEDULED, IN_PROGRESS, SUCCESS, FAILED, NONE. |
|
SiteId query parameter. The site ID where the network device is assigned. |
|
SortBy query parameter. A property within the response to sort by. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
Notes
Note
SDK Method used are application_policy.ApplicationPolicy.retrieve_the_list_of_network_devices_with_their_application_visibility_status_v1,
Paths used are get /dna/intent/api/v1/applicationVisibility/networkDevices,
Supports
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 Application Policy RetrieveTheListOfNetworkDevicesWithTheirApplicationVisibilityStatusV1
Complete reference of the RetrieveTheListOfNetworkDevicesWithTheirApplicationVisibilityStatusV1 API.
Examples
- name: Get all Application Visibility Network Devices V1
cisco.dnac.application_visibility_network_devices_v1_info:
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}}"
headers: "{{my_headers | from_json}}"
ids: string
managementAddress: string
hostname: string
siteId: string
appTelemetryDeploymentStatus: string
appTelemetryReadinessStatus: string
cbarDeploymentStatus: string
cbarReadinessStatus: string
protocolPackStatus: string
protocolPackUpdateStatus: string
applicationRegistrySyncStatus: string
offset: string
limit: string
sortBy: string
order: 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 DNAC Python SDK Returned: always Sample: |