cisco.dnac.event_subscription – Resource module for Event Subscription

Note

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

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

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

New in version 1.0.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

Parameters

Parameter				Choices/Defaults	Comments
payload list / elements=string					Event Subscription's payload.
	description string				Event Subscription's description.
	filter dictionary				Event Subscription's filter.
		eventIds list / elements=string			Event Subscription's eventIds.
	name string				Event Subscription's name.
	subscriptionEndpoints list / elements=string				Event Subscription's subscriptionEndpoints.
		instanceId string			Event Subscription's instanceId.
		subscriptionDetails dictionary			Event Subscription's subscriptionDetails.
			connectorType string		Event Subscription's connectorType.
			method string		Event Subscription's method.
			name string		Event Subscription's name.
			url string		Event Subscription's url.
	subscriptionId string				Event Subscription's subscriptionId.
	version string				Event Subscription's version.
subscriptions string					Subscriptions query parameter. List of EventSubscriptionId's for removal.

See Also

See also

Event Subscription reference

Complete reference of the Event Subscription object model.

Examples

- 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

- 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

- 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

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)