cisco.dnac.applications – Resource module for Applications

Note

This plugin is part of the cisco.dnac collection (version 4.0.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.

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.

Note

This module has a corresponding action plugin.

Requirements

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

• dnacentersdk >= 2.4.0

• python >= 3.5

Parameters

Parameter			Choices/Defaults	Comments
dnac_debug boolean			Choices: no ← yes	Flag for Cisco DNA Center SDK to enable debugging.
dnac_host string / required				The Cisco DNA Center hostname.
dnac_password string				The Cisco DNA Center password to authenticate.
dnac_port string			Default: 443	The Cisco DNA Center port.
dnac_username string			Default: "admin"	The Cisco DNA Center username to authenticate. aliases: user
dnac_verify boolean			Choices: no yes ←	Flag to enable or disable SSL certificate verification.
dnac_version string			Default: "2.2.3.3"	Informs the SDK which version of Cisco DNA Center to use.
id string				Id query parameter. Application's Id.
payload list / elements=string				Applications's payload.
	applicationSet dictionary			Applications's applicationSet.
		idRef string		Id Ref.
	name string			Name.
	networkApplications list / elements=string			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=string			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			Choices: no yes ←	Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

Notes

Note

• 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

See Also

See also

Applications reference

Complete reference of the Applications object model.

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:
    - name: string
      networkApplications:
      - appProtocol: string
        applicationSubType: string
        applicationType: string
        categoryId: string
        displayName: string
        engineId: string
        helpString: string
        longDescription: string
        name: string
        popularity: string
        rank: string
        trafficClass: string
        serverName: string
        url: string
        dscp: string
        ignoreConflict: string
      networkIdentity:
      - displayName: string
        lowerPort: string
        ports: string
        protocol: string
        upperPort: string
      applicationSet:
        idRef: 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:
    - id: string
      name: string
      networkApplications:
      - id: string
        appProtocol: string
        applicationSubType: string
        applicationType: string
        categoryId: string
        displayName: string
        engineId: string
        helpString: string
        longDescription: string
        name: string
        popularity: string
        rank: string
        trafficClass: string
        serverName: string
        url: string
        dscp: string
        ignoreConflict: string
      networkIdentity:
      - id: string
        displayName: string
        lowerPort: string
        ports: string
        protocol: string
        upperPort: string
      applicationSet:
        idRef: 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	Returned	Description
dnac_response dictionary	always	A dictionary or list with the response returned by the Cisco DNAC Python SDK Sample: { "response": { "taskId": "string", "url": "string" }, "version": "string" }

Authors

• Rafael Campos (@racampos)