cisco.dnac.system_issue_definitions_v1_info module – Information module for System Issue Definitions V1
Note
This module is part of the cisco.dnac collection (version 6.25.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install cisco.dnac.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.dnac.system_issue_definitions_v1_info.
New in cisco.dnac 6.15.0
Synopsis
Get all System Issue Definitions V1.
Get all system issue defintions. The supported filters are id, name, profileId and definition enable status. An issue trigger definition can be different across the profile and device type. So, `profileId` and `deviceType` in the query param is important and default is global profile and all device type. For detailed information about the usage of the API, please refer to the Open API specification document - https //github.com/cisco-en- programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org- issueAndHealthDefinitions-1.0.0-resolved.yaml.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.4.9
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
Attribute query parameter. These are the attributes supported in system issue definitions response. By default, all properties are sent in response. |
|
DeviceType query parameter. These are the device families/types supported for system issue definitions. If no input is made on device type, all device types are considered. |
|
Flag for Cisco DNA Center SDK to enable debugging. Choices:
|
|
The Cisco DNA Center hostname. |
|
The Cisco DNA Center password to authenticate. |
|
The Cisco DNA Center port. Default: |
|
The Cisco DNA Center username to authenticate. Default: |
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Cisco DNA Center to use. Default: |
|
Additional headers. |
|
Id query parameter. The definition identifier. Examples id=015d9cba-4f53-4087-8317-7e49e5ffef46 (single entity id request) id=015d9cba-4f53-4087-8317-7e49e5ffef46&id=015d9cba-4f53-4087-8317-7e49e5ffef47 (multiple ids in the query param). |
|
IssueEnabled query parameter. The enablement status of the issue definition, either true or false. Choices:
|
|
Limit query parameter. Maximum number of records to return. |
|
Name query parameter. The list of system defined issue names. (Ex.”BGP_Down”) Examples name=BGP_Down (single entity uuid requested) name=BGP_Down&name=BGP_Flap (multiple issue names separated by & operator). |
|
Offset query parameter. Specifies the starting point within all records returned by the API. It’s one based offset. The starting value is 1. |
|
Order query parameter. The sort order of the field ascending or descending. |
|
Priority query parameter. Issue priority, possible values are P1, P2, P3, P4. `P1` A critical issue that needs immediate attention and can have a wide impact on network operations. `P2` A major issue that can potentially impact multiple devices or clients. `P3` A minor issue that has a localized or minimal impact. `P4` A warning issue that may not be an immediate problem but addressing it can optimize the network performance. |
|
ProfileId query parameter. The profile identier to fetch the profile associated issue defintions. The default is `global`. Please refer Network design profiles documentation for more details. |
|
SortBy query parameter. A field within the response to sort by. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
Notes
Note
SDK Method used are issues.Issues.returns_all_issue_trigger_definitions_for_given_filters_v1,
Paths used are get /dna/intent/api/v1/systemIssueDefinitions,
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 DNAC SDK
The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection
See Also
See also
- Cisco DNA Center documentation for Issues ReturnsAllIssueTriggerDefinitionsForGivenFiltersV1
Complete reference of the ReturnsAllIssueTriggerDefinitionsForGivenFiltersV1 API.
Examples
- name: Get all System Issue Definitions V1
cisco.dnac.system_issue_definitions_v1_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}}"
deviceType: string
profileId: string
id: string
name: string
priority: string
issueEnabled: True
attribute: string
offset: 0
limit: 0
sortBy: string
order: 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 Sample: |