/ home / racampos / racampos.dnac / 0.0.1 / module / event_api_status

racampos.dnac.event_api_status (0.0.1) — module

Manage EventApiStatus objects of EventManagement

| "added in version" 1.0 of racampos.dnac"

Authors: first last (@GitHubID)

preview | supported by community

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install racampos.dnac:==0.0.1

Add to requirements.yml

  collections:
    - name: racampos.dnac
      version: 0.0.1

Description

Get the Status of events API calls with provided executionId as mandatory path parameter.

Requirements

dnacentersdk

Usage examples

Scanned by Steampunk Spotter

- name: get_status_api_for_events
  cisco.dnac.event_api_status:
    state: query  # required
    execution_id: SomeValue  # string, required
  register: query_result

Inputs

    
execution_id:
    description:
    - Execution ID.
    required: true
    type: str

Outputs

get_status_api_for_events:
  apiStatus:
    description: Api Status, property of the response body.
    returned: always
    sample: <apistatus>
    type: str
  contains: null
  description: Get the Status of events API calls with provided executionId as mandatory
    path parameter.
  errorMessage:
    description: Error Message, property of the response body.
    returned: always
    type: dict
  returned: always
  statusMessage:
    description: Status Message, property of the response body.
    returned: always
    sample: <statusmessage>
    type: str
  type: dict