.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.dnac.applications_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.applications module -- Resource module for Applications ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.dnac collection `_ (version 6.25.1). To install it, use: :code:`ansible-galaxy collection install cisco.dnac`. You need further requirements to be able to use this module, see :ref:`Requirements ` for details. To use it in a playbook, specify: :code:`cisco.dnac.applications`. .. version_added .. rst-class:: ansible-version-added New in cisco.dnac 3.1.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - This module represents an alias of the module applications\_v1 .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.dnac.applications_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk \>= 2.4.9 - python \>= 3.5 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.dnac.applications_module__parameter-dnac_debug: .. rst-class:: ansible-option-title **dnac_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco DNA Center SDK to enable debugging. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.applications_module__parameter-dnac_host: .. rst-class:: ansible-option-title **dnac_host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Cisco DNA Center hostname. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.applications_module__parameter-dnac_password: .. rst-class:: ansible-option-title **dnac_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco DNA Center password to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.applications_module__parameter-dnac_port: .. rst-class:: ansible-option-title **dnac_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The Cisco DNA Center port. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`443` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.applications_module__parameter-dnac_username: .. _ansible_collections.cisco.dnac.applications_module__parameter-user: .. rst-class:: ansible-option-title **dnac_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: user` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco DNA Center username to authenticate. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"admin"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.applications_module__parameter-dnac_verify: .. rst-class:: ansible-option-title **dnac_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag to enable or disable SSL certificate verification. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.applications_module__parameter-dnac_version: .. rst-class:: ansible-option-title **dnac_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Informs the SDK which version of Cisco DNA Center to use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"2.3.7.6"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.applications_module__parameter-id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Id query parameter. Application's Id. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.applications_module__parameter-payload: .. rst-class:: ansible-option-title **payload** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Applications's payload. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.applications_module__parameter-payload/applicationset: .. rst-class:: ansible-option-title **applicationSet** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Applications's applicationSet. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.applications_module__parameter-payload/applicationset/idref: .. rst-class:: ansible-option-title **idRef** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Id Ref. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.applications_module__parameter-payload/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.applications_module__parameter-payload/networkapplications: .. rst-class:: ansible-option-title **networkApplications** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Applications's networkApplications. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.applications_module__parameter-payload/networkapplications/applicationsubtype: .. rst-class:: ansible-option-title **applicationSubType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Application Sub Type. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.applications_module__parameter-payload/networkapplications/applicationtype: .. rst-class:: ansible-option-title **applicationType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Application Type. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.applications_module__parameter-payload/networkapplications/appprotocol: .. rst-class:: ansible-option-title **appProtocol** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
App Protocol. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.applications_module__parameter-payload/networkapplications/categoryid: .. rst-class:: ansible-option-title **categoryId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Category Id. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.applications_module__parameter-payload/networkapplications/displayname: .. rst-class:: ansible-option-title **displayName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Display Name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.applications_module__parameter-payload/networkapplications/dscp: .. rst-class:: ansible-option-title **dscp** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Dscp. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.applications_module__parameter-payload/networkapplications/engineid: .. rst-class:: ansible-option-title **engineId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Engine Id. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.applications_module__parameter-payload/networkapplications/helpstring: .. rst-class:: ansible-option-title **helpString** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Help String. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.applications_module__parameter-payload/networkapplications/ignoreconflict: .. rst-class:: ansible-option-title **ignoreConflict** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Ignore Conflict. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.applications_module__parameter-payload/networkapplications/longdescription: .. rst-class:: ansible-option-title **longDescription** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Long Description. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.applications_module__parameter-payload/networkapplications/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.applications_module__parameter-payload/networkapplications/popularity: .. rst-class:: ansible-option-title **popularity** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Popularity. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.applications_module__parameter-payload/networkapplications/rank: .. rst-class:: ansible-option-title **rank** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Rank. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.applications_module__parameter-payload/networkapplications/servername: .. rst-class:: ansible-option-title **serverName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Server Name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.applications_module__parameter-payload/networkapplications/trafficclass: .. rst-class:: ansible-option-title **trafficClass** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Traffic Class. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.applications_module__parameter-payload/networkapplications/url: .. rst-class:: ansible-option-title **url** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Url. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.applications_module__parameter-payload/networkidentity: .. rst-class:: ansible-option-title **networkIdentity** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Applications's networkIdentity. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.applications_module__parameter-payload/networkidentity/displayname: .. rst-class:: ansible-option-title **displayName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Display Name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.applications_module__parameter-payload/networkidentity/lowerport: .. rst-class:: ansible-option-title **lowerPort** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Lower Port. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.applications_module__parameter-payload/networkidentity/ports: .. rst-class:: ansible-option-title **ports** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Ports. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.applications_module__parameter-payload/networkidentity/protocol: .. rst-class:: ansible-option-title **protocol** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Protocol. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.applications_module__parameter-payload/networkidentity/upperport: .. rst-class:: ansible-option-title **upperPort** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Upper Port. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.applications_module__parameter-validate_response_schema: .. rst-class:: ansible-option-title **validate_response_schema** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
.. Attributes .. Notes Notes ----- .. note:: - SDK Method used are application\_policy.ApplicationPolicy.create\_application\_v1, application\_policy.ApplicationPolicy.delete\_application\_v1, application\_policy.ApplicationPolicy.edit\_application\_v1, - Paths used are post /dna/intent/api/v1/applications, delete /dna/intent/api/v1/applications, put /dna/intent/api/v1/applications, - It should be noted that this module is an alias of applications\_v1 - Does not support \ :literal:`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 .. Seealso See Also -------- .. seealso:: `Cisco DNA Center documentation for Application Policy CreateApplicationV1 `_ Complete reference of the CreateApplicationV1 API. `Cisco DNA Center documentation for Application Policy DeleteApplicationV1 `_ Complete reference of the DeleteApplicationV1 API. `Cisco DNA Center documentation for Application Policy EditApplicationV1 `_ Complete reference of the EditApplicationV1 API. .. Examples Examples -------- .. code-block:: yaml+jinja - 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 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 .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.dnac.applications_module__return-dnac_response: .. rst-class:: ansible-option-title **dnac_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco DNAC Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors