/ home / cisco / cisco.dnac / 6.13.3 / module / applications_info

cisco.dnac.applications_info (6.13.3) — module

Information module for Applications

| "added in version" 3.1.0 of cisco.dnac"

Authors: Rafael Campos (@racampos)

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install cisco.dnac:==6.13.3

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 6.13.3

Description

Get all Applications.

Get applications by offset/limit or by name.

Requirements

dnacentersdk >= 2.6.0
python >= 3.9

Usage examples

Scanned by Steampunk Spotter

- name: Get all Applications
  cisco.dnac.applications_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}}"
    offset: 0
    limit: 0
    name: string
  register: result

Inputs

    
name:
    description:
    - Name query parameter. Application's name.
    type: str

limit:
    description:
    - Limit query parameter. The maximum number of applications to be returned.
    type: int

offset:
    description:
    - Offset query parameter. The offset of the first application to be returned.
    type: int

headers:
    description: Additional headers.
    type: dict

dnac_host:
    description:
    - The Cisco DNA Center hostname.
    required: true
    type: str

dnac_port:
    default: 443
    description:
    - The Cisco DNA Center port.
    type: int

dnac_debug:
    default: false
    description:
    - Flag for Cisco DNA Center SDK to enable debugging.
    type: bool

dnac_verify:
    default: true
    description:
    - Flag to enable or disable SSL certificate verification.
    type: bool

dnac_version:
    default: 2.3.5.3
    description:
    - Informs the SDK which version of Cisco DNA Center to use.
    type: str

dnac_password:
    description:
    - The Cisco DNA Center password to authenticate.
    type: str

dnac_username:
    aliases:
    - user
    default: admin
    description:
    - The Cisco DNA Center username to authenticate.
    type: str

validate_response_schema:
    default: true
    description:
    - Flag for Cisco DNA Center SDK to enable the validation of request bodies against
      a JSON schema.
    type: bool

Outputs

dnac_response:
  description: A dictionary or list with the response returned by the Cisco DNAC Python
    SDK
  elements: dict
  returned: always
  sample: "[\n  {\n    \"id\": \"string\",\n    \"name\": \"string\",\n    \"indicativeNetworkIdentity\"\
    : [\n      {\n        \"id\": \"string\",\n        \"displayName\": \"string\"\
    ,\n        \"lowerPort\": 0,\n        \"ports\": \"string\",\n        \"protocol\"\
    : \"string\",\n        \"upperPort\": 0\n      }\n    ],\n    \"networkApplications\"\
    : [\n      {\n        \"id\": \"string\",\n        \"appProtocol\": \"string\"\
    ,\n        \"applicationSubType\": \"string\",\n        \"applicationType\": \"\
    string\",\n        \"categoryId\": \"string\",\n        \"displayName\": \"string\"\
    ,\n        \"engineId\": \"string\",\n        \"helpString\": \"string\",\n  \
    \      \"longDescription\": \"string\",\n        \"name\": \"string\",\n     \
    \   \"popularity\": 0,\n        \"rank\": 0,\n        \"trafficClass\": \"string\"\
    ,\n        \"serverName\": \"string\",\n        \"url\": \"string\",\n       \
    \ \"dscp\": \"string\",\n        \"ignoreConflict\": \"string\"\n      }\n   \
    \ ],\n    \"networkIdentity\": [\n      {\n        \"id\": \"string\",\n     \
    \   \"displayName\": \"string\",\n        \"lowerPort\": 0,\n        \"ports\"\
    : \"string\",\n        \"protocol\": \"string\",\n        \"upperPort\": 0\n \
    \     }\n    ],\n    \"applicationSet\": {\n      \"idRef\": \"string\"\n    }\n\
    \  }\n]\n"
  type: list