summaryrefslogtreecommitdiffstats
path: root/ansible_collections/cisco/dnac/plugins/modules/applications.py
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-13 12:04:41 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-13 12:04:41 +0000
commit975f66f2eebe9dadba04f275774d4ab83f74cf25 (patch)
tree89bd26a93aaae6a25749145b7e4bca4a1e75b2be /ansible_collections/cisco/dnac/plugins/modules/applications.py
parentInitial commit. (diff)
downloadansible-975f66f2eebe9dadba04f275774d4ab83f74cf25.tar.xz
ansible-975f66f2eebe9dadba04f275774d4ab83f74cf25.zip
Adding upstream version 7.7.0+dfsg.upstream/7.7.0+dfsg
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'ansible_collections/cisco/dnac/plugins/modules/applications.py')
-rw-r--r--ansible_collections/cisco/dnac/plugins/modules/applications.py272
1 files changed, 272 insertions, 0 deletions
diff --git a/ansible_collections/cisco/dnac/plugins/modules/applications.py b/ansible_collections/cisco/dnac/plugins/modules/applications.py
new file mode 100644
index 000000000..22c309bd4
--- /dev/null
+++ b/ansible_collections/cisco/dnac/plugins/modules/applications.py
@@ -0,0 +1,272 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2021, Cisco Systems
+# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+DOCUMENTATION = r"""
+---
+module: applications
+short_description: Resource module for Applications
+description:
+- 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.
+version_added: '3.1.0'
+extends_documentation_fragment:
+ - cisco.dnac.module
+author: Rafael Campos (@racampos)
+options:
+ id:
+ description: Id query parameter. Application's Id.
+ type: str
+ payload:
+ description: Applications's payload.
+ elements: dict
+ suboptions:
+ applicationSet:
+ description: Applications's applicationSet.
+ suboptions:
+ idRef:
+ description: Id Ref.
+ type: str
+ type: dict
+ indicativeNetworkIdentity:
+ description: Applications's indicativeNetworkIdentity.
+ elements: dict
+ suboptions:
+ displayName:
+ description: DisplayName.
+ type: str
+ id:
+ description: Id.
+ type: str
+ lowerPort:
+ description: LowerPort.
+ type: int
+ ports:
+ description: Ports.
+ type: str
+ protocol:
+ description: Protocol.
+ type: str
+ upperPort:
+ description: UpperPort.
+ type: int
+ type: list
+ name:
+ description: Name.
+ type: str
+ networkApplications:
+ description: Applications's networkApplications.
+ elements: dict
+ suboptions:
+ appProtocol:
+ description: App Protocol.
+ type: str
+ applicationSubType:
+ description: Application Sub Type.
+ type: str
+ applicationType:
+ description: Application Type.
+ type: str
+ categoryId:
+ description: Category Id.
+ type: str
+ displayName:
+ description: Display Name.
+ type: str
+ dscp:
+ description: Dscp.
+ type: str
+ engineId:
+ description: Engine Id.
+ type: str
+ helpString:
+ description: Help String.
+ type: str
+ ignoreConflict:
+ description: Ignore Conflict.
+ type: str
+ longDescription:
+ description: Long Description.
+ type: str
+ name:
+ description: Name.
+ type: str
+ popularity:
+ description: Popularity.
+ type: str
+ rank:
+ description: Rank.
+ type: str
+ serverName:
+ description: Server Name.
+ type: str
+ trafficClass:
+ description: Traffic Class.
+ type: str
+ url:
+ description: Url.
+ type: str
+ type: list
+ networkIdentity:
+ description: Applications's networkIdentity.
+ elements: dict
+ suboptions:
+ displayName:
+ description: Display Name.
+ type: str
+ lowerPort:
+ description: Lower Port.
+ type: str
+ ports:
+ description: Ports.
+ type: str
+ protocol:
+ description: Protocol.
+ type: str
+ upperPort:
+ description: Upper Port.
+ type: str
+ type: list
+ type: list
+requirements:
+- dnacentersdk >= 2.5.5
+- python >= 3.5
+seealso:
+- name: Cisco DNA Center documentation for Application Policy CreateApplication
+ description: Complete reference of the CreateApplication API.
+ link: https://developer.cisco.com/docs/dna-center/#!create-application
+- name: Cisco DNA Center documentation for Application Policy DeleteApplication
+ description: Complete reference of the DeleteApplication API.
+ link: https://developer.cisco.com/docs/dna-center/#!delete-application
+- name: Cisco DNA Center documentation for Application Policy EditApplication
+ description: Complete reference of the EditApplication API.
+ link: https://developer.cisco.com/docs/dna-center/#!edit-application
+notes:
+ - 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,
+
+"""
+
+EXAMPLES = r"""
+- 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: 0
+ ports: string
+ protocol: string
+ upperPort: 0
+ 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 = r"""
+dnac_response:
+ description: A dictionary or list with the response returned by the Cisco DNAC Python SDK
+ returned: always
+ type: dict
+ sample: >
+ {
+ "taskId": "string",
+ "url": "string"
+ }
+"""