cisco.dnac.custom_issue_definitions_v1 module – Resource module for Custom Issue Definitions V1
Note
This module is part of the cisco.dnac collection (version 6.27.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.custom_issue_definitions_v1.
New in cisco.dnac 6.15.0
Synopsis
Manage operations create, update and delete of the resource Custom Issue Definitions V1.
Create a new custom issue definition using the provided input request data. The unique identifier for this issue definition is id. Please note that the issue names cannot be duplicated. The definition is based on the syslog. 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- AssuranceUserDefinedIssueAPIs-1.0.0-resolved.yaml.
Deletes an existing custom issue definition based on the Id. Only the Global profile issue has the access to delete the issue definition, so no profile id is required. 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-AssuranceUserDefinedIssueAPIs-1.0.0-resolved.yaml.
Updates an existing custom issue definition based on the provided Id. 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- AssuranceUserDefinedIssueAPIs-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 |
|---|---|
Description. |
|
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 path parameter. The custom issue definition Identifier. |
|
Is Enabled. Choices:
|
|
Is Notification Enabled. Choices:
|
|
Name. |
|
Priority. |
|
Custom Issue Definitions’s rules. |
|
Duration In Minutes. |
|
Facility. |
|
Mnemonic. |
|
Occurrences. |
|
Pattern. |
|
Severity. |
|
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.creates_a_new_user_defined_issue_definitions_v1, issues.Issues.deletes_an_existing_custom_issue_definition_v1, issues.Issues.updates_an_existing_custom_issue_definition_based_on_the_provided_id_v1,
Paths used are post /dna/intent/api/v1/customIssueDefinitions, delete /dna/intent/api/v1/customIssueDefinitions/{id}, put /dna/intent/api/v1/customIssueDefinitions/{id},
Does not support
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 CreatesANewUserDefinedIssueDefinitionsV1
Complete reference of the CreatesANewUserDefinedIssueDefinitionsV1 API.
- Cisco DNA Center documentation for Issues DeletesAnExistingCustomIssueDefinitionV1
Complete reference of the DeletesAnExistingCustomIssueDefinitionV1 API.
- Cisco DNA Center documentation for Issues UpdatesAnExistingCustomIssueDefinitionBasedOnTheProvidedIdV1
Complete reference of the UpdatesAnExistingCustomIssueDefinitionBasedOnTheProvidedIdV1 API.
Examples
- name: Create
cisco.dnac.custom_issue_definitions_v1:
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}}"
state: present
description: string
headers: '{{my_headers | from_json}}'
isEnabled: true
isNotificationEnabled: true
name: string
priority: string
rules:
- durationInMinutes: 0
facility: string
mnemonic: string
occurrences: 0
pattern: string
severity: 0
- name: Update by id
cisco.dnac.custom_issue_definitions_v1:
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}}"
state: present
description: string
id: string
isEnabled: true
isNotificationEnabled: true
name: string
priority: string
rules:
- durationInMinutes: 0
facility: string
mnemonic: string
occurrences: 0
pattern: string
severity: 0
- name: Delete by id
cisco.dnac.custom_issue_definitions_v1:
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}}"
state: absent
id: string
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: |