cisco.dnac.event_subscription – Resource module for Event Subscription

Note

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

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

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

New in version 3.1.0: of cisco.dnac

Synopsis

• Manage operations create, update and delete of the resource Event Subscription.

Note

This module has a corresponding action plugin.

Requirements

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

• dnacentersdk >= 2.4.0

• python >= 3.5

Parameters

Parameter				Choices/Defaults	Comments
dnac_debug boolean				Choices: no ← yes	Flag for Cisco DNA Center SDK to enable debugging.
dnac_host string / required					The Cisco DNA Center hostname.
dnac_password string					The Cisco DNA Center password to authenticate.
dnac_port string				Default: 443	The Cisco DNA Center port.
dnac_username string				Default: "admin"	The Cisco DNA Center username to authenticate. aliases: user
dnac_verify boolean				Choices: no yes ←	Flag to enable or disable SSL certificate verification.
dnac_version string				Default: "2.2.3.3"	Informs the SDK which version of Cisco DNA Center to use.
payload list / elements=string					Event Subscription's payload.
	description string				Description.
	filter dictionary				Event Subscription's filter.
		eventIds list / elements=string			Event Ids.
	name string				Name.
	subscriptionEndpoints list / elements=string				Event Subscription's subscriptionEndpoints.
		instanceId string			Instance Id.
		subscriptionDetails dictionary			Event Subscription's subscriptionDetails.
			connectorType string		Connector Type.
			method string		Method.
			name string		Name.
			url string		Url.
	subscriptionId string				Subscription Id.
	version string				Version.
subscriptions string					Subscriptions query parameter. List of EventSubscriptionId's for removal.
validate_response_schema boolean				Choices: no yes ←	Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

Notes

Note

• 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 DNAC SDK

• The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection

See Also

See also

Event Subscription reference

Complete reference of the Event Subscription object model.

Examples

- name: Delete all
  cisco.dnac.event_subscription:
    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
    subscriptions: string

- name: Update all
  cisco.dnac.event_subscription:
    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:

- name: Create
  cisco.dnac.event_subscription:
    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:

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 or list with the response returned by the Cisco DNAC Python SDK Sample: { "statusUri": "string" }

Authors

• Rafael Campos (@racampos)