cisco.catalystcenter.itsm_integration_events_failed_v1_info module -- Information module for Itsm Integration Events Failed V1
Note
This module is part of the cisco.catalystcenter collection (version 2.1.4).
To install it, use: ansible-galaxy collection install cisco.catalystcenter.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.catalystcenter.itsm_integration_events_failed_v1_info.
New in cisco.catalystcenter 3.1.0
Synopsis
Get all Itsm Integration Events Failed V1.
Used to retrieve the list of integration events that failed to create tickets in ITSM.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
catalystcentersdk >= 2.3.7.9
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
The Cisco CATALYST Center port. Default: :ansible-option-default:`443` |
|
Flag for Cisco CATALYST Center SDK to enable debugging. Choices: |
|
The Cisco CATALYST Center hostname. |
|
The Cisco CATALYST Center password to authenticate. |
|
The Cisco CATALYST Center username to authenticate. Default: :ansible-option-default:`"admin"` |
|
Flag to enable or disable SSL certificate verification. Choices: |
|
Informs the SDK which version of Cisco CATALYST Center to use. Default: :ansible-option-default:`"2.3.7.6"` |
|
Additional headers. |
|
InstanceId query parameter. Instance Id of the failed event as in the Runtime Dashboard. |
|
Flag for Cisco CATALYST Center SDK to enable the validation of request bodies against a JSON schema. Choices: |
Notes
Note
SDK Method used are itsm.Itsm.get_failed_itsm_events_v1,
Paths used are get /dna/intent/api/v1/integration/events,
Supports
check_modeThe plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco CATALYST SDK
The parameters starting with catalystCenter_ are used by the Cisco CATALYST Python SDK to establish the connection
See Also
See also
- Cisco DNA Center documentation for ITSM GetFailedITSMEventsV1
Complete reference of the GetFailedITSMEventsV1 API.
Examples
- name: Get all Itsm Integration Events Failed V1
cisco.catalystcenter.itsm_integration_events_failed_v1_info:
_host: "{{ _host }}"
_username: "{{ _username }}"
_password: "{{ _password }}"
_verify: "{{ _verify }}"
_api_port: "{{ _api_port }}"
_version: "{{ _version }}"
_debug: "{{ _debug }}"
headers: "{{my_headers | from_json}}"
instanceId: string
register: result
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always |