cisco.dnac.event_subscription_rest – Resource module for Event Subscription Rest

Note

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

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

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

New in version 3.1.0: of cisco.dnac

Synopsis

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

Note

This module has a corresponding action plugin.

Requirements

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

• dnacentersdk >= 2.3.1

• 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.2.3"	Informs the SDK which version of Cisco DNA Center to use.
payload list / elements=string					Event Subscription Rest's payload.
	description string				Description.
	filter dictionary				Event Subscription Rest's filter.
		eventIds list / elements=string			Event Ids (Comma separated event ids).
	name string				Name.
	subscriptionEndpoints list / elements=string				Event Subscription Rest's subscriptionEndpoints.
		instanceId string			(From Get Rest/Webhook Subscription Details --> pick instanceId).
		subscriptionDetails dictionary			Event Subscription Rest's subscriptionDetails.
			connectorType string		Connector Type (Must be REST).
	subscriptionId string				Subscription Id (Unique UUID).
	version string				Version.
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

See Also

See also

Event Subscription Rest reference

Complete reference of the Event Subscription Rest object model.

Examples

- name: Create
  cisco.dnac.event_subscription_rest:
    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: Update all
  cisco.dnac.event_subscription_rest:
    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)