/ home / cisco / cisco.dnac / 6.13.3 / module / event_artifact_info

cisco.dnac.event_artifact_info (6.13.3) — module

Information module for Event Artifact

| "added in version" 3.1.0 of cisco.dnac"

Authors: Rafael Campos (@racampos)

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install cisco.dnac:==6.13.3

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 6.13.3

Description

Get all Event Artifact.

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

Requirements

dnacentersdk >= 2.6.0
python >= 3.9

Usage examples

Scanned by Steampunk Spotter

- 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

Inputs

    
tags:
    description:
    - Tags query parameter. Tags defined.
    type: str

limit:
    description:
    - Limit query parameter.
    type: int

order:
    description:
    - Order query parameter. Sorting order (asc/desc).
    type: str

offset:
    description:
    - Offset query parameter. Record start offset.
    type: int

search:
    description:
    - Search query parameter. Findd matches in name, description, eventId, type, category.
    type: str

sortBy:
    description:
    - SortBy query parameter. Sort by field.
    type: str

headers:
    description: Additional headers.
    type: dict

eventIds:
    description:
    - EventIds query parameter. List of eventIds.
    type: str

dnac_host:
    description:
    - The Cisco DNA Center hostname.
    required: true
    type: str

dnac_port:
    default: 443
    description:
    - The Cisco DNA Center port.
    type: int

dnac_debug:
    default: false
    description:
    - Flag for Cisco DNA Center SDK to enable debugging.
    type: bool

dnac_verify:
    default: true
    description:
    - Flag to enable or disable SSL certificate verification.
    type: bool

dnac_version:
    default: 2.3.5.3
    description:
    - Informs the SDK which version of Cisco DNA Center to use.
    type: str

dnac_password:
    description:
    - The Cisco DNA Center password to authenticate.
    type: str

dnac_username:
    aliases:
    - user
    default: admin
    description:
    - The Cisco DNA Center username to authenticate.
    type: str

validate_response_schema:
    default: true
    description:
    - Flag for Cisco DNA Center SDK to enable the validation of request bodies against
      a JSON schema.
    type: bool

Outputs

dnac_response:
  description: A dictionary or list with the response returned by the Cisco DNAC Python
    SDK
  elements: dict
  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"
  type: list