cisco.dnac.event_api_status_info – Information module for Event Api Status

Note

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

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

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

New in version 1.0.0: of cisco.dnac

Synopsis

  • Get Event Api Status by id.

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
executionId
string
ExecutionId path parameter. Execution ID.
headers
dictionary
Additional headers.

See Also

See also

Event Api Status reference

Complete reference of the Event Api Status object model.

Examples

- name: Get Event Api Status by id
  cisco.dnac.event_api_status_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
    executionId: 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
dictionary
always
A dictionary or list with the response returned by the Cisco DNAC Python SDK

Sample:
{ "errorMessage": {}, "apiStatus": "string", "statusMessage": "string" }


Authors

  • Rafael Campos (@racampos)