cisco.catalystcenter.application_policy_application_set module -- Resource module for Application Policy Application Set

Note

This module is part of the cisco.catalystcenter collection (version 2.1.4).

To install it, use: ansible-galaxy collection install cisco.catalystcenter. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.catalystcenter.application_policy_application_set.

New in cisco.catalystcenter 6.14.0

Synopsis

• This module represents an alias of the module application_policy_application_set_v2

Note

This module has a corresponding action plugin.

Requirements

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

• catalystcentersdk >= 2.3.7.9

• python >= 3.5

Parameters

Parameter	Comments
_api_port integer	The Cisco CATALYST Center port. Default: :ansible-option-default:`443`
_debug boolean	Flag for Cisco CATALYST Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
_host string / required	The Cisco CATALYST Center hostname.
_password string	The Cisco CATALYST Center password to authenticate.
_username aliases: user string	The Cisco CATALYST Center username to authenticate. Default: :ansible-option-default:`"admin"`
_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
_version string	Informs the SDK which version of Cisco CATALYST Center to use. Default: :ansible-option-default:`"2.3.7.6"`
id string	Id path parameter. Id of custom application set to delete.
payload list / elements=dictionary	Application Policy Application Set's payload.
defaultBusinessRelevance string	Default business relevance.
name string	Application Set name.
namespace string	Namespace, should be set to scalablegroup application.
qualifier string	Qualifier, should be set to application.
scalableGroupExternalHandle string	Scalable group external handle, should be set to application set name.
scalableGroupType string	Scalable group type, should be set to APPLICATION_GROUP.
type string	Type, should be set to scalablegroup.
validate_response_schema boolean	Flag for Cisco CATALYST Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)

Notes

Note

• SDK Method used are application_policy.ApplicationPolicy.create_application_sets_v2, application_policy.ApplicationPolicy.delete_application_set_v2,

• Paths used are post /dna/intent/api/v2/application-policy-application-set, delete /dna/intent/api/v2/application-policy-application-set/{id},

• It should be noted that this module is an alias of application_policy_application_set_v2

• Does not support 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 CATALYST SDK

• The parameters starting with catalystCenter_ are used by the Cisco CATALYST Python SDK to establish the connection

See Also

See also

Cisco DNA Center documentation for Application Policy CreateApplicationSetsV2

Complete reference of the CreateApplicationSetsV2 API.

Cisco DNA Center documentation for Application Policy DeleteApplicationSetV2

Complete reference of the DeleteApplicationSetV2 API.

Examples

- name: Create
  cisco.catalystcenter.application_policy_application_set:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    state: present
    payload:
      - defaultBusinessRelevance: string
        name: string
        namespace: string
        qualifier: string
        scalableGroupExternalHandle: string
        scalableGroupType: string
        type: string
- name: Delete by id
  cisco.catalystcenter.application_policy_application_set:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    state: absent
    id: string

Return Values

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

Key	Description
catalystcenter_response dictionary	A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)