cisco.dnac.integration_event – Manage IntegrationEvent objects of Itsm

Note

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

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

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

New in version 1.0.0: of cisco.dnac

Synopsis

  • Used to retrieve the list of integration events that failed to create tickets in ITSM.

  • Allows retry of multiple failed ITSM event instances. The retry request payload can be given as a list of strings [“instance1”,”instance2”,”instance3”,..] A minimum of one instance Id is mandatory. The list of failed event instance Ids can be retrieved using the ‘Get Failed ITSM Events’ API in the ‘instanceId’ attribute.

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
instance_id
string
Instance Id of the failed event as in the Runtime Dashboard.
payload
list / elements=string
An object to send in the Request body.
Required for state create.

See Also

See also

cisco.dnac.plugins.module_utils.definitions.integration_event

The official documentation on the cisco.dnac.plugins.module_utils.definitions.integration_event module.

IntegrationEvent reference

Complete reference of the IntegrationEvent object model.

IntegrationEvent reference

SDK reference.

Examples

- name: get_failed_itsm_events
  cisco.dnac.integration_event:
    state: query  # required
    instance_id: SomeValue  # string
  register: nm_get_failed_itsm_events

- name: retry_integration_events
  cisco.dnac.integration_event:
    state: create  # required
    payload:  # required
    - SomeValue  # string

Return Values

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

Key Returned Description
dnac_response
dictionary
always
A dictionary with the response returned by the DNA Center Python SDK

Sample:
{'response': 29, 'version': '1.0'}
missing_params
list / elements=string
when the function request schema is not satisfied
Provided arguments do not comply with the schema of the DNA Center Python SDK function
sdk_function
string
always
The DNA Center SDK function used to execute the task

Sample:
itsm.get_failed_itsm_events


Authors

  • Rafael Campos (@racampos)