cisco.dnac.applications_v2_info module – Information module for Applications V2
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.applications_v2_info.
New in cisco.dnac 6.14.0
Synopsis
Get all Applications V2.
Get application/s by offset/limit or by name.
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 |
|---|---|
Attributes query parameter. Attributes to retrieve, valid value application. |
|
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. |
|
Limit query parameter. The limit which is the maximum number of items to include in a single page of results, max value 500. |
|
Name query parameter. The application name. |
|
Offset query parameter. The starting point or index from where the paginated results should begin. |
|
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.get_applications_v2,
Paths used are get /dna/intent/api/v2/applications,
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 GetApplicationsV2
Complete reference of the GetApplicationsV2 API.
Examples
- name: Get all Applications V2
cisco.dnac.applications_v2_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}}"
attributes: string
name: string
offset: 0
limit: 0
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: |