/ home / cisco / cisco.dnac / 6.13.3 / module / issues_info

cisco.dnac.issues_info (6.13.3) — module

Information module for Issues

| "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 Issues.

Intent API to get a list of global issues, issues for a specific device, or issue for a specific client device's MAC address.

Requirements

dnacentersdk >= 2.6.0
python >= 3.9

Usage examples

Scanned by Steampunk Spotter

- name: Get all Issues
  cisco.dnac.issues_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}}"
    startTime: 0
    endTime: 0
    siteId: string
    deviceId: string
    macAddress: string
    priority: string
    aiDriven: string
    issueStatus: string
  register: result

Inputs

    
siteId:
    description:
    - SiteId query parameter. Assurance UUID value of the site in the issue content.
    type: str

endTime:
    description:
    - EndTime query parameter. Ending epoch time in milliseconds of query time window.
    type: int

headers:
    description: Additional headers.
    type: dict

aiDriven:
    description:
    - 'AiDriven query parameter. The issue''s AI driven value (Yes or No)(Use only when
      macAddress and deviceId are not provided).

      '
    type: str

deviceId:
    description:
    - DeviceId query parameter. Assurance UUID value of the device in the issue content.
    type: str

priority:
    description:
    - 'Priority query parameter. The issue''s priority value (One of P1, P2, P3, or P4)(Use
      only when macAddress and deviceId are not provided).

      '
    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

startTime:
    description:
    - StartTime query parameter. Starting epoch time in milliseconds of query time window.
    type: int

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

macAddress:
    description:
    - MacAddress query parameter. Client's device MAC address of the issue (format xx
      xx xx xx xx xx).
    type: str

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

issueStatus:
    description:
    - IssueStatus query parameter. The issue's status value (One of ACTIVE, IGNORED, RESOLVED).
    type: str

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
  returned: always
  sample: "{\n  \"version\": \"string\",\n  \"totalCount\": 0,\n  \"response\": [\n\
    \    {\n      \"issueId\": \"string\",\n      \"name\": \"string\",\n      \"\
    siteId\": \"string\",\n      \"deviceId\": \"string\",\n      \"deviceRole\":\
    \ \"string\",\n      \"aiDriven\": true,\n      \"clientMac\": \"string\",\n \
    \     \"issue_occurence_count\": 0,\n      \"status\": \"string\",\n      \"priority\"\
    : \"string\",\n      \"category\": \"string\",\n      \"last_occurence_time\"\
    : 0\n    }\n  ]\n}\n"
  type: dict