racampos.dnac.application_set (0.0.1) — module

Manage ApplicationSet 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

Delete existing application-set by it's id.

Get appllication-sets by offset/limit or by name.

Create new custom application-set/s.

Get the number of existing application-sets.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: delete_application_set
  cisco.dnac.application_set:
    state: delete  # required
    id: SomeValue  # string, required
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- name: get_application_sets
  cisco.dnac.application_set:
    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: create_application_set
  cisco.dnac.application_set:
    state: create  # required
    payload:  # required
    - name: SomeValue  # string
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- name: get_application_sets_count
  cisco.dnac.application_set:
    state: query  # required
    count: True  # boolean, required
  register: query_result

Inputs

    
id:
    description:
    - Id query parameter.
    - Required for state delete.
    type: str

name:
    description:
    - Name query parameter.
    type: str

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

limit:
    description:
    - Limit query parameter.
    type: int

offset:
    description:
    - Offset query parameter.
    type: int

payload:
    description:
    - An object to send in the Request body.
    - Required for state create.
    elements: dict
    suboptions:
      name:
        description:
        - It is the application set's name.
        type: str
    type: list

Outputs

create_application_set:
  contains: null
  description: Create new custom application-set/s.
  response:
    contains:
      taskId:
        description: It is the application set's taskId.
        returned: success
        sample: aeed229047801200e0ef563dbb9a71c2
        type: str
      url:
        description: It is the application set'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_set:
  contains: null
  description: Delete existing application-set by it's id.
  response:
    contains:
      taskId:
        description: It is the application set's taskId.
        returned: success
        sample: aeed229047801200e0ef563dbb9a71c2
        type: str
      url:
        description: It is the application set'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
get_application_sets:
  contains: null
  description: Get appllication-sets by offset/limit or by name.
  response:
    contains:
      id:
        description: It is the application set's id.
        returned: always
        sample: '478012'
        type: str
      identitySource:
        contains:
          id:
            description: It is the application set's id.
            returned: always
            sample: '478012'
            type: str
          type:
            description: It is the application set's type.
            returned: always
            sample: <type>
            type: str
        description: It is the application set's identitySource.
        returned: always
        type: dict
      name:
        description: It is the application set's name.
        returned: always
        sample: <name>
        type: str
    description: Response, property of the response body (list of objects).
    returned: always
    type: list
  returned: always
  type: dict
get_application_sets_count:
  contains: null
  description: Get the number of existing application-sets.
  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