cisco.dnac.event_artifact_info module – Information module for Event Artifact

Note

This module is part of the cisco.dnac collection (version 6.6.0).

To install it, use: ansible-galaxy collection install cisco.dnac. You need further requirements to be able to use this module, see Requirements for details.

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

New in version 3.1.0: of cisco.dnac

Synopsis

  • Get all Event Artifact.

  • Gets the list of artifacts based on provided offset and limit.

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk >= 2.5.4

  • python >= 3.5

Parameters

Parameter

Comments

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

  • false ← (default)

  • true

dnac_host

string / required

The Cisco DNA Center hostname.

dnac_password

string

The Cisco DNA Center password to authenticate.

dnac_port

integer

The Cisco DNA Center port.

Default: 443

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: “admin”

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

  • false

  • true ← (default)

dnac_version

string

Informs the SDK which version of Cisco DNA Center to use.

Default: “2.3.3.0”

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).

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.

validate_response_schema

boolean

Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

  • false

  • true ← (default)

Notes

Note

  • SDK Method used are event_management.EventManagement.get_eventartifacts,

  • Paths used are get /dna/system/api/v1/event/artifact,

  • Supports 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

See Also

See also

Cisco DNA Center documentation for Event Management GetEventArtifacts

Complete reference of the GetEventArtifacts API.

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: "{{my_headers | from_json}}"
    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

Description

dnac_response

list / elements=dictionary

A dictionary or list with the response returned by the Cisco DNAC Python SDK

Returned: always

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

Authors

  • Rafael Campos (@racampos)