.. Document meta :orphan: .. Anchors .. _ansible_collections.cisco.dnac.applications_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.applications -- Manage Applications objects of ApplicationPolicy +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This plugin is part of the `cisco.dnac collection `_ (version 2.0.7). To install it use: :code:`ansible-galaxy collection install cisco.dnac`. To use it in a playbook, specify: :code:`cisco.dnac.applications`. .. version_added .. versionadded:: 1.0.0 of cisco.dnac .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Get Applications by offset/limit or by name. - Delete existing application by its id. - Create new Custom application. - Edit the attributes of an existing application. - Get the number of all existing Applications. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk .. Options Parameters ---------- .. raw:: html
Parameter Choices/Defaults Comments
count
boolean
    Choices:
  • no
  • yes
If true gets the number of objects.
Required for state query.
id
string
Application's Id.
Required for state delete.
limit
integer
The maximum number of Applications to be returned.
name
string
Application's name.
offset
integer
The offset of the first application to be returned.
payload
list / elements=dictionary / required
An object to send in the Request body.
applicationSet
dictionary
It is the Applications's applicationSet.
idRef
string
It is the Applications's idRef.
id
string
It is the Applications's id.
name
string
It is the Applications's name.
networkApplications
list / elements=dictionary
It is the Applications's networkApplications.
applicationSubType
string
It is the Applications's applicationSubType.
applicationType
string
It is the Applications's applicationType.
appProtocol
string
It is the Applications's appProtocol.
categoryId
string
It is the Applications's categoryId.
displayName
string
It is the Applications's displayName.
dscp
string
It is the Applications's dscp.
engineId
string
It is the Applications's engineId.
helpString
string
It is the Applications's helpString.
id
string
It is the Applications's id.
ignoreConflict
string
It is the Applications's ignoreConflict.
longDescription
string
It is the Applications's longDescription.
name
string
It is the Applications's name.
popularity
string
It is the Applications's popularity.
rank
string
It is the Applications's rank.
serverName
string
It is the Applications's serverName.
trafficClass
string
It is the Applications's trafficClass.
url
string
It is the Applications's url.
networkIdentity
list / elements=dictionary
It is the Applications's networkIdentity.
displayName
string
It is the Applications's displayName.
id
string
It is the Applications's id.
lowerPort
string
It is the Applications's lowerPort.
ports
string
It is the Applications's ports.
protocol
string
It is the Applications's protocol.
upperPort
string
It is the Applications's upperPort.

.. Notes .. Seealso See Also -------- .. seealso:: :ref:`cisco.dnac.plugins.module_utils.definitions.applications ` The official documentation on the **cisco.dnac.plugins.module_utils.definitions.applications** module. `Applications reference `_ Complete reference of the Applications object model. `Applications reference `_ SDK reference. .. Examples Examples -------- .. code-block:: yaml+jinja - name: get_applications cisco.dnac.applications: state: query # required limit: 1 # number name: SomeValue # string offset: 1 # number register: nm_get_applications - name: delete_application cisco.dnac.applications: state: delete # required id: SomeValue # string, required - name: create_application cisco.dnac.applications: state: create # required payload: # required - name: SomeValue # string networkApplications: - appProtocol: SomeValue # string applicationSubType: SomeValue # string applicationType: SomeValue # string categoryId: SomeValue # string displayName: SomeValue # string engineId: SomeValue # string helpString: SomeValue # string longDescription: SomeValue # string name: SomeValue # string popularity: SomeValue # string rank: SomeValue # string trafficClass: SomeValue # string serverName: SomeValue # string url: SomeValue # string dscp: SomeValue # string ignoreConflict: SomeValue # string networkIdentity: - displayName: SomeValue # string lowerPort: SomeValue # string ports: SomeValue # string protocol: SomeValue # string upperPort: SomeValue # string applicationSet: idRef: SomeValue # string - name: edit_application cisco.dnac.applications: state: update # required payload: # required - id: SomeValue # string name: SomeValue # string networkApplications: - id: SomeValue # string appProtocol: SomeValue # string applicationSubType: SomeValue # string applicationType: SomeValue # string categoryId: SomeValue # string displayName: SomeValue # string engineId: SomeValue # string helpString: SomeValue # string longDescription: SomeValue # string name: SomeValue # string popularity: SomeValue # string rank: SomeValue # string trafficClass: SomeValue # string serverName: SomeValue # string url: SomeValue # string dscp: SomeValue # string ignoreConflict: SomeValue # string networkIdentity: - id: SomeValue # string displayName: SomeValue # string lowerPort: SomeValue # string ports: SomeValue # string protocol: SomeValue # string upperPort: SomeValue # string applicationSet: idRef: SomeValue # string - name: get_applications_count cisco.dnac.applications: state: query # required count: True # boolean, required register: nm_get_applications_count .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. raw:: html
Key Returned Description
dnac_response
dictionary
always
A dictionary with the response returned by the DNA Center Python SDK

Sample:
{'response': 29, 'version': '1.0'}
missing_params
list / elements=string
when the function request schema is not satisfied
Provided arguments do not comply with the schema of the DNA Center Python SDK function
sdk_function
string
always
The DNA Center SDK function used to execute the task

Sample:
application_policy.create_application


.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Parsing errors