racampos.dnac.applications (0.0.1) — module

Manage Applications objects of ApplicationPolicy

| "added in version" 1.0 of racampos.dnac"

Authors: first last (@GitHubID)

preview | supported by community

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install racampos.dnac:==0.0.1


Add to requirements.yml

  collections:
    - name: racampos.dnac
      version: 0.0.1

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.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: get_applications
  cisco.dnac.applications:
    state: query  # required
    limit: 1  #  number
    name: SomeValue  # string
    offset: 1  #  number
  register: query_result
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- name: delete_application
  cisco.dnac.applications:
    state: delete  # required
    id: SomeValue  # string, required
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- name: get_applications_count
  cisco.dnac.applications:
    state: query  # required
    count: True  # boolean, required
  register: query_result

Inputs

    
id:
    description:
    - Application's Id.
    - Required for state delete.
    type: str

name:
    description:
    - Application's name.
    type: str

count:
    description:
    - If true gets the number of objects.
    - Required for state query.
    type: bool

limit:
    description:
    - The maximum number of Applications to be returned.
    type: int

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

payload:
    description:
    - An object to send in the Request body.
    elements: dict
    required: true
    suboptions:
      applicationSet:
        description:
        - It is the Applications's applicationSet.
        suboptions:
          idRef:
            description:
            - It is the Applications's idRef.
            type: str
        type: dict
      id:
        description:
        - It is the Applications's id.
        type: str
      name:
        description:
        - It is the Applications's name.
        type: str
      networkApplications:
        description:
        - It is the Applications's networkApplications.
        elements: dict
        suboptions:
          appProtocol:
            description:
            - It is the Applications's appProtocol.
            type: str
          applicationSubType:
            description:
            - It is the Applications's applicationSubType.
            type: str
          applicationType:
            description:
            - It is the Applications's applicationType.
            type: str
          categoryId:
            description:
            - It is the Applications's categoryId.
            type: str
          displayName:
            description:
            - It is the Applications's displayName.
            type: str
          dscp:
            description:
            - It is the Applications's dscp.
            type: str
          engineId:
            description:
            - It is the Applications's engineId.
            type: str
          helpString:
            description:
            - It is the Applications's helpString.
            type: str
          id:
            description:
            - It is the Applications's id.
            type: str
          ignoreConflict:
            description:
            - It is the Applications's ignoreConflict.
            type: str
          longDescription:
            description:
            - It is the Applications's longDescription.
            type: str
          name:
            description:
            - It is the Applications's name.
            type: str
          popularity:
            description:
            - It is the Applications's popularity.
            type: str
          rank:
            description:
            - It is the Applications's rank.
            type: str
          serverName:
            description:
            - It is the Applications's serverName.
            type: str
          trafficClass:
            description:
            - It is the Applications's trafficClass.
            type: str
          url:
            description:
            - It is the Applications's url.
            type: str
        type: list
      networkIdentity:
        description:
        - It is the Applications's networkIdentity.
        elements: dict
        suboptions:
          displayName:
            description:
            - It is the Applications's displayName.
            type: str
          id:
            description:
            - It is the Applications's id.
            type: str
          lowerPort:
            description:
            - It is the Applications's lowerPort.
            type: str
          ports:
            description:
            - It is the Applications's ports.
            type: str
          protocol:
            description:
            - It is the Applications's protocol.
            type: str
          upperPort:
            description:
            - It is the Applications's upperPort.
            type: str
        type: list
    type: list

Outputs

create_application:
  contains: null
  description: Create new Custom application.
  response:
    contains:
      taskId:
        description: It is the Applications's taskId.
        returned: success
        sample: aeed229047801200e0ef563dbb9a71c2
        type: str
      url:
        description: It is the Applications's url.
        returned: success
        sample: <url>
        type: str
    description: Response, property of the response body.
    returned: success
    type: dict
  returned: success
  type: dict
  version:
    description: Version, property of the response body.
    returned: success
    sample: '1.0'
    type: str
delete_application:
  contains: null
  description: Delete existing application by its id.
  response:
    contains:
      taskId:
        description: It is the Applications's taskId.
        returned: success
        sample: aeed229047801200e0ef563dbb9a71c2
        type: str
      url:
        description: It is the Applications's url.
        returned: success
        sample: <url>
        type: str
    description: Response, property of the response body.
    returned: success
    type: dict
  returned: success
  type: dict
  version:
    description: Version, property of the response body.
    returned: success
    sample: '1.0'
    type: str
edit_application:
  contains: null
  description: Edit the attributes of an existing application.
  response:
    contains:
      taskId:
        description: It is the Applications's taskId.
        returned: changed
        sample: aeed229047801200e0ef563dbb9a71c2
        type: str
      url:
        description: It is the Applications's url.
        returned: changed
        sample: <url>
        type: str
    description: Response, property of the response body.
    returned: changed
    type: dict
  returned: changed
  type: dict
  version:
    description: Version, property of the response body.
    returned: changed
    sample: '1.0'
    type: str
get_applications:
  contains: null
  description: Get Applications by offset/limit or by name.
  payload:
    contains:
      applicationSet:
        contains:
          idRef:
            description: It is the Applications's idRef.
            returned: always
            sample: <idref>
            type: str
        description: It is the Applications's applicationSet.
        returned: always
        type: dict
      id:
        description: It is the Applications's id.
        returned: always
        sample: '478012'
        type: str
      name:
        description: It is the Applications's name.
        returned: always
        sample: <name>
        type: str
      networkApplications:
        contains:
          appProtocol:
            description: It is the Applications's appProtocol.
            returned: always
            sample: <appprotocol>
            type: str
          applicationSubType:
            description: It is the Applications's applicationSubType.
            returned: always
            sample: <applicationsubtype>
            type: str
          applicationType:
            description: It is the Applications's applicationType.
            returned: always
            sample: <applicationtype>
            type: str
          categoryId:
            description: It is the Applications's categoryId.
            returned: always
            sample: <categoryid>
            type: str
          displayName:
            description: It is the Applications's displayName.
            returned: always
            sample: <displayname>
            type: str
          dscp:
            description: It is the Applications's dscp.
            returned: always
            sample: <dscp>
            type: str
          engineId:
            description: It is the Applications's engineId.
            returned: always
            sample: <engineid>
            type: str
          helpString:
            description: It is the Applications's helpString.
            returned: always
            sample: <helpstring>
            type: str
          id:
            description: It is the Applications's id.
            returned: always
            sample: '478012'
            type: str
          ignoreConflict:
            description: It is the Applications's ignoreConflict.
            returned: always
            sample: <ignoreconflict>
            type: str
          longDescription:
            description: It is the Applications's longDescription.
            returned: always
            sample: <longdescription>
            type: str
          name:
            description: It is the Applications's name.
            returned: always
            sample: <name>
            type: str
          popularity:
            description: It is the Applications's popularity.
            returned: always
            sample: <popularity>
            type: str
          rank:
            description: It is the Applications's rank.
            returned: always
            sample: <rank>
            type: str
          serverName:
            description: It is the Applications's serverName.
            returned: always
            sample: <servername>
            type: str
          trafficClass:
            description: It is the Applications's trafficClass.
            returned: always
            sample: <trafficclass>
            type: str
          url:
            description: It is the Applications's url.
            returned: always
            sample: <url>
            type: str
        description: It is the Applications's networkApplications.
        returned: always
        type: list
      networkIdentity:
        contains:
          displayName:
            description: It is the Applications's displayName.
            returned: always
            sample: <displayname>
            type: str
          id:
            description: It is the Applications's id.
            returned: always
            sample: '478012'
            type: str
          lowerPort:
            description: It is the Applications's lowerPort.
            returned: always
            sample: <lowerport>
            type: str
          ports:
            description: It is the Applications's ports.
            returned: always
            sample: <ports>
            type: str
          protocol:
            description: It is the Applications's protocol.
            returned: always
            sample: <protocol>
            type: str
          upperPort:
            description: It is the Applications's upperPort.
            returned: always
            sample: <upperport>
            type: str
        description: It is the Applications's networkIdentity.
        returned: always
        type: list
    description: It is the Applications's payload.
    returned: always
    type: list
  returned: always
  type: dict
get_applications_count:
  contains: null
  description: Get the number of all existing Applications.
  response:
    description: Response, property of the response body.
    returned: always
    sample: <response>
    type: str
  returned: always
  type: dict
  version:
    description: Version, property of the response body.
    returned: always
    sample: '1.0'
    type: str

See also