cisco.dnac.application_set – Manage ApplicationSet objects of ApplicationPolicy

Note

This plugin is part of the cisco.dnac collection (version 2.0.7).

To install it use: ansible-galaxy collection install cisco.dnac.

To use it in a playbook, specify: cisco.dnac.application_set.

New in version 1.0.0: of cisco.dnac

Synopsis

  • 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.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

  • dnacentersdk

Parameters

Parameter Choices/Defaults Comments
count
boolean
    Choices:
  • no
  • yes
If true gets the number of objects.
Required for state query.
id
string
Id query parameter.
Required for state delete.
limit
integer
Limit query parameter.
name
string
Name query parameter.
offset
integer
Offset query parameter.
payload
list / elements=dictionary
An object to send in the Request body.
Required for state create.
name
string
It is the application set's name.

See Also

See also

cisco.dnac.plugins.module_utils.definitions.application_set

The official documentation on the cisco.dnac.plugins.module_utils.definitions.application_set module.

ApplicationSet reference

Complete reference of the ApplicationSet object model.

ApplicationSet reference

SDK reference.

Examples

- name: delete_application_set
  cisco.dnac.application_set:
    state: delete  # required
    id: SomeValue  # string, required

- name: get_application_sets
  cisco.dnac.application_set:
    state: query  # required
    limit: 1  #  number
    name: SomeValue  # string
    offset: 1  #  number
  register: nm_get_application_sets

- name: create_application_set
  cisco.dnac.application_set:
    state: create  # required
    payload:  # required
    - name: SomeValue  # string

- name: get_application_sets_count
  cisco.dnac.application_set:
    state: query  # required
    count: True  # boolean, required
  register: nm_get_application_sets_count

Return Values

Common return values are documented here, the following are the fields unique to this module:

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_set


Authors

  • Rafael Campos (@racampos)