.. Document meta :orphan: .. Anchors .. _ansible_collections.cisco.dnac.event_subscription_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.event_subscription -- Resource module for Event Subscription +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This plugin is part of the `cisco.dnac collection `_ (version 3.0.0). To install it use: :code:`ansible-galaxy collection install cisco.dnac`. To use it in a playbook, specify: :code:`cisco.dnac.event_subscription`. .. version_added .. versionadded:: 1.0.0 of cisco.dnac .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operations create, update and delete of the resource Event Subscription. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk .. Options Parameters ---------- .. raw:: html

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

.. Notes .. Seealso See Also -------- .. seealso:: `Event Subscription reference `_ Complete reference of the Event Subscription object model. .. Examples Examples -------- .. code-block:: yaml+jinja - 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 .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. raw:: html

Key	Returned	Description
dnac_response dictionary	always	A dictionary or list with the response returned by the Cisco DNAC Python SDK Sample: { "statusUri": "string" }

.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Parsing errors