.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-entry .. role:: ansible-option-default .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.dnac.event_subscription_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.event_subscription module -- Resource module for Event Subscription ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.dnac collection <https://galaxy.ansible.com/cisco/dnac>`_ (version 6.2.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 :code:`ansible-galaxy collection list`. 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:: 3.1.0 of cisco.dnac .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operations create, update and delete of the resource Event Subscription. - Subscribe SubscriptionEndpoint to list of registered events. - Delete EventSubscriptions. - Update SubscriptionEndpoint to list of registered events. .. note:: This module has a corresponding :ref:`action plugin <action_plugins>`. .. Aliases .. Requirements Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk >= 2.4.8 - python >= 3.5 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-dnac_debug"></div> .. _ansible_collections.cisco.dnac.event_subscription_module__parameter-dnac_debug: .. rst-class:: ansible-option-title **dnac_debug** .. raw:: html <a class="ansibleOptionLink" href="#parameter-dnac_debug" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> Flag for Cisco DNA Center SDK to enable debugging. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-default-bold:`no` :ansible-option-default:`← (default)` - :ansible-option-choices-entry:`yes` .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-dnac_host"></div> .. _ansible_collections.cisco.dnac.event_subscription_module__parameter-dnac_host: .. rst-class:: ansible-option-title **dnac_host** .. raw:: html <a class="ansibleOptionLink" href="#parameter-dnac_host" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> The Cisco DNA Center hostname. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-dnac_password"></div> .. _ansible_collections.cisco.dnac.event_subscription_module__parameter-dnac_password: .. rst-class:: ansible-option-title **dnac_password** .. raw:: html <a class="ansibleOptionLink" href="#parameter-dnac_password" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> The Cisco DNA Center password to authenticate. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-dnac_port"></div> .. _ansible_collections.cisco.dnac.event_subscription_module__parameter-dnac_port: .. rst-class:: ansible-option-title **dnac_port** .. raw:: html <a class="ansibleOptionLink" href="#parameter-dnac_port" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> The Cisco DNA Center port. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`443` .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-dnac_username"></div> <div class="ansibleOptionAnchor" id="parameter-user"></div> .. _ansible_collections.cisco.dnac.event_subscription_module__parameter-dnac_username: .. _ansible_collections.cisco.dnac.event_subscription_module__parameter-user: .. rst-class:: ansible-option-title **dnac_username** .. raw:: html <a class="ansibleOptionLink" href="#parameter-dnac_username" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: user` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> The Cisco DNA Center username to authenticate. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"admin"` .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-dnac_verify"></div> .. _ansible_collections.cisco.dnac.event_subscription_module__parameter-dnac_verify: .. rst-class:: ansible-option-title **dnac_verify** .. raw:: html <a class="ansibleOptionLink" href="#parameter-dnac_verify" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> Flag to enable or disable SSL certificate verification. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`no` - :ansible-option-default-bold:`yes` :ansible-option-default:`← (default)` .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-dnac_version"></div> .. _ansible_collections.cisco.dnac.event_subscription_module__parameter-dnac_version: .. rst-class:: ansible-option-title **dnac_version** .. raw:: html <a class="ansibleOptionLink" href="#parameter-dnac_version" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> Informs the SDK which version of Cisco DNA Center to use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"2.2.3.3"` .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-payload"></div> .. _ansible_collections.cisco.dnac.event_subscription_module__parameter-payload: .. rst-class:: ansible-option-title **payload** .. raw:: html <a class="ansibleOptionLink" href="#parameter-payload" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> Event Subscription's payload. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-payload/description"></div> .. _ansible_collections.cisco.dnac.event_subscription_module__parameter-payload/description: .. rst-class:: ansible-option-title **description** .. raw:: html <a class="ansibleOptionLink" href="#parameter-payload/description" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"> Description. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-payload/filter"></div> .. _ansible_collections.cisco.dnac.event_subscription_module__parameter-payload/filter: .. rst-class:: ansible-option-title **filter** .. raw:: html <a class="ansibleOptionLink" href="#parameter-payload/filter" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html </div> - .. raw:: html <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"> Event Subscription's filter. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-payload/filter/eventIds"></div> .. _ansible_collections.cisco.dnac.event_subscription_module__parameter-payload/filter/eventIds: .. rst-class:: ansible-option-title **eventIds** .. raw:: html <a class="ansibleOptionLink" href="#parameter-payload/filter/eventIds" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"> Event Ids. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-payload/name"></div> .. _ansible_collections.cisco.dnac.event_subscription_module__parameter-payload/name: .. rst-class:: ansible-option-title **name** .. raw:: html <a class="ansibleOptionLink" href="#parameter-payload/name" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"> Name. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-payload/subscriptionEndpoints"></div> .. _ansible_collections.cisco.dnac.event_subscription_module__parameter-payload/subscriptionEndpoints: .. rst-class:: ansible-option-title **subscriptionEndpoints** .. raw:: html <a class="ansibleOptionLink" href="#parameter-payload/subscriptionEndpoints" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html </div> - .. raw:: html <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"> Event Subscription's subscriptionEndpoints. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-payload/subscriptionEndpoints/instanceId"></div> .. _ansible_collections.cisco.dnac.event_subscription_module__parameter-payload/subscriptionEndpoints/instanceId: .. rst-class:: ansible-option-title **instanceId** .. raw:: html <a class="ansibleOptionLink" href="#parameter-payload/subscriptionEndpoints/instanceId" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"> Instance Id. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-payload/subscriptionEndpoints/subscriptionDetails"></div> .. _ansible_collections.cisco.dnac.event_subscription_module__parameter-payload/subscriptionEndpoints/subscriptionDetails: .. rst-class:: ansible-option-title **subscriptionDetails** .. raw:: html <a class="ansibleOptionLink" href="#parameter-payload/subscriptionEndpoints/subscriptionDetails" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html </div> - .. raw:: html <div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"> Event Subscription's subscriptionDetails. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-payload/subscriptionEndpoints/subscriptionDetails/connectorType"></div> .. _ansible_collections.cisco.dnac.event_subscription_module__parameter-payload/subscriptionEndpoints/subscriptionDetails/connectorType: .. rst-class:: ansible-option-title **connectorType** .. raw:: html <a class="ansibleOptionLink" href="#parameter-payload/subscriptionEndpoints/subscriptionDetails/connectorType" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"> Connector Type. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-payload/subscriptionEndpoints/subscriptionDetails/method"></div> .. _ansible_collections.cisco.dnac.event_subscription_module__parameter-payload/subscriptionEndpoints/subscriptionDetails/method: .. rst-class:: ansible-option-title **method** .. raw:: html <a class="ansibleOptionLink" href="#parameter-payload/subscriptionEndpoints/subscriptionDetails/method" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"> Method. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-payload/subscriptionEndpoints/subscriptionDetails/name"></div> .. _ansible_collections.cisco.dnac.event_subscription_module__parameter-payload/subscriptionEndpoints/subscriptionDetails/name: .. rst-class:: ansible-option-title **name** .. raw:: html <a class="ansibleOptionLink" href="#parameter-payload/subscriptionEndpoints/subscriptionDetails/name" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"> Name. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-payload/subscriptionEndpoints/subscriptionDetails/url"></div> .. _ansible_collections.cisco.dnac.event_subscription_module__parameter-payload/subscriptionEndpoints/subscriptionDetails/url: .. rst-class:: ansible-option-title **url** .. raw:: html <a class="ansibleOptionLink" href="#parameter-payload/subscriptionEndpoints/subscriptionDetails/url" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"> Url. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-payload/subscriptionId"></div> .. _ansible_collections.cisco.dnac.event_subscription_module__parameter-payload/subscriptionId: .. rst-class:: ansible-option-title **subscriptionId** .. raw:: html <a class="ansibleOptionLink" href="#parameter-payload/subscriptionId" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"> Subscription Id. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-payload/version"></div> .. _ansible_collections.cisco.dnac.event_subscription_module__parameter-payload/version: .. rst-class:: ansible-option-title **version** .. raw:: html <a class="ansibleOptionLink" href="#parameter-payload/version" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"> Version. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-subscriptions"></div> .. _ansible_collections.cisco.dnac.event_subscription_module__parameter-subscriptions: .. rst-class:: ansible-option-title **subscriptions** .. raw:: html <a class="ansibleOptionLink" href="#parameter-subscriptions" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> Subscriptions query parameter. List of EventSubscriptionId's for removal. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-validate_response_schema"></div> .. _ansible_collections.cisco.dnac.event_subscription_module__parameter-validate_response_schema: .. rst-class:: ansible-option-title **validate_response_schema** .. raw:: html <a class="ansibleOptionLink" href="#parameter-validate_response_schema" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`no` - :ansible-option-default-bold:`yes` :ansible-option-default:`← (default)` .. raw:: html </div> .. Attributes .. Notes Notes ----- .. note:: - SDK Method used are event_management.EventManagement.create_event_subscriptions, event_management.EventManagement.delete_event_subscriptions, event_management.EventManagement.update_event_subscriptions, - Paths used are post /dna/intent/api/v1/event/subscription, delete /dna/intent/api/v1/event/subscription, put /dna/intent/api/v1/event/subscription, - Does not support \ :literal:`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 .. Seealso .. Examples Examples -------- .. code-block:: yaml+jinja - 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: - description: string filter: eventIds: - string name: string subscriptionEndpoints: - instanceId: string subscriptionDetails: connectorType: string method: string name: string url: string subscriptionId: string version: string - 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: - description: string filter: eventIds: - string name: string subscriptionEndpoints: - instanceId: string subscriptionDetails: connectorType: string method: string name: string url: string subscriptionId: string version: string .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="return-dnac_response"></div> .. _ansible_collections.cisco.dnac.event_subscription_module__return-dnac_response: .. rst-class:: ansible-option-title **dnac_response** .. raw:: html <a class="ansibleOptionLink" href="#return-dnac_response" title="Permalink to this return value"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> A dictionary or list with the response returned by the Cisco DNAC Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` "{\\n \\"statusUri\\": \\"string\\"\\n}\\n" .. raw:: html </div> .. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Parsing errors