cisco.dnac.applications module – Resource module for Applications

Note

This module is part of the cisco.dnac collection (version 6.2.1).

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.

To use it in a playbook, specify: cisco.dnac.applications.

New in version 3.1.0: of cisco.dnac

Synopsis

• Manage operations create, update and delete of the resource Applications.

• Create new Custom application.

• Delete existing application by its id.

• Edit the attributes of an existing application.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

• dnacentersdk >= 2.4.8

• python >= 3.5

Parameters

Parameter	Comments
dnac_debug boolean	Flag for Cisco DNA Center SDK to enable debugging. Choices: no ← (default) yes
dnac_host string / required	The Cisco DNA Center hostname.
dnac_password string	The Cisco DNA Center password to authenticate.
dnac_port integer	The Cisco DNA Center port. Default: 443
dnac_username aliases: user string	The Cisco DNA Center username to authenticate. Default: “admin”
dnac_verify boolean	Flag to enable or disable SSL certificate verification. Choices: no yes ← (default)
dnac_version string	Informs the SDK which version of Cisco DNA Center to use. Default: “2.2.3.3”
id string	Id query parameter. Application’s Id.
payload list / elements=dictionary	Applications’s payload.
applicationSet dictionary	Applications’s applicationSet.
idRef string	Id Ref.
indicativeNetworkIdentity list / elements=dictionary	Applications’s indicativeNetworkIdentity.
displayName string	DisplayName.
id string	Id.
lowerPort integer	LowerPort.
ports string	Ports.
protocol string	Protocol.
upperPort integer	UpperPort.
name string	Name.
networkApplications list / elements=dictionary	Applications’s networkApplications.
applicationSubType string	Application Sub Type.
applicationType string	Application Type.
appProtocol string	App Protocol.
categoryId string	Category Id.
displayName string	Display Name.
dscp string	Dscp.
engineId string	Engine Id.
helpString string	Help String.
ignoreConflict string	Ignore Conflict.
longDescription string	Long Description.
name string	Name.
popularity string	Popularity.
rank string	Rank.
serverName string	Server Name.
trafficClass string	Traffic Class.
url string	Url.
networkIdentity list / elements=dictionary	Applications’s networkIdentity.
displayName string	Display Name.
lowerPort string	Lower Port.
ports string	Ports.
protocol string	Protocol.
upperPort string	Upper Port.
validate_response_schema boolean	Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices: no yes ← (default)

Notes

Note

• SDK Method used are application_policy.ApplicationPolicy.create_application, application_policy.ApplicationPolicy.delete_application, application_policy.ApplicationPolicy.edit_application,

• Paths used are post /dna/intent/api/v1/applications, delete /dna/intent/api/v1/applications, put /dna/intent/api/v1/applications,

• Does not support check_mode

• The 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

Examples

- name: Create
  cisco.dnac.applications:
    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}}"
    state: present
    payload:
    - applicationSet:
        idRef: string
      indicativeNetworkIdentity:
      - displayName: string
        id: string
        lowerPort: 1
        ports: string
        protocol: string
        upperPort: 1
      name: string
      networkApplications:
      - appProtocol: string
        applicationSubType: string
        applicationType: string
        categoryId: string
        displayName: string
        dscp: string
        engineId: string
        helpString: string
        ignoreConflict: string
        longDescription: string
        name: string
        popularity: string
        rank: string
        serverName: string
        trafficClass: string
        url: string
      networkIdentity:
      - displayName: string
        lowerPort: string
        ports: string
        protocol: string
        upperPort: string

- name: Update all
  cisco.dnac.applications:
    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}}"
    state: present
    payload:
    - applicationSet:
        idRef: string
      id: string
      name: string
      networkApplications:
      - appProtocol: string
        applicationSubType: string
        applicationType: string
        categoryId: string
        displayName: string
        dscp: string
        engineId: string
        helpString: string
        id: string
        ignoreConflict: string
        longDescription: string
        name: string
        popularity: string
        rank: string
        serverName: string
        trafficClass: string
        url: string
      networkIdentity:
      - displayName: string
        id: string
        lowerPort: string
        ports: string
        protocol: string
        upperPort: string

- name: Delete all
  cisco.dnac.applications:
    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}}"
    state: absent
    id: string

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
dnac_response dictionary	A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: “{\n \”taskId\”: \”string\”,\n \”url\”: \”string\”\n}\n”

Authors

• Rafael Campos (@racampos)