cisco.dnac.event_subscription – Manage EventSubscription objects of EventManagement

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

New in version 1.0.0: of cisco.dnac

Synopsis

• Delete EventSubscriptions.

• Gets the list of Subscriptions’s based on provided offset and limit.

• Subscribe SubscriptionEndpoint to list of registered events.

• Update SubscriptionEndpoint to list of registered events.

• Returns the Count of EventSubscriptions.

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.
event_ids string					List of subscriptions related to the respective eventIds. Required for state query.
limit integer					The number of Subscriptions's to limit in the resultset whose default value 10.
offset integer					The number of Subscriptions's to offset in the resultset whose default value 0.
order string					Order query parameter.
payload list / elements=dictionary / required					An object to send in the Request body.
	description string				It is the event subscription's description.
	filter dictionary / required				It is the event subscription's filter.
		eventIds list / elements=string			It is the event subscription's eventIds.
	name string				It is the event subscription's name.
	subscriptionEndpoints list / elements=dictionary				It is the event subscription's subscriptionEndpoints.
		instanceId string			It is the event subscription's instanceId.
		subscriptionDetails dictionary			It is the event subscription's subscriptionDetails.
			connectorType string		It is the event subscription's connectorType.
			method string		It is the event subscription's method.
			name string		It is the event subscription's name.
			url string		It is the event subscription's url.
	subscriptionId string				It is the event subscription's subscriptionId.
	version string				It is the event subscription's version.
sort_by string					SortBy field name.
subscriptions string					List of EventSubscriptionId's for removal. Required for state delete.

See Also

See also

cisco.dnac.plugins.module_utils.definitions.event_subscription

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

EventSubscription reference

Complete reference of the EventSubscription object model.

EventSubscription reference

SDK reference.

Examples

- name: delete_event_subscriptions
  cisco.dnac.event_subscription:
    state: delete  # required
    subscriptions: SomeValue  # string, required

- name: get_event_subscriptions
  cisco.dnac.event_subscription:
    state: query  # required
    event_ids: SomeValue  # string
    limit: 1  #  number
    offset: 1  #  number
    order: SomeValue  # string
    sort_by: SomeValue  # string
  register: nm_get_event_subscriptions

- name: create_event_subscriptions
  cisco.dnac.event_subscription:
    state: create  # required
    payload:  # required
    - filter:  # required
        eventIds:
        - SomeValue  # string
      subscriptionId: SomeValue  # string
      version: SomeValue  # string
      name: SomeValue  # string
      description: SomeValue  # string
      subscriptionEndpoints:
      - instanceId: SomeValue  # string
        subscriptionDetails:
          name: SomeValue  # string
          url: SomeValue  # string
          method: SomeValue  # string
          connectorType: SomeValue  # string

- name: update_event_subscriptions
  cisco.dnac.event_subscription:
    state: update  # required
    payload:  # required
    - filter:  # required
        eventIds:
        - SomeValue  # string
      subscriptionId: SomeValue  # string
      version: SomeValue  # string
      name: SomeValue  # string
      description: SomeValue  # string
      subscriptionEndpoints:
      - instanceId: SomeValue  # string
        subscriptionDetails:
          name: SomeValue  # string
          url: SomeValue  # string
          method: SomeValue  # string
          connectorType: SomeValue  # string

- name: count_of_event_subscriptions
  cisco.dnac.event_subscription:
    state: query  # required
    event_ids: SomeValue  # string, required
    count: True  # boolean, required
  register: nm_count_of_event_subscriptions

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: event_management.count_of_event_subscriptions

Authors

• Rafael Campos (@racampos)