cisco.dnac.event_artifact_info – Information module for Event Artifact

Note

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

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

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

New in version 1.0.0: of cisco.dnac

Synopsis

  • Get all Event Artifact.

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
eventIds
string
EventIds query parameter. List of eventIds.
headers
dictionary
Additional headers.
limit
integer
Limit query parameter.
offset
integer
Offset query parameter. Record start offset.
order
string
Order query parameter. Sorting order (asc/desc).
search
string
Search query parameter. Findd matches in name, description, eventId, type, category.
sortBy
string
SortBy query parameter. Sort by field.
tags
string
Tags query parameter. Tags defined.

See Also

See also

Event Artifact reference

Complete reference of the Event Artifact object model.

Examples

- name: Get all Event Artifact
  cisco.dnac.event_artifact_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:
      custom: value
    eventIds: string
    tags: string
    offset: 0
    limit: 0
    sortBy: string
    order: string
    search: string
  register: result

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
dnac_response
list / elements=dictionary
always
A dictionary or list with the response returned by the Cisco DNAC Python SDK

Sample:
[ { "version": "string", "artifactId": "string", "namespace": "string", "name": "string", "description": "string", "domain": "string", "subDomain": "string", "tags": [ "string" ], "isTemplateEnabled": "string", "ciscoDNAEventLink": "string", "note": "string", "isPrivate": "string", "eventPayload": { "eventId": "string", "version": "string", "category": "string", "type": "string", "source": "string", "severity": "string", "details": { "device_ip": "string", "message": "string" }, "additionalDetails": {} }, "eventTemplates": [], "isTenantAware": "string", "supportedConnectorTypes": [ "string" ], "tenantId": "string" } ]


Authors

  • Rafael Campos (@racampos)