.. 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_series_audit_logs_info_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.event_series_audit_logs_info module -- Information module for Event Series Audit Logs ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.dnac collection `_ (version 6.5.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_series_audit_logs_info`. .. version_added .. versionadded:: 3.1.0 of cisco.dnac .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Get all Event Series Audit Logs. - Get Audit Log Event instances from the Event-Hub. .. 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 >= 2.5.0 - python >= 3.5 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.dnac.event_series_audit_logs_info_module__parameter-category: .. rst-class:: ansible-option-title **category** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Category query parameter. Audit Log notification's event category. Supported values INFO, WARN, ERROR, ALERT, TASK_PROGRESS, TASK_FAILURE, TASK_COMPLETE, COMMAND, QUERY, CONVERSATION. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.event_series_audit_logs_info_module__parameter-context: .. rst-class:: ansible-option-title **context** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Context query parameter. Audit Log notification's event correlationId. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.event_series_audit_logs_info_module__parameter-description: .. rst-class:: ansible-option-title **description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Description query parameter. String full/partial search - (Provided input string is case insensitively matched for records). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.event_series_audit_logs_info_module__parameter-deviceid: .. rst-class:: ansible-option-title **deviceId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
DeviceId query parameter. Audit Log notification's deviceId. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.event_series_audit_logs_info_module__parameter-dnac_debug: .. rst-class:: ansible-option-title **dnac_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
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
* - .. raw:: html
.. _ansible_collections.cisco.dnac.event_series_audit_logs_info_module__parameter-dnac_host: .. rst-class:: ansible-option-title **dnac_host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Cisco DNA Center hostname. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.event_series_audit_logs_info_module__parameter-dnac_password: .. rst-class:: ansible-option-title **dnac_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco DNA Center password to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.event_series_audit_logs_info_module__parameter-dnac_port: .. rst-class:: ansible-option-title **dnac_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The Cisco DNA Center port. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`443` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.event_series_audit_logs_info_module__parameter-dnac_username: .. _ansible_collections.cisco.dnac.event_series_audit_logs_info_module__parameter-user: .. rst-class:: ansible-option-title **dnac_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: user` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco DNA Center username to authenticate. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"admin"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.event_series_audit_logs_info_module__parameter-dnac_verify: .. rst-class:: ansible-option-title **dnac_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
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
* - .. raw:: html
.. _ansible_collections.cisco.dnac.event_series_audit_logs_info_module__parameter-dnac_version: .. rst-class:: ansible-option-title **dnac_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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.3.0"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.event_series_audit_logs_info_module__parameter-domain: .. rst-class:: ansible-option-title **domain** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Domain query parameter. Audit Log notification's event domain. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.event_series_audit_logs_info_module__parameter-endtime: .. rst-class:: ansible-option-title **endTime** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
EndTime query parameter. End Time in milliseconds since Epoch Eg. 1597961437211 (when provided startTime is mandatory). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.event_series_audit_logs_info_module__parameter-eventhierarchy: .. rst-class:: ansible-option-title **eventHierarchy** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
EventHierarchy query parameter. Audit Log notification's event eventHierarchy. Example "US.CA.San Jose" OR "US.CA" OR "CA.San Jose" - Delimiter for hierarchy separation is ".". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.event_series_audit_logs_info_module__parameter-eventid: .. rst-class:: ansible-option-title **eventId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
EventId query parameter. Audit Log notification's event ID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.event_series_audit_logs_info_module__parameter-headers: .. rst-class:: ansible-option-title **headers** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Additional headers. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.event_series_audit_logs_info_module__parameter-instanceid: .. rst-class:: ansible-option-title **instanceId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
InstanceId query parameter. InstanceID of the Audit Log. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.event_series_audit_logs_info_module__parameter-issystemevents: .. rst-class:: ansible-option-title **isSystemEvents** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
IsSystemEvents query parameter. Parameter to filter system generated audit-logs. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`no` - :ansible-option-choices-entry:`yes` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.event_series_audit_logs_info_module__parameter-limit: .. rst-class:: ansible-option-title **limit** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Limit query parameter. Number of Audit Log records to be returned per page. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.event_series_audit_logs_info_module__parameter-name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name query parameter. Audit Log notification event name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.event_series_audit_logs_info_module__parameter-offset: .. rst-class:: ansible-option-title **offset** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Offset query parameter. Position of a particular Audit Log record in the data. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.event_series_audit_logs_info_module__parameter-order: .. rst-class:: ansible-option-title **order** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Order query parameter. Order of the sorted Audit Log records. Default value is desc by timestamp. Supported values asc, desc. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.event_series_audit_logs_info_module__parameter-parentinstanceid: .. rst-class:: ansible-option-title **parentInstanceId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
ParentInstanceId query parameter. Parent Audit Log record's instanceID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.event_series_audit_logs_info_module__parameter-severity: .. rst-class:: ansible-option-title **severity** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Severity query parameter. Audit Log notification's event severity. Supported values 1, 2, 3, 4, 5. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.event_series_audit_logs_info_module__parameter-siteid: .. rst-class:: ansible-option-title **siteId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
SiteId query parameter. Audit Log notification's siteId. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.event_series_audit_logs_info_module__parameter-sortby: .. rst-class:: ansible-option-title **sortBy** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
SortBy query parameter. Sort the Audit Logs by certain fields. Supported values are event notification header attributes. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.event_series_audit_logs_info_module__parameter-source: .. rst-class:: ansible-option-title **source** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Source query parameter. Audit Log notification's event source. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.event_series_audit_logs_info_module__parameter-starttime: .. rst-class:: ansible-option-title **startTime** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
StartTime query parameter. Start Time in milliseconds since Epoch Eg. 1597950637211 (when provided endTime is mandatory). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.event_series_audit_logs_info_module__parameter-subdomain: .. rst-class:: ansible-option-title **subDomain** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
SubDomain query parameter. Audit Log notification's event sub-domain. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.event_series_audit_logs_info_module__parameter-userid: .. rst-class:: ansible-option-title **userId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
UserId query parameter. Audit Log notification's event userId. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.event_series_audit_logs_info_module__parameter-validate_response_schema: .. rst-class:: ansible-option-title **validate_response_schema** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
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
.. Attributes .. Notes Notes ----- .. note:: - SDK Method used are event_management.EventManagement.get_auditlog_records, - Paths used are get /dna/data/api/v1/event/event-series/audit-logs, - 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 Event Management GetAuditLogRecords `_ Complete reference of the GetAuditLogRecords API. .. Examples Examples -------- .. code-block:: yaml+jinja - name: Get all Event Series Audit Logs cisco.dnac.event_series_audit_logs_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}}" parentInstanceId: string instanceId: string name: string eventId: string category: string severity: string domain: string subDomain: string source: string userId: string context: string eventHierarchy: string siteId: string deviceId: string isSystemEvents: True description: string offset: 0 limit: 0 startTime: 0 endTime: 0 sortBy: string order: string register: result .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, 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
.. _ansible_collections.cisco.dnac.event_series_audit_logs_info_module__return-dnac_response: .. rst-class:: ansible-option-title **dnac_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
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 {\\n \\"version\\": \\"string\\",\\n \\"instanceId\\": \\"string\\",\\n \\"eventId\\": \\"string\\",\\n \\"namespace\\": \\"string\\",\\n \\"name\\": \\"string\\",\\n \\"description\\": \\"string\\",\\n \\"type\\": \\"string\\",\\n \\"category\\": \\"string\\",\\n \\"domain\\": \\"string\\",\\n \\"subDomain\\": \\"string\\",\\n \\"severity\\": 0,\\n \\"source\\": \\"string\\",\\n \\"timestamp\\": 0,\\n \\"tags\\": [\\n {}\\n ],\\n \\"details\\": {},\\n \\"ciscoDnaEventLink\\": \\"string\\",\\n \\"note\\": \\"string\\",\\n \\"tntId\\": \\"string\\",\\n \\"context\\": \\"string\\",\\n \\"userId\\": \\"string\\",\\n \\"i18n\\": \\"string\\",\\n \\"eventHierarchy\\": \\"string\\",\\n \\"message\\": \\"string\\",\\n \\"messageParams\\": \\"string\\",\\n \\"additionalDetails\\": {},\\n \\"parentInstanceId\\": \\"string\\",\\n \\"network\\": \\"string\\",\\n \\"childCount\\": 0,\\n \\"tenantId\\": \\"string\\"\\n }\\n]\\n" .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors