.. 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-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.dnac.assurance_events_count_v1_info_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.assurance_events_count_v1_info module -- Information module for Assurance Events Count V1 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.dnac collection <https://galaxy.ansible.com/cisco/dnac>`_ (version 6.27.0). To install it, use: :code:`ansible-galaxy collection install cisco.dnac`. You need further requirements to be able to use this module, see :ref:`Requirements <ansible_collections.cisco.dnac.assurance_events_count_v1_info_module_requirements>` for details. To use it in a playbook, specify: :code:`cisco.dnac.assurance_events_count_v1_info`. .. version_added .. rst-class:: ansible-version-added New in cisco.dnac 6.15.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Get all Assurance Events Count V1. - API to fetch the count of assurance events that match the filter criteria. Please refer to the 'API Support Documentation' section to understand which fields are supported. For detailed information about the usage of the API, please refer to the Open API specification document - https //github.com/cisco-en-programmability/catalyst- center-api-specs/blob/main/Assurance/CE\_Cat\_Center\_Org-AssuranceEvents-1.0.0-resolved.yaml. .. note:: This module has a corresponding :ref:`action plugin <action_plugins>`. .. Aliases .. Requirements .. _ansible_collections.cisco.dnac.assurance_events_count_v1_info_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk \>= 2.4.9 - 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-apMac"></div> .. _ansible_collections.cisco.dnac.assurance_events_count_v1_info_module__parameter-apmac: .. rst-class:: ansible-option-title **apMac** .. raw:: html <a class="ansibleOptionLink" href="#parameter-apMac" 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"> ApMac query parameter. MAC address of the access point. This parameter is applicable for \`Unified AP\` and \`Wireless Client\` events. This field supports wildcard (\`\*\`) character-based search. Ex \`\*50 0F\*\` or \`50 0F\*\` or \`\*50 0F\` Examples \`apMac=50 0F 80 0F F7 E0\` (single apMac requested) \`apMac=50 0F 80 0F F7 E0&apMac=18 80 90 AB 7E A0\` (multiple apMac requested). .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-clientMac"></div> .. _ansible_collections.cisco.dnac.assurance_events_count_v1_info_module__parameter-clientmac: .. rst-class:: ansible-option-title **clientMac** .. raw:: html <a class="ansibleOptionLink" href="#parameter-clientMac" 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"> ClientMac query parameter. MAC address of the client. This parameter is applicable for \`Wired Client\` and \`Wireless Client\` events. This field supports wildcard (\`\*\`) character-based search. Ex \`\*66 2B\*\` or \`66 2B\*\` or \`\*66 2B\` Examples \`clientMac=66 2B B8 D2 01 56\` (single clientMac requested) \`clientMac=66 2B B8 D2 01 56&clientMac=DC A6 32 F5 5A 89\` (multiple clientMac requested). .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-deviceFamily"></div> .. _ansible_collections.cisco.dnac.assurance_events_count_v1_info_module__parameter-devicefamily: .. rst-class:: ansible-option-title **deviceFamily** .. raw:: html <a class="ansibleOptionLink" href="#parameter-deviceFamily" 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"> DeviceFamily query parameter. Device family. Please note that multiple families across network device type and client type is not allowed. For example, choosing \`Routers\` along with \`Wireless Client\` or \`Unified AP\` is not supported. Examples \`deviceFamily=Switches and Hubs\` (single deviceFamily requested) \`deviceFamily=Switches and Hubs&deviceFamily=Routers\` (multiple deviceFamily requested). .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-dnac_debug"></div> .. _ansible_collections.cisco.dnac.assurance_events_count_v1_info_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-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-dnac_host"></div> .. _ansible_collections.cisco.dnac.assurance_events_count_v1_info_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.assurance_events_count_v1_info_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.assurance_events_count_v1_info_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.assurance_events_count_v1_info_module__parameter-dnac_username: .. _ansible_collections.cisco.dnac.assurance_events_count_v1_info_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.assurance_events_count_v1_info_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:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-dnac_version"></div> .. _ansible_collections.cisco.dnac.assurance_events_count_v1_info_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.3.7.6"` .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-endTime"></div> .. _ansible_collections.cisco.dnac.assurance_events_count_v1_info_module__parameter-endtime: .. rst-class:: ansible-option-title **endTime** .. raw:: html <a class="ansibleOptionLink" href="#parameter-endTime" 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"> EndTime query parameter. End time to which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. If \`endTime\` is not provided, API will default to current time. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-headers"></div> .. _ansible_collections.cisco.dnac.assurance_events_count_v1_info_module__parameter-headers: .. rst-class:: ansible-option-title **headers** .. raw:: html <a class="ansibleOptionLink" href="#parameter-headers" 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-cell"> Additional headers. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-messageType"></div> .. _ansible_collections.cisco.dnac.assurance_events_count_v1_info_module__parameter-messagetype: .. rst-class:: ansible-option-title **messageType** .. raw:: html <a class="ansibleOptionLink" href="#parameter-messageType" 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"> MessageType query parameter. Message type for the event. Examples \`messageType=Syslog\` (single messageType requested) \`messageType=Trap&messageType=Syslog\` (multiple messageType requested). .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-networkDeviceId"></div> .. _ansible_collections.cisco.dnac.assurance_events_count_v1_info_module__parameter-networkdeviceid: .. rst-class:: ansible-option-title **networkDeviceId** .. raw:: html <a class="ansibleOptionLink" href="#parameter-networkDeviceId" 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"> NetworkDeviceId query parameter. The list of Network Device Uuids. (Ex. \`6bef213c-19ca-4170-8375-b694e251101c\`) Examples \`networkDeviceId=6bef213c-19ca-4170-8375-b694e251101c\` (single networkDeviceId requested) \`networkDeviceId=6bef213c-19ca-4170-8375- b694e251101c&networkDeviceId=32219612-819e-4b5e-a96b-cf22aca13dd9&networkDeviceId=2541e9a7-b80d-4955-8aa2- 79b233318ba0\` (multiple networkDeviceId requested). .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-networkDeviceName"></div> .. _ansible_collections.cisco.dnac.assurance_events_count_v1_info_module__parameter-networkdevicename: .. rst-class:: ansible-option-title **networkDeviceName** .. raw:: html <a class="ansibleOptionLink" href="#parameter-networkDeviceName" 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"> NetworkDeviceName query parameter. Network device name. This parameter is applicable for network device related families. This field supports wildcard (\`\*\`) character-based search. Ex \`\*Branch\*\` or \`Branch\*\` or \`\*Branch\` Examples \`networkDeviceName=Branch-3-Gateway\` (single networkDeviceName requested) \`networkDeviceName=Branch-3-Gateway&networkDeviceName=Branch-3-Switch\` (multiple networkDeviceName requested). .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-severity"></div> .. _ansible_collections.cisco.dnac.assurance_events_count_v1_info_module__parameter-severity: .. rst-class:: ansible-option-title **severity** .. raw:: html <a class="ansibleOptionLink" href="#parameter-severity" 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"> Severity query parameter. Severity of the event between 0 and 6. This is applicable only for events related to network devices (other than AP) and \`Wired Client\` events. | Value | Severity | | ----- | ----------- | | 0 | Emergency | | 1 | Alert | | 2 | Critical | | 3 | Error | | 4 | Warning | | 5 | Notice | | 6 | Info | Examples \`severity=0\` (single severity requested) \`severity=0&severity=1\` (multiple severity requested). .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-siteHierarchyId"></div> .. _ansible_collections.cisco.dnac.assurance_events_count_v1_info_module__parameter-sitehierarchyid: .. rst-class:: ansible-option-title **siteHierarchyId** .. raw:: html <a class="ansibleOptionLink" href="#parameter-siteHierarchyId" 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"> SiteHierarchyId query parameter. The full hierarchy breakdown of the site tree in id form starting from Global site UUID and ending with the specific site UUID. (Ex. \`globalUuid/areaUuid/buildingUuid/floorUuid\`) This field supports wildcard asterisk (\`\*\`) character search support. E.g. \`\*uuid\*, \*uuid, uuid\*\` Examples \`?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid \`(single siteHierarchyId requested) \`?siteHiera rchyId=globalUuid/areaUuid/buildingUuid/floorUuid&siteHierarchyId=globalUuid/areaUuid2/buildingUuid2/floorUu id2\` (multiple siteHierarchyId requested). .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-siteId"></div> .. _ansible_collections.cisco.dnac.assurance_events_count_v1_info_module__parameter-siteid: .. rst-class:: ansible-option-title **siteId** .. raw:: html <a class="ansibleOptionLink" href="#parameter-siteId" 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"> SiteId query parameter. The UUID of the site. (Ex. \`flooruuid\`) Examples \`?siteId=id1\` (single siteId requested) \`?siteId=id1&siteId=id2&siteId=id3\` (multiple siteId requested). .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-startTime"></div> .. _ansible_collections.cisco.dnac.assurance_events_count_v1_info_module__parameter-starttime: .. rst-class:: ansible-option-title **startTime** .. raw:: html <a class="ansibleOptionLink" href="#parameter-startTime" 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"> StartTime query parameter. Start time from which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. If \`startTime\` is not provided, API will default to current time minus 24 hours. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-validate_response_schema"></div> .. _ansible_collections.cisco.dnac.assurance_events_count_v1_info_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:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html </div> .. Attributes .. Notes Notes ----- .. note:: - SDK Method used are devices.Devices.count\_the\_number\_of\_events\_v1, - Paths used are get /dna/data/api/v1/assuranceEvents/count, - Supports \ :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 See Also -------- .. seealso:: `Cisco DNA Center documentation for Devices CountTheNumberOfEventsV1 <https://developer.cisco.com/docs/dna-center/#!count-the-number-of-events>`_ Complete reference of the CountTheNumberOfEventsV1 API. .. Examples Examples -------- .. code-block:: yaml+jinja - name: Get all Assurance Events Count V1 cisco.dnac.assurance_events_count_v1_info: 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}}" headers: "{{my_headers | from_json}}" deviceFamily: string startTime: string endTime: string messageType: string severity: string siteId: string siteHierarchyId: string networkDeviceName: string networkDeviceId: string apMac: string clientMac: string register: result .. 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.assurance_events_count_v1_info_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:` :ansible-rv-sample-value:`{"response": {"count": 0}, "version": "string"}` .. raw:: html </div> .. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html <p class="ansible-links"> <a href="https://github.com/cisco-en-programmability/dnacenter-ansible/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a> <a href="https://github.com/cisco-en-programmability/dnacenter-ansible" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a> </p> .. Parsing errors